Package org.atmosphere.websocket

Interface WebSocketFactory

All Known Implementing Classes:

DefaultWebSocketFactory

public interface WebSocketFactory

A factory for retrieving WebSocket

Method Summary

Modifier and Type	Method	Description
WebSocket	find(String uuid)	Deprecated. Use findWebSocket(String) which returns Optional instead of null.
default Optional<WebSocket>	findWebSocket(String uuid)	Retrieve the WebSocket associated with a uuid.

Method Details

find

@Deprecated(since="4.0.0",
            forRemoval=false)
WebSocket find(String uuid)

Deprecated.

Use findWebSocket(String) which returns Optional instead of null.

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

Parameters:

uuid - a UUID associated

Returns:

WebSocket, or null if not found.

findWebSocket

default Optional<WebSocket> findWebSocket(String uuid)

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 find(String) as it returns an Optional instead of null, making the absent-websocket case explicit at the call site.

Parameters:

uuid - a UUID associated

Returns:

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