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(HttpServletRequest request, HttpServletResponse response)
boolean	acceptWebSocket(WebSocketCreator creator, HttpServletRequest request, HttpServletResponse response)
WebSocketCreator	getCreator()
org.eclipse.jetty.websocket.api.extensions.ExtensionFactory	getExtensionFactory()
org.eclipse.jetty.websocket.api.WebSocketPolicy	getPolicy()	Get the base policy in use for WebSockets.
boolean	isUpgradeRequest(HttpServletRequest request, HttpServletResponse response)
void	register(Class<?> websocketPojo)	Register a websocket class pojo with the default WebSocketCreator.
void	setCreator(WebSocketCreator creator)
void	start()
void	stop()

Method Detail

acceptWebSocket

boolean acceptWebSocket(HttpServletRequest request,
                        HttpServletResponse response)
                 throws IOException

Throws:

IOException

acceptWebSocket

boolean acceptWebSocket(WebSocketCreator creator,
                        HttpServletRequest request,
                        HttpServletResponse response)
                 throws IOException

Throws:

IOException

start

void start()
    throws Exception

Throws:

Exception

stop

void stop()
   throws Exception

Throws:

Exception

getCreator

WebSocketCreator getCreator()

getExtensionFactory

org.eclipse.jetty.websocket.api.extensions.ExtensionFactory getExtensionFactory()

getPolicy

org.eclipse.jetty.websocket.api.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(HttpServletRequest request,
                         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)