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, MappedWebSocketCreator

public class NativeWebSocketConfiguration
extends ContainerLifeCycle
implements MappedWebSocketCreator, 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, WebSocketCreator) instead.
void	addMapping(String rawspec, Class<?> endpointClass) Manually add a WebSocket mapping.
void	addMapping(String rawspec, WebSocketCreator creator) Add a mapping, of a pathspec to a WebSocketCreator.
void	doStop()
String	dump()
void	dump(Appendable out, String indent)
WebSocketServerFactory	getFactory() Get WebSocketServerFactory being used.
WebSocketCreator	getMapping(String rawspec) /** Returns the creator for the given path spec.
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.
boolean	removeMapping(String rawspec) Removes the mapping based on the given path spec.

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.

Specified by:

addMapping in interface MappedWebSocketCreator

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, WebSocketCreator) instead.

Manually add a WebSocket mapping.

Specified by:

addMapping in interface MappedWebSocketCreator

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)

addMapping

public void addMapping(String rawspec,
                       WebSocketCreator creator)

Description copied from interface: MappedWebSocketCreator

Add a mapping, of a pathspec to a WebSocketCreator.

Recognized Path Spec syntaxes

/path/to or / or *.ext or servlet|{spec}

Servlet Syntax

^{spec} or regex|{spec}

Regex Syntax

uri-template|{spec}

URI Template (see JSR356 and RFC6570 level 1)

Specified by:

addMapping in interface MappedWebSocketCreator

Parameters:

rawspec - the path spec to use.

creator - the websocket creator for this specific mapping

getMapping

public WebSocketCreator getMapping(String rawspec)

Description copied from interface: MappedWebSocketCreator

/** Returns the creator for the given path spec.

Specified by:

getMapping in interface MappedWebSocketCreator

Parameters:

rawspec - @param spec the spec to test for (using the same spec syntax as seen in MappedWebSocketCreator.addMapping(String, WebSocketCreator))

Returns:

the websocket creator if path spec exists, or null

removeMapping

public boolean removeMapping(String rawspec)

Description copied from interface: MappedWebSocketCreator

Removes the mapping based on the given path spec.

Specified by:

removeMapping in interface MappedWebSocketCreator

Parameters:

rawspec - the path spec to remove (using the same spec syntax as seen in MappedWebSocketCreator.addMapping(String, WebSocketCreator))

Returns:

true if underlying mapping were altered, false otherwise

addMapping

public void addMapping(String rawspec,
                       Class<?> endpointClass)

Manually add a WebSocket mapping.

Parameters:

rawspec - the pathspec to map to (see MappedWebSocketCreator.addMapping(String, WebSocketCreator) for syntax details)

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