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

Thu, 31 Aug 2017 15:18:52 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:18:52 +0800
changeset 637
9c07ef4934dd
parent 368
0989ad8c0860
parent 0
373ffda63c9a
permissions
-rw-r--r--

merge

     1 /*
     2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Oracle designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Oracle in the LICENSE file that accompanied this code.
    10  *
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    14  * version 2 for more details (a copy is included in the LICENSE file that
    15  * accompanied this code).
    16  *
    17  * You should have received a copy of the GNU General Public License version
    18  * 2 along with this work; if not, write to the Free Software Foundation,
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    20  *
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    22  * or visit www.oracle.com if you need additional information or have any
    23  * questions.
    24  */
    26 package com.sun.xml.internal.ws.api;
    28 import com.sun.xml.internal.ws.api.server.Container;
    30 import java.net.MalformedURLException;
    31 import java.net.URL;
    33 /**
    34  * Used to locate resources for jax-ws extensions. Using this, extensions
    35  * do not to have to write container specific code to locate resources.
    36  *
    37  * @author Jitendra Kotamraju
    38  */
    39 public abstract class ResourceLoader {
    41     /**
    42      * Returns the actual location of the resource from the 'resource' arg
    43      * that represents a virtual locaion of a file understood by a container.
    44      * ResourceLoader impl for a Container knows how to map this
    45      * virtual location to actual location.
    46      * <p>
    47      * Extensions can get hold of this object using {@link Container}.
    48      * <p/>
    49      * for e.g.:
    50      * <pre>
    51      * ResourceLoader loader = container.getSPI(ResourceLoader.class);
    52      * URL catalog = loader.get("jax-ws-catalog.xml");
    53      * </pre>
    54      * A ResourceLoader for servlet environment, may do the following.
    55      * <pre>
    56      * URL getResource(String resource) {
    57      *     return servletContext.getResource("/WEB-INF/"+resource);
    58      * }
    59      * </pre>
    60      *
    61      * @param resource Designates a path that is understood by the container. The
    62      *             implementations must support "jax-ws-catalog.xml" resource.
    63      * @return the actual location, if found, or null if not found.
    64      * @throws MalformedURLException if there is an error in creating URL
    65      */
    66     public abstract URL getResource(String resource) throws MalformedURLException;
    68 }

mercurial