Package org.eclipse.jetty.websocket.servlet

Interface WebSocketServletFactory

All Known Implementing Classes:

WebSocketServerFactory

@Deprecated(since="2021-05-27")
public interface WebSocketServletFactory

Deprecated.

The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.

Basic WebSocketServletFactory for working with Jetty-based WebSocketServlets

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebSocketServletFactory.Loader	Deprecated.

Method Summary

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

Method Detail

acceptWebSocket

boolean acceptWebSocket(HttpServletRequest request,
                        HttpServletResponse response)
                 throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

acceptWebSocket

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

Deprecated.

Throws:

java.io.IOException

start

void start()
    throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

stop

void stop()
   throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getAvailableExtensionNames

java.util.Set<java.lang.String> getAvailableExtensionNames()

Deprecated.

Get the set of available Extensions by registered name.

Returns:

the set of available extensions by registered name.

getCreator

WebSocketCreator getCreator()

Deprecated.

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()

Deprecated.

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)

Deprecated.

register

void register(java.lang.Class<?> websocketPojo)

Deprecated.

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)

Deprecated.