Package org.eclipse.jetty.websocket.servlet

Interface WebSocketServletFactory

public interface WebSocketServletFactory

Basic WebSocketServletFactory for working with Jetty-based WebSocketServlets

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebSocketServletFactory.Loader

Method Summary

Modifier and Type	Method	Description
boolean	acceptWebSocket(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
boolean	acceptWebSocket(WebSocketCreator creator, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Set<String>	getAvailableExtensionNames()	Get the set of available Extensions by registered name.
WebSocketCreator	getCreator()
ExtensionFactory	getExtensionFactory()	Deprecated. this class is removed from Jetty 10.0.0+.
WebSocketPolicy	getPolicy()	Get the base policy in use for WebSockets.
boolean	isUpgradeRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	register(Class<?> websocketPojo)	Register a websocket class pojo with the default WebSocketCreator.
void	setCreator(WebSocketCreator creator)
void	start()
void	stop()

Method Details

acceptWebSocket

boolean acceptWebSocket(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                 throws IOException

Throws:

IOException

acceptWebSocket

boolean acceptWebSocket(WebSocketCreator creator,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                 throws IOException

Throws:

IOException

start

void start()
    throws Exception

Throws:

Exception

stop

void stop()
   throws Exception

Throws:

Exception

getAvailableExtensionNames

Set<String> getAvailableExtensionNames()

Get the set of available Extensions by registered name.

Returns:

the set of available extensions by registered name.

getCreator

WebSocketCreator getCreator()

getExtensionFactory

@Deprecated
ExtensionFactory getExtensionFactory()

Deprecated.

this class is removed from Jetty 10.0.0+. To remove specific extensions from negotiation use WebSocketCreator to remove then during handshake.

Get the registered extensions for this WebSocket factory.

Returns:

the ExtensionFactory

See Also:

• getAvailableExtensionNames()

getPolicy

WebSocketPolicy getPolicy()

Get the base policy in use for WebSockets.

Note: individual WebSocket implementations can override some of the values in here by using the @WebSocket annotation.

Returns:

the base policy

isUpgradeRequest

boolean isUpgradeRequest(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)

register

void register(Class<?> websocketPojo)

Register a websocket class pojo with the default WebSocketCreator.

Note: only required if using the default WebSocketCreator provided by this factory.

Parameters:

websocketPojo - the class to instantiate for each incoming websocket upgrade request.

setCreator

void setCreator(WebSocketCreator creator)