325N/A/*
325N/A * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage com.sun.xml.internal.ws.api.server;
325N/A
325N/A/**
325N/A * Root of the SPI implemented by the container
325N/A * (such as application server.)
325N/A *
325N/A * <p>
325N/A * Often technologies that are built on top of JAX-WS
325N/A * (such as Tango) needs to negotiate private contracts between
325N/A * them and the container. This interface allows such technologies
325N/A * to query the negotiated SPI by using the {@link #getSPI(Class)}.
325N/A *
325N/A * <p>
325N/A * For example, if a security pipe needs to get some information
325N/A * from a container, they can do the following:
325N/A * <ol>
325N/A * <li>Negotiate an interface with the container and define it.
325N/A * (let's call it <tt>ContainerSecuritySPI</tt>.)
325N/A * <li>The container will implement <tt>ContainerSecuritySPI</tt>.
325N/A * <li>At the runtime, a security pipe gets
325N/A * {@link WSEndpoint} and then to {@link Container}.
325N/A * <li>It calls <tt>container.getSPI(ContainerSecuritySPI.class)</tt>
325N/A * <li>The container returns an instance of <tt>ContainerSecuritySPI</tt>.
325N/A * <li>The security pipe talks to the container through this SPI.
325N/A * </ol>
325N/A *
325N/A * <p>
325N/A * This protects JAX-WS from worrying about the details of such contracts,
325N/A * while still providing the necessary service of hooking up those parties.
325N/A *
325N/A * <p>
325N/A * Technologies that run inside JAX-WS server runtime can access this object through
325N/A * {@link WSEndpoint#getContainer()}. In the client runtime, it can be accessed from
325N/A * {@link ContainerResolver#getContainer()}
325N/A *
325N/A * @author Kohsuke Kawaguchi
325N/A * @see WSEndpoint
325N/A */
325N/Apublic abstract class Container {
325N/A /**
325N/A * For derived classes.
325N/A */
325N/A protected Container() {
325N/A }
325N/A
325N/A /**
325N/A * Gets the specified SPI.
325N/A *
325N/A * <p>
325N/A * This method works as a kind of directory service
325N/A * for SPIs between technologies on top of JAX-WS
325N/A * and the container.
325N/A *
325N/A * @param spiType
325N/A * Always non-null.
325N/A *
325N/A * @return
325N/A * null if such an SPI is not implemented by this container.
325N/A */
325N/A public abstract <T> T getSPI(Class<T> spiType);
325N/A
325N/A
325N/A /**
325N/A * Constant that represents a "no {@link Container}",
325N/A * which always returns null from {@link #getSPI(Class)}.
325N/A */
325N/A public static final Container NONE = new Container() {
325N/A public <T> T getSPI(Class<T> spiType) {
325N/A return null;
325N/A }
325N/A };
325N/A}