jakarta.websocket

Class ContainerProvider

java.lang.Object

jakarta.websocket.ContainerProvider

Direct Known Subclasses:

GrizzlyContainerProvider

public abstract class ContainerProvider
extends java.lang.Object

Provider class that allows the developer to get a reference to the implementation of the WebSocketContainer. The provider class uses the ServiceLoader to load an implementation of ContainerProvider. Specifically, the fully qualified class name of the container implementation of ContainerProvider must be listed in the "META-INF/services/jakarta.websocket.ContainerProvider" file in the implementation JAR file.

Author:

dannycoward

Constructor Summary

Constructors

Constructor and Description
ContainerProvider()

Method Summary

Modifier and Type	Method and Description
protected abstract WebSocketContainer	getContainer() Create a new instance of the the WebSocket container implementation.
static WebSocketContainer	getWebSocketContainer() Obtain a new instance of a WebSocketContainer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerProvider

public ContainerProvider()

Method Detail

getWebSocketContainer

public static WebSocketContainer getWebSocketContainer()

Obtain a new instance of a WebSocketContainer. The method looks for the ContainerProvider implementation class in the order listed in the "META-INF/services/jakarta.websocket.ContainerProvider" file, returning the first WebSocketContainer implementation from the ContainerProvider implementation that is not null.

Returns:

an implementation provided instance of type WebSocketContainer

Throws:

java.util.ServiceConfigurationError - If there is a problem loading one of the discovered ContainerProvider implementations. A ServiceConfigurationError is viewed as a serious problem so the exception is allowed to propagate rather than swallowing the exception and attempting to load the next provider (if any).

getContainer

protected abstract WebSocketContainer getContainer()

Create a new instance of the the WebSocket container implementation.

Returns:

the new instance