Package com.sun.xml.ws.api.server

Class Container

java.lang.Object

com.sun.xml.ws.api.server.Container

All Implemented Interfaces:

Component, ComponentEx, ComponentRegistry

public abstract class Container
extends Object
implements ComponentRegistry, ComponentEx

Root of the SPI implemented by the container (such as application server.)

Often technologies that are built on top of JAX-WS (such as Tango) needs to negotiate private contracts between them and the container. This interface allows such technologies to query the negotiated SPI by using the getSPI(Class).

For example, if a security pipe needs to get some information from a container, they can do the following:

1. Negotiate an interface with the container and define it. (let's call it ContainerSecuritySPI.)
2. The container will implement ContainerSecuritySPI.
3. At the runtime, a security pipe gets WSEndpoint and then to Container.
4. It calls container.getSPI(ContainerSecuritySPI.class)
5. The container returns an instance of ContainerSecuritySPI.
6. The security pipe talks to the container through this SPI.

This protects JAX-WS from worrying about the details of such contracts, while still providing the necessary service of hooking up those parties.

Technologies that run inside JAX-WS server runtime can access this object through WSEndpoint.getContainer(). In the client runtime, it can be accessed from ContainerResolver.getContainer()

Author:

Kohsuke Kawaguchi

See Also:

WSEndpoint

Field Summary

Fields

Modifier and Type	Field	Description
static Container	NONE	Constant that represents a "no Container", which always returns null from getSPI(Class).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Container()	For derived classes.

Method Summary

Modifier and Type	Method	Description
Set<Component>	getComponents()	Returns the set of Components registered with this object
<E> Iterable<E>	getIterableSPI(Class<E> spiType)	Gets an iterator of implementations of the specified SPI.
<S> S	getSPI(Class<S> spiType)	Gets the specified SPI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final Container NONE

Constant that represents a "no Container", which always returns null from getSPI(Class).

Constructor Detail

Container

protected Container()

For derived classes.

Method Detail

getSPI

public <S> S getSPI(Class<S> spiType)

Description copied from interface: Component

Gets the specified SPI.

This method works as a kind of directory service for SPIs, allowing various components to define private contract and talk to each other.

Specified by:

getSPI in interface Component

Returns:

null if such an SPI is not provided by this object.

getComponents

public Set<Component> getComponents()

Description copied from interface: ComponentRegistry

Returns the set of Components registered with this object

Specified by:

getComponents in interface ComponentRegistry

Returns:

set of registered components

getIterableSPI

@NotNull
public <E> Iterable<E> getIterableSPI(Class<E> spiType)

Description copied from interface: ComponentEx

Gets an iterator of implementations of the specified SPI.

This method works as a kind of directory service for SPIs, allowing various components to define private contract and talk to each other. However unlike Component.getSPI(java.lang.Class), this method can support cases where there is an ordered collection (defined by Iterable of implementations. The SPI contract should define whether lookups are for the first appropriate implementation or whether all returned implementations should be used.

Specified by:

getIterableSPI in interface ComponentEx

Returns:

non-null Iterable of the SPI's provided by this object. Iterator may have no values.