Package org.atmosphere.websocket

Class DefaultWebSocketFactory

java.lang.Object

org.atmosphere.websocket.DefaultWebSocketFactory

All Implemented Interfaces:

WebSocketFactory

public class DefaultWebSocketFactory
extends Object
implements WebSocketFactory

Default WebSocketFactory implementation that retrieves WebSocket instances by looking up the associated AtmosphereResource via its UUID.

Constructor Summary

Constructors

Constructor	Description
DefaultWebSocketFactory()

Method Summary

Modifier and Type	Method	Description
WebSocket	find(String uuid)	Deprecated.
Optional<WebSocket>	findWebSocket(String uuid)	Retrieve the WebSocket associated with a uuid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultWebSocketFactory

public DefaultWebSocketFactory()

Method Details

find

@Deprecated
public WebSocket find(String uuid)

Deprecated.

Description copied from interface: WebSocketFactory

Retrieve the WebSocket associated with a uuid. The uuid could be the one returned by the AtmosphereResource.uuid() or an application generated one.

Specified by:

find in interface WebSocketFactory

Parameters:

uuid - a UUID associated

Returns:

WebSocket, or null if not found.

findWebSocket

public Optional<WebSocket> findWebSocket(String uuid)

Description copied from interface: WebSocketFactory

Retrieve the WebSocket associated with a uuid. The uuid could be the one returned by the AtmosphereResource.uuid() or an application generated one.

This is the preferred alternative to WebSocketFactory.find(String) as it returns an Optional instead of null, making the absent-websocket case explicit at the call site.

Specified by:

findWebSocket in interface WebSocketFactory

Parameters:

uuid - a UUID associated

Returns:

an Optional containing the WebSocket, or empty if not found.