org.eclipse.jetty.websocket.server

Class WebSocketUpgradeFilter

java.lang.Object

org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter

All Implemented Interfaces:

Filter, Dumpable, MappedWebSocketCreator

@ManagedObject(value="WebSocket Upgrade Filter")
public class WebSocketUpgradeFilter
extends Object
implements Filter, MappedWebSocketCreator, Dumpable

Inline Servlet Filter to capture WebSocket upgrade requests and perform path mappings to WebSocketCreator objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_KEY
static String	CONFIG_ATTRIBUTE_KEY
static String	CONTEXT_ATTRIBUTE_KEY

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor and Description
WebSocketUpgradeFilter()
WebSocketUpgradeFilter(NativeWebSocketConfiguration configuration)
WebSocketUpgradeFilter(WebSocketServerFactory factory)

Method Summary

Modifier and Type	Method and Description
void	addMapping(PathSpec spec, WebSocketCreator creator) Add a mapping.
void	addMapping(PathSpec spec, WebSocketCreator creator) Deprecated. use new addMapping(org.eclipse.jetty.http.pathmap.PathSpec, WebSocketCreator) instead
void	addMapping(String spec, WebSocketCreator creator) Add a mapping, of a pathspec to a WebSocketCreator.
static WebSocketUpgradeFilter	configure(ServletContextHandler context) Configure the default WebSocketUpgradeFilter.
static WebSocketUpgradeFilter	configureContext(ServletContext context) Deprecated. use configureContext(ServletContextHandler) instead
static WebSocketUpgradeFilter	configureContext(ServletContextHandler context) Deprecated. use configure(ServletContextHandler) instead
void	destroy()
void	doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
String	dump()
void	dump(Appendable out, String indent) Dump this object (and children) into an Appendable using the provided indent after any new lines.
NativeWebSocketConfiguration	getConfiguration()
WebSocketServletFactory	getFactory()
WebSocketCreator	getMapping(String target) /** Returns the creator for the given path spec.
void	init(FilterConfig config)
boolean	removeMapping(String spec) Removes the mapping based on the given path spec.
void	setToAttribute(ServletContext context, String key)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dump, dumpContainer, dumpIterable, dumpMapEntries, dumpObject, dumpObjects, dumpSelf, named

Field Detail

CONTEXT_ATTRIBUTE_KEY

public static final String CONTEXT_ATTRIBUTE_KEY

See Also:

Constant Field Values

CONFIG_ATTRIBUTE_KEY

public static final String CONFIG_ATTRIBUTE_KEY

See Also:

Constant Field Values

ATTR_KEY

public static final 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 provided ServletContextHandler, creating the filter if necessary.

The default WebSocketUpgradeFilter is also available via the ServletContext attribute named org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter

Parameters:

context - the ServletContextHandler 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. use configure(ServletContextHandler) instead

Parameters:

context - the ServletContextHandler 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. use configureContext(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 interface MappedWebSocketCreator

Parameters:

spec - the path spec to use

creator - the creator for the mapping

addMapping

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

Deprecated. use new addMapping(org.eclipse.jetty.http.pathmap.PathSpec, WebSocketCreator) instead

Description copied from interface: MappedWebSocketCreator

Add a mapping.

Specified by:

addMapping in interface MappedWebSocketCreator

Parameters:

spec - the path spec to use

creator - the creator for the mapping

addMapping

public void addMapping(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 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:

spec - the path spec to use.

creator - the websocket creator for this specific mapping

removeMapping

public boolean removeMapping(String spec)

Description copied from interface: MappedWebSocketCreator

Removes the mapping based on the given path spec.

Specified by:

removeMapping in interface MappedWebSocketCreator

Parameters:

spec - 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

destroy

public void destroy()

Specified by:

destroy in interface Filter

doFilter

public void doFilter(ServletRequest request,
                     ServletResponse response,
                     FilterChain chain)
              throws IOException,
                     ServletException

Specified by:

doFilter in interface Filter

Throws:

IOException

ServletException

dump

public String dump()

Specified by:

dump in interface Dumpable

dump

public void dump(Appendable out,
                 String indent)
          throws 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.

Specified by:

dump in interface Dumpable

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable

getFactory

public WebSocketServletFactory getFactory()

getConfiguration

@ManagedAttribute(value="configuration",
                  readonly=true)
public NativeWebSocketConfiguration getConfiguration()

getMapping

public WebSocketCreator getMapping(String target)

Description copied from interface: MappedWebSocketCreator

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

Specified by:

getMapping in interface MappedWebSocketCreator

Parameters:

target - 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

init

public void init(FilterConfig config)
          throws ServletException

Specified by:

init in interface Filter

Throws:

ServletException

setToAttribute

public void setToAttribute(ServletContext context,
                           String key)
                    throws ServletException

Throws:

ServletException

toString

public String toString()

Overrides:

toString in class Object