Jakarta EE 11.0.0 · jakarta.faces.push.PushContext · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final String	ENABLE_WEBSOCKET_ENDPOINT_PARAM_NAME The boolean context parameter name to explicitly enable web socket endpoint during startup.
public static final String	URI_PREFIX The context-relative web socket URI prefix where the endpoint should listen on.
public static final String	WEBSOCKET_ENDPOINT_PORT_PARAM_NAME The integer context parameter name to specify the websocket endpoint port when it's different from HTTP port.

Method Summary

Modifier and Type	Method and Description
public Set<Future<Void>>	Returns: The results of the send operation. If it returns an empty set, then there was no open web socket session associated with given socket channel. The returned futures will return `null` on `Future#get()` if the message was successfully delivered and otherwise throw `ExecutionException`. send(Object The push message object. message) Send given message object to the push socket channel as identified by `@Push`.
public < The generic type of the user identifier. S extends Serializable> Set<Future<Void>>	Returns: The results of the send operation. If it returns an empty set, then there was no open web socket session associated with given socket channel and user. The returned futures will return `null` on `Future#get()` if the message was successfully delivered and otherwise throw `ExecutionException`. send(Object The push message object. message, S The user to which the push message object must be delivered to. user) Send given message object to the push socket channel as identified by `@Push`, targeted to the given user as identified by `<f:websocket user>`.
public < The generic type of the user identifier. S extends Serializable> Map<S, Set<Future<Void>>>	Returns: The results of the send operation grouped by user. If it contains an empty set, then there was no open web socket session associated with given socket channel and user. The returned futures will return `null` on `Future#get()` if the message was successfully delivered and otherwise throw `ExecutionException`. send(Object The push message object. message, Collection<S> The users to which the push message object must be delivered to. users) Send given message object to the push socket channel as identified by `@Push`, targeted to the given users as identified by `<f:websocket user>`.

ENABLE_WEBSOCKET_ENDPOINT_PARAM_NAME	back to summary
public static final String ENABLE_WEBSOCKET_ENDPOINT_PARAM_NAME The boolean context parameter name to explicitly enable web socket endpoint during startup.

URI_PREFIX	back to summary
public static final String URI_PREFIX The context-relative web socket URI prefix where the endpoint should listen on.

WEBSOCKET_ENDPOINT_PORT_PARAM_NAME	back to summary
public static final String WEBSOCKET_ENDPOINT_PORT_PARAM_NAME The integer context parameter name to specify the websocket endpoint port when it's different from HTTP port.

Method Detail

send back to summary

send	back to summary
public Set<Future<Void>> send(Object message) Send given message object to the push socket channel as identified by `@Push`. The message object will be encoded as JSON and be available as first argument of the JavaScript listener function declared in `<f:websocket onmessage>`. Parameters message:Object The push message object. Returns:Set<Future<Void>> The results of the send operation. If it returns an empty set, then there was no open web socket session associated with given socket channel. The returned futures will return `null` on `Future#get()` if the message was successfully delivered and otherwise throw `ExecutionException`. Exceptions IllegalArgumentException: If given message object cannot be encoded as JSON. See Also `Async#sendText(String)`

public Set<Future<Void>> send(Object message)

Send given message object to the push socket channel as identified by @Push. The message object will be encoded as JSON and be available as first argument of the JavaScript listener function declared in <f:websocket onmessage>.

Parameters

message:Object: The push message object.

Returns:Set<Future<Void>>

The results of the send operation. If it returns an empty set, then there was no open web socket session associated with given socket channel. The returned futures will return null on Future#get() if the message was successfully delivered and otherwise throw ExecutionException.

Exceptions

IllegalArgumentException:: If given message object cannot be encoded as JSON.

See Also

Async#sendText(String)

send back to summary

send	back to summary
public <S extends Serializable> Set<Future<Void>> send(Object message, S user) Send given message object to the push socket channel as identified by `@Push`, targeted to the given user as identified by `<f:websocket user>`. The message object will be encoded as JSON and be available as first argument of the JavaScript listener function declared in `<f:websocket onmessage>`. Parameters <S> The generic type of the user identifier. message:Object The push message object. user:S The user to which the push message object must be delivered to. Returns:Set<Future<Void>> The results of the send operation. If it returns an empty set, then there was no open web socket session associated with given socket channel and user. The returned futures will return `null` on `Future#get()` if the message was successfully delivered and otherwise throw `ExecutionException`. Exceptions IllegalArgumentException: If given message object cannot be encoded as JSON. See Also `Async#sendText(String)`

public <S extends Serializable> Set<Future<Void>> send(Object message, S user)

Send given message object to the push socket channel as identified by @Push, targeted to the given user as identified by <f:websocket user>. The message object will be encoded as JSON and be available as first argument of the JavaScript listener function declared in <f:websocket onmessage>.

Parameters

<S>: The generic type of the user identifier.
message:Object: The push message object.
user:S: The user to which the push message object must be delivered to.

Returns:Set<Future<Void>>

The results of the send operation. If it returns an empty set, then there was no open web socket session associated with given socket channel and user. The returned futures will return null on Future#get() if the message was successfully delivered and otherwise throw ExecutionException.

Exceptions

IllegalArgumentException:: If given message object cannot be encoded as JSON.

See Also

Async#sendText(String)

send back to summary

send	back to summary
public <S extends Serializable> Map<S, Set<Future<Void>>> send(Object message, Collection<S> users) Send given message object to the push socket channel as identified by `@Push`, targeted to the given users as identified by `<f:websocket user>`. The message object will be encoded as JSON and be available as first argument of the JavaScript listener function declared in `<f:websocket onmessage>`. Parameters <S> The generic type of the user identifier. message:Object The push message object. users:Collection<S> The users to which the push message object must be delivered to. Returns:Map<S, Set<Future<Void>>> The results of the send operation grouped by user. If it contains an empty set, then there was no open web socket session associated with given socket channel and user. The returned futures will return `null` on `Future#get()` if the message was successfully delivered and otherwise throw `ExecutionException`. Exceptions IllegalArgumentException: If given message object cannot be encoded as JSON. See Also `Async#sendText(String)`

public <S extends Serializable> Map<S, Set<Future<Void>>> send(Object message, Collection<S> users)

Send given message object to the push socket channel as identified by @Push, targeted to the given users as identified by <f:websocket user>. The message object will be encoded as JSON and be available as first argument of the JavaScript listener function declared in <f:websocket onmessage>.

Parameters

<S>: The generic type of the user identifier.
message:Object: The push message object.
users:Collection<S>: The users to which the push message object must be delivered to.

Returns:Map<S, Set<Future<Void>>>

The results of the send operation grouped by user. If it contains an empty set, then there was no open web socket session associated with given socket channel and user. The returned futures will return null on Future#get() if the message was successfully delivered and otherwise throw ExecutionException.

Exceptions

IllegalArgumentException:: If given message object cannot be encoded as JSON.

See Also

Async#sendText(String)

public Interface PushContext

Field Summary

Method Summary

Field Detail

Method Detail