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.server;
ohair@286: 
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: 
ohair@286: /**
ohair@286:  * This class determines an instance of {@link Container} for the runtime.
ohair@286:  * It applies for both server and client runtimes(for e.g in Servlet could
alanb@368:  * be accessing a Web Service).
ohair@286:  *
ohair@286:  * A client that is invoking a web service may be running in a
ohair@286:  * container(for e.g servlet). T
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * ContainerResolver uses a static field to keep the instance of the resolver object.
ohair@286:  * Typically appserver may set its custom container resolver using the static method
ohair@286:  * {@link #setInstance(ContainerResolver)}
ohair@286:  *
ohair@286:  * @author Jitendra Kotamraju
ohair@286:  */
ohair@286: public abstract class ContainerResolver {
ohair@286: 
alanb@368:     private static final ThreadLocalContainerResolver DEFAULT = new ThreadLocalContainerResolver();
ohair@286: 
alanb@368:     private static volatile ContainerResolver theResolver = DEFAULT;
ohair@286: 
ohair@286:     /**
ohair@286:      * Sets the custom container resolver which can be used to get client's
ohair@286:      * {@link Container}.
ohair@286:      *
ohair@286:      * @param resolver container resolver
ohair@286:      */
ohair@286:     public static void setInstance(ContainerResolver resolver) {
ohair@286:         if(resolver==null)
alanb@368:             resolver = DEFAULT;
ohair@286:         theResolver = resolver;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns the container resolver which can be used to get client's {@link Container}.
ohair@286:      *
ohair@286:      * @return container resolver instance
ohair@286:      */
ohair@286:     public static @NotNull ContainerResolver getInstance() {
ohair@286:         return theResolver;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns the default container resolver which can be used to get {@link Container}.
ohair@286:      *
ohair@286:      * @return default container resolver
ohair@286:      */
alanb@368:     public static ThreadLocalContainerResolver getDefault() {
alanb@368:         return DEFAULT;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns the {@link Container} context in which client is running.
ohair@286:      *
ohair@286:      * @return container instance for the client
ohair@286:      */
ohair@286:     public abstract @NotNull Container getContainer();
ohair@286: 
ohair@286: }