Class WebSocketUpgradeFilter
- java.lang.Object
-
- org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter
-
- All Implemented Interfaces:
Filter
,Dumpable
,MappedWebSocketCreator
@ManagedObject("WebSocket Upgrade Filter") public class WebSocketUpgradeFilter extends java.lang.Object implements Filter, MappedWebSocketCreator, Dumpable
Inline Servlet Filter to capture WebSocket upgrade requests and perform path mappings toWebSocketCreator
objects.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
Dumpable.DumpableContainer
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTR_KEY
static java.lang.String
CONFIG_ATTRIBUTE_KEY
static java.lang.String
CONTEXT_ATTRIBUTE_KEY
-
Constructor Summary
Constructors Constructor Description WebSocketUpgradeFilter()
WebSocketUpgradeFilter(NativeWebSocketConfiguration configuration)
WebSocketUpgradeFilter(WebSocketServerFactory factory)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addMapping(java.lang.String spec, WebSocketCreator creator)
Add a mapping, of a pathspec to a WebSocketCreator.void
addMapping(PathSpec spec, WebSocketCreator creator)
Add a mapping.void
addMapping(PathSpec spec, WebSocketCreator creator)
Deprecated.static WebSocketUpgradeFilter
configure(ServletContextHandler context)
Configure the default WebSocketUpgradeFilter.static WebSocketUpgradeFilter
configureContext(ServletContext context)
Deprecated.useconfigureContext(ServletContextHandler)
insteadstatic WebSocketUpgradeFilter
configureContext(ServletContextHandler context)
Deprecated.useconfigure(ServletContextHandler)
insteadvoid
destroy()
void
doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
java.lang.String
dump()
void
dump(java.lang.Appendable out, java.lang.String indent)
Dump this object (and children) into an Appendable using the provided indent after any new lines.NativeWebSocketConfiguration
getConfiguration()
WebSocketServletFactory
getFactory()
WebSocketCreator
getMapping(java.lang.String target)
/** Returns the creator for the given path spec.void
init(FilterConfig config)
boolean
removeMapping(java.lang.String spec)
Removes the mapping based on the given path spec.void
setToAttribute(ServletContext context, java.lang.String key)
java.lang.String
toString()
-
-
-
Field Detail
-
CONTEXT_ATTRIBUTE_KEY
public static final java.lang.String CONTEXT_ATTRIBUTE_KEY
- See Also:
- Constant Field Values
-
CONFIG_ATTRIBUTE_KEY
public static final java.lang.String CONFIG_ATTRIBUTE_KEY
- See Also:
- Constant Field Values
-
ATTR_KEY
public static final java.lang.String ATTR_KEY
-
-
Constructor Detail
-
WebSocketUpgradeFilter
public WebSocketUpgradeFilter()
-
WebSocketUpgradeFilter
public WebSocketUpgradeFilter(WebSocketServerFactory factory)
-
WebSocketUpgradeFilter
public WebSocketUpgradeFilter(NativeWebSocketConfiguration configuration)
-
-
Method Detail
-
configure
public static WebSocketUpgradeFilter configure(ServletContextHandler context) throws ServletException
Configure the default WebSocketUpgradeFilter.This will return the default
WebSocketUpgradeFilter
on the providedServletContextHandler
, creating the filter if necessary.The default
WebSocketUpgradeFilter
is also available via theServletContext
attribute namedorg.eclipse.jetty.websocket.server.WebSocketUpgradeFilter
- Parameters:
context
- theServletContextHandler
to use- Returns:
- the configured default
WebSocketUpgradeFilter
instance - Throws:
ServletException
- if the filer cannot be configured
-
configureContext
@Deprecated public static WebSocketUpgradeFilter configureContext(ServletContextHandler context) throws ServletException
Deprecated.useconfigure(ServletContextHandler)
instead- Parameters:
context
- theServletContextHandler
to use- Returns:
- a configured
WebSocketUpgradeFilter
instance - Throws:
ServletException
- if the filer cannot be configured
-
configureContext
@Deprecated public static WebSocketUpgradeFilter configureContext(ServletContext context) throws ServletException
Deprecated.useconfigureContext(ServletContextHandler)
instead- Parameters:
context
- the ServletContext to use- Returns:
- a configured
WebSocketUpgradeFilter
instance - Throws:
ServletException
- if the filer cannot be configured
-
addMapping
public void addMapping(PathSpec spec, WebSocketCreator creator)
Description copied from interface:MappedWebSocketCreator
Add a mapping.- Specified by:
addMapping
in interfaceMappedWebSocketCreator
- Parameters:
spec
- the path spec to usecreator
- the creator for the mapping
-
addMapping
@Deprecated public void addMapping(PathSpec spec, WebSocketCreator creator)
Deprecated.Description copied from interface:MappedWebSocketCreator
Add a mapping.- Specified by:
addMapping
in interfaceMappedWebSocketCreator
- Parameters:
spec
- the path spec to usecreator
- the creator for the mapping
-
addMapping
public void addMapping(java.lang.String spec, 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
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:
spec
- the path spec to use.creator
- the websocket creator for this specific mapping
-
removeMapping
public boolean removeMapping(java.lang.String spec)
Description copied from interface:MappedWebSocketCreator
Removes the mapping based on the given path spec.- Specified by:
removeMapping
in interfaceMappedWebSocketCreator
- Parameters:
spec
- 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
-
doFilter
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException
- Specified by:
doFilter
in interfaceFilter
- Throws:
java.io.IOException
ServletException
-
dump
public void dump(java.lang.Appendable out, java.lang.String indent) throws java.io.IOException
Description copied from interface:Dumpable
Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.
-
getFactory
public WebSocketServletFactory getFactory()
-
getConfiguration
@ManagedAttribute(value="configuration", readonly=true) public NativeWebSocketConfiguration getConfiguration()
-
getMapping
public WebSocketCreator getMapping(java.lang.String target)
Description copied from interface:MappedWebSocketCreator
/** Returns the creator for the given path spec.- Specified by:
getMapping
in interfaceMappedWebSocketCreator
- Parameters:
target
- 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
-
init
public void init(FilterConfig config) throws ServletException
- Specified by:
init
in interfaceFilter
- Throws:
ServletException
-
setToAttribute
public void setToAttribute(ServletContext context, java.lang.String key) throws ServletException
- Throws:
ServletException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-