org.eclipse.jetty.websocket.server

Class NativeWebSocketConfiguration

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.server.NativeWebSocketConfiguration

All Implemented Interfaces:

Container, Destroyable, Dumpable, LifeCycle

public class NativeWebSocketConfiguration
extends ContainerLifeCycle
implements Dumpable

Interface for Configuring Jetty Server Native WebSockets

Only applicable if using WebSocketUpgradeFilter

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
NativeWebSocketConfiguration(ServletContext context)
NativeWebSocketConfiguration(WebSocketServerFactory webSocketServerFactory)

Method Summary

Modifier and Type	Method and Description
void	addMapping(PathSpec pathSpec, Class<?> endpointClass) Manually add a WebSocket mapping.
void	addMapping(PathSpec pathSpec, WebSocketCreator creator) Manually add a WebSocket mapping.
void	addMapping(PathSpec spec, WebSocketCreator creator) Deprecated. use addMapping(PathSpec, Class) instead.
void	doStop()
String	dump()
void	dump(Appendable out, String indent)
WebSocketServerFactory	getFactory() Get WebSocketServerFactory being used.
MappedResource<WebSocketCreator>	getMatch(String target) Get the matching MappedResource for the provided target.
WebSocketPolicy	getPolicy() Used to configure the Default WebSocketPolicy used by all endpoints that don't redeclare the values.

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeWebSocketConfiguration

public NativeWebSocketConfiguration(ServletContext context)

NativeWebSocketConfiguration

public NativeWebSocketConfiguration(WebSocketServerFactory webSocketServerFactory)

Method Detail

doStop

public void doStop()
            throws Exception

Overrides:

doStop in class ContainerLifeCycle

Throws:

Exception

dump

public String dump()

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

dump

public void dump(Appendable out,
                 String indent)
          throws IOException

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Throws:

IOException

getFactory

public WebSocketServerFactory getFactory()

Get WebSocketServerFactory being used.

Returns:

the WebSocketServerFactory being used.

getMatch

public MappedResource<WebSocketCreator> getMatch(String target)

Get the matching MappedResource for the provided target.

Parameters:

target - the target path

Returns:

the matching resource, or null if no match.

getPolicy

public WebSocketPolicy getPolicy()

Used to configure the Default WebSocketPolicy used by all endpoints that don't redeclare the values.

Returns:

the default policy for all WebSockets

addMapping

public void addMapping(PathSpec pathSpec,
                       WebSocketCreator creator)

Manually add a WebSocket mapping.

If mapping is added before this configuration is started, then it is persisted through stop/start of this configuration's lifecycle. Otherwise it will be removed when this configuration is stopped.

Parameters:

pathSpec - the pathspec to respond on

creator - the websocket creator to activate on the provided mapping.

addMapping

@Deprecated
public void addMapping(PathSpec spec,
                                   WebSocketCreator creator)

Deprecated. use addMapping(PathSpec, Class) instead.

Manually add a WebSocket mapping.

Parameters:

spec - the pathspec to respond on

creator - the websocket creator to activate on the provided mapping

addMapping

public void addMapping(PathSpec pathSpec,
                       Class<?> endpointClass)

Manually add a WebSocket mapping.

Parameters:

pathSpec - the pathspec to respond on

endpointClass - the endpoint class to use for new upgrade requests on the provided pathspec (can be an WebSocket annotated POJO, or implementing WebSocketListener)