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:
org.eclipse.jetty.util.component.Container
,org.eclipse.jetty.util.component.Destroyable
,org.eclipse.jetty.util.component.Dumpable
,org.eclipse.jetty.util.component.Dumpable.DumpableContainer
,org.eclipse.jetty.util.component.LifeCycle
,MappedWebSocketCreator
public class NativeWebSocketConfiguration
extends org.eclipse.jetty.util.component.ContainerLifeCycle
implements MappedWebSocketCreator
Interface for Configuring Jetty Server Native WebSockets
Only applicable if using WebSocketUpgradeFilter
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container
org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
org.eclipse.jetty.util.component.Dumpable.DumpableContainer
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
org.eclipse.jetty.util.component.LifeCycle.Listener
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final WebSocketServerFactory
private final org.eclipse.jetty.http.pathmap.PathMappings
<WebSocketCreator> Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING
Fields inherited from interface org.eclipse.jetty.util.component.Dumpable
KEY
-
Constructor Summary
ConstructorsConstructorDescriptionNativeWebSocketConfiguration
(javax.servlet.ServletContext context) NativeWebSocketConfiguration
(WebSocketServerFactory webSocketServerFactory) -
Method Summary
Modifier and TypeMethodDescriptionvoid
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
addMapping
(org.eclipse.jetty.http.pathmap.PathSpec pathSpec, Class<?> endpointClass) Manually add a WebSocket mapping.void
addMapping
(org.eclipse.jetty.http.pathmap.PathSpec pathSpec, WebSocketCreator creator) Manually add a WebSocket mapping.void
addMapping
(PathSpec spec, WebSocketCreator creator) Deprecated.void
doStop()
Get WebSocketServerFactory being used.getMapping
(String rawspec) /** Returns the creator for the given path spec.org.eclipse.jetty.http.pathmap.MappedResource
<WebSocketCreator> Deprecated.usegetMatched(String)
instead.org.eclipse.jetty.http.pathmap.MatchedResource
<WebSocketCreator> getMatched
(String target) Get the matchingMatchedResource
for the provided target.Used to configure the DefaultWebSocketPolicy
used by all endpoints that don't redeclare the values.boolean
removeMapping
(String rawspec) Removes the mapping based on the given path spec.private org.eclipse.jetty.http.pathmap.PathSpec
toPathSpec
(String rawspec) Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle
addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, 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, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.jetty.util.component.Dumpable
dumpSelf
Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer
isDumpable
-
Field Details
-
factory
-
mappings
-
-
Constructor Details
-
NativeWebSocketConfiguration
public NativeWebSocketConfiguration(javax.servlet.ServletContext context) -
NativeWebSocketConfiguration
-
-
Method Details
-
doStop
- Overrides:
doStop
in classorg.eclipse.jetty.util.component.ContainerLifeCycle
- Throws:
Exception
-
getFactory
Get WebSocketServerFactory being used.- Returns:
- the WebSocketServerFactory being used.
-
getMatched
Get the matchingMatchedResource
for the provided target.- Parameters:
target
- the target path- Returns:
- the matching resource, or null if no match.
-
getMatch
@Deprecated public org.eclipse.jetty.http.pathmap.MappedResource<WebSocketCreator> getMatch(String target) Deprecated.usegetMatched(String)
instead.Get the matchingMappedResource
for the provided target.- Parameters:
target
- the target path- Returns:
- the matching resource, or null if no match.
-
getPolicy
Used to configure the DefaultWebSocketPolicy
used by all endpoints that don't redeclare the values.- Returns:
- the default policy for all WebSockets
-
addMapping
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 interfaceMappedWebSocketCreator
- Parameters:
pathSpec
- the pathspec to respond oncreator
- the websocket creator to activate on the provided mapping.
-
addMapping
Deprecated.useaddMapping(PathSpec, WebSocketCreator)
instead.Manually add a WebSocket mapping.- Specified by:
addMapping
in interfaceMappedWebSocketCreator
- Parameters:
spec
- the pathspec to respond oncreator
- the websocket creator to activate on the provided mapping
-
addMapping
Manually add a WebSocket mapping.- Parameters:
pathSpec
- the pathspec to respond onendpointClass
- the endpoint class to use for new upgrade requests on the provided pathspec (can be anWebSocket
annotated POJO, or implementingWebSocketListener
)
-
addMapping
Description copied from interface:MappedWebSocketCreator
Add a mapping, of a pathspec to a WebSocketCreator.Recognized Path Spec syntaxes
/path/to
or/
or*.ext
orservlet|{spec}
- Servlet Syntax
^{spec}
orregex|{spec}
- Regex Syntax
uri-template|{spec}
- URI Template (see JSR356 and RFC6570 level 1)
- Specified by:
addMapping
in interfaceMappedWebSocketCreator
- Parameters:
rawspec
- the path spec to use.creator
- the websocket creator for this specific mapping
-
toPathSpec
-
getMapping
Description copied from interface:MappedWebSocketCreator
/** Returns the creator for the given path spec.- Specified by:
getMapping
in interfaceMappedWebSocketCreator
- Parameters:
rawspec
- the spec to test for (using the same spec syntax as seen inMappedWebSocketCreator.addMapping(String, WebSocketCreator)
)- Returns:
- the websocket creator if path spec exists, or null
-
removeMapping
Description copied from interface:MappedWebSocketCreator
Removes the mapping based on the given path spec.- Specified by:
removeMapping
in interfaceMappedWebSocketCreator
- Parameters:
rawspec
- the path spec to remove (using the same spec syntax as seen inMappedWebSocketCreator.addMapping(String, WebSocketCreator)
)- Returns:
- true if underlying mapping were altered, false otherwise
-
addMapping
Manually add a WebSocket mapping.- Parameters:
rawspec
- the pathspec to map to (seeMappedWebSocketCreator.addMapping(String, WebSocketCreator)
for syntax details)endpointClass
- the endpoint class to use for new upgrade requests on the provided pathspec (can be anWebSocket
annotated POJO, or implementingWebSocketListener
)
-
addMapping(PathSpec, WebSocketCreator)
instead.