org.eclipse.jetty.websocket.servlet

Interface WebSocketServletFactory

All Known Implementing Classes:

WebSocketServerFactory

public interface WebSocketServletFactory

Basic WebSocketServletFactory for working with Jetty-based WebSocketServlets

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebSocketServletFactory.Loader

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptWebSocket(HttpServletRequest request, HttpServletResponse response)
boolean	acceptWebSocket(WebSocketCreator creator, HttpServletRequest request, HttpServletResponse response)
void	cleanup()
WebSocketServletFactory	createFactory(WebSocketPolicy policy)
WebSocketCreator	getCreator()
ExtensionFactory	getExtensionFactory()
WebSocketPolicy	getPolicy() Get the base policy in use for WebSockets.
void	init()
boolean	isUpgradeRequest(HttpServletRequest request, HttpServletResponse response)
void	register(Class<?> websocketPojo) Register a websocket class pojo with the default WebSocketCreator.
void	setCreator(WebSocketCreator creator)

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

cleanup

void cleanup()

createFactory

WebSocketServletFactory createFactory(WebSocketPolicy policy)

getCreator

WebSocketCreator getCreator()

getExtensionFactory

ExtensionFactory getExtensionFactory()

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

init

void init()
          throws Exception

Throws:

Exception

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)