src/share/jaxws_classes/com/sun/xml/internal/ws/api/ResourceLoader.java

changeset 0
373ffda63c9a
child 637
9c07ef4934dd
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/api/ResourceLoader.java	Wed Apr 27 01:27:09 2016 +0800
     1.3 @@ -0,0 +1,68 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.ws.api;
    1.30 +
    1.31 +import com.sun.xml.internal.ws.api.server.Container;
    1.32 +
    1.33 +import java.net.MalformedURLException;
    1.34 +import java.net.URL;
    1.35 +
    1.36 +/**
    1.37 + * Used to locate resources for jax-ws extensions. Using this, extensions
    1.38 + * do not to have to write container specific code to locate resources.
    1.39 + *
    1.40 + * @author Jitendra Kotamraju
    1.41 + */
    1.42 +public abstract class ResourceLoader {
    1.43 +
    1.44 +    /**
    1.45 +     * Returns the actual location of the resource from the 'resource' arg
    1.46 +     * that represents a virtual locaion of a file understood by a container.
    1.47 +     * ResourceLoader impl for a Container knows how to map this
    1.48 +     * virtual location to actual location.
    1.49 +     * <p>
    1.50 +     * Extensions can get hold of this object using {@link Container}.
    1.51 +     * <p/>
    1.52 +     * for e.g.:
    1.53 +     * <pre>
    1.54 +     * ResourceLoader loader = container.getSPI(ResourceLoader.class);
    1.55 +     * URL catalog = loader.get("jax-ws-catalog.xml");
    1.56 +     * </pre>
    1.57 +     * A ResourceLoader for servlet environment, may do the following.
    1.58 +     * <pre>
    1.59 +     * URL getResource(String resource) {
    1.60 +     *     return servletContext.getResource("/WEB-INF/"+resource);
    1.61 +     * }
    1.62 +     * </pre>
    1.63 +     *
    1.64 +     * @param resource Designates a path that is understood by the container. The
    1.65 +     *             implementations must support "jax-ws-catalog.xml" resource.
    1.66 +     * @return the actual location, if found, or null if not found.
    1.67 +     * @throws MalformedURLException if there is an error in creating URL
    1.68 +     */
    1.69 +    public abstract URL getResource(String resource) throws MalformedURLException;
    1.70 +
    1.71 +}

mercurial