ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.api;
ohair@286: 
ohair@286: import com.sun.xml.internal.ws.api.server.Container;
ohair@286: 
ohair@286: import java.net.MalformedURLException;
ohair@286: import java.net.URL;
ohair@286: 
ohair@286: /**
ohair@286:  * Used to locate resources for jax-ws extensions. Using this, extensions
ohair@286:  * do not to have to write container specific code to locate resources.
ohair@286:  *
ohair@286:  * @author Jitendra Kotamraju
ohair@286:  */
ohair@286: public abstract class ResourceLoader {
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns the actual location of the resource from the 'resource' arg
ohair@286:      * that represents a virtual locaion of a file understood by a container.
ohair@286:      * ResourceLoader impl for a Container knows how to map this
ohair@286:      * virtual location to actual location.
ohair@286:      * <p>
ohair@286:      * Extensions can get hold of this object using {@link Container}.
ohair@286:      * <p/>
ohair@286:      * for e.g.:
ohair@286:      * <pre>
ohair@286:      * ResourceLoader loader = container.getSPI(ResourceLoader.class);
ohair@286:      * URL catalog = loader.get("jax-ws-catalog.xml");
ohair@286:      * </pre>
ohair@286:      * A ResourceLoader for servlet environment, may do the following.
ohair@286:      * <pre>
ohair@286:      * URL getResource(String resource) {
ohair@286:      *     return servletContext.getResource("/WEB-INF/"+resource);
ohair@286:      * }
ohair@286:      * </pre>
ohair@286:      *
ohair@286:      * @param resource Designates a path that is understood by the container. The
ohair@286:      *             implementations must support "jax-ws-catalog.xml" resource.
ohair@286:      * @return the actual location, if found, or null if not found.
ohair@286:      * @throws MalformedURLException if there is an error in creating URL
ohair@286:      */
ohair@286:     public abstract URL getResource(String resource) throws MalformedURLException;
ohair@286: 
ohair@286: }