Mojarra 2.4.0 · com.sun.faces.push.WebsocketSessionManager

Modifier and Type	Field and Description
private static volatile WebsocketSessionManager	instance
private static final CloseReason	REASON_EXPIRED
private static final AnnotationLiteral<WebsocketEvent.Closed>	SESSION_CLOSED
private static final AnnotationLiteral<WebsocketEvent.Opened>	SESSION_OPENED
private final ConcurrentMap<String, Collection<Session>>	socketSessions
private WebsocketUserManager	socketUsers

Access	Constructor and Description
public	WebsocketSessionManager()

Method Summary

Modifier and Type	Method and Description
protected boolean	Returns: `true` if given web socket session is accepted and is new, otherwise `false`. add(Session The opened web socket session. session) On open, add given web socket session to the mapping associated with its channel identifier and returns `true` if it's accepted (i.e. the channel identifier is known) and the same session hasn't been added before, otherwise `false`.
protected void	deregister(Iterable<String> The channel identifiers to deregister. channelIds) Deregister given channel identifiers and explicitly close all open web socket sessions associated with it.
private static void	fireEvent(Session session, CloseReason reason, AnnotationLiteral<?> qualifier)
private static String	getChannel(Session session)
private static String	getChannelId(Session session)
pack-priv static WebsocketSessionManager	getInstance() Internal usage only.
protected void	register(String The channel identifier to register. channelId) Register given channel identifier.
protected void	register(Iterable<String> The channel identifiers to register. channelIds) Register given channel identifiers.
protected void	remove(Session The closed web socket session. session, CloseReason The close reason. reason) On close, remove given web socket session from the mapping.
protected Set<Future<Void>>	Returns: The results of the send operation. If it returns an empty set, then there was no open session associated with given channel identifier. The returned futures will return `null` on `Future#get()` if the message was successfully delivered and otherwise throw `ExecutionException`. send(String The web socket channel identifier. channelId, Object The push message object. message) Encode the given message object as JSON and send it to all open web socket sessions associated with given web socket channel identifier.
private void	send(Session session, String text, Set<Future<Void>> results)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

instance	back to summary
private static volatile WebsocketSessionManager instance

REASON_EXPIRED	back to summary
private static final CloseReason REASON_EXPIRED

SESSION_CLOSED	back to summary
private static final AnnotationLiteral<WebsocketEvent.Closed> SESSION_CLOSED

SESSION_OPENED	back to summary
private static final AnnotationLiteral<WebsocketEvent.Opened> SESSION_OPENED

socketSessions	back to summary
private final ConcurrentMap<String, Collection<Session>> socketSessions

socketUsers	back to summary
private WebsocketUserManager socketUsers Annotations @Inject

WebsocketSessionManager	back to summary
public WebsocketSessionManager()

Method Detail

add back to summary

add	back to summary
protected boolean add(Session session) On open, add given web socket session to the mapping associated with its channel identifier and returns `true` if it's accepted (i.e. the channel identifier is known) and the same session hasn't been added before, otherwise `false`. Parameters session:Session The opened web socket session. Returns:boolean `true` if given web socket session is accepted and is new, otherwise `false`.

protected boolean add(Session session)

On open, add given web socket session to the mapping associated with its channel identifier and returns true if it's accepted (i.e. the channel identifier is known) and the same session hasn't been added before, otherwise false.

Parameters

session:Session: The opened web socket session.

Returns:boolean

true if given web socket session is accepted and is new, otherwise false.

deregister	back to summary
protected void deregister(Iterable<String> channelIds) Deregister given channel identifiers and explicitly close all open web socket sessions associated with it. Parameters channelIds:Iterable<String> The channel identifiers to deregister.

deregister

back to summary

protected void deregister(Iterable<String> channelIds)

Deregister given channel identifiers and explicitly close all open web socket sessions associated with it.

Parameters

channelIds:Iterable<String>: The channel identifiers to deregister.

fireEvent	back to summary
private static void fireEvent(Session session, CloseReason reason, AnnotationLiteral<?> qualifier)

getChannel	back to summary
private static String getChannel(Session session)

getChannelId	back to summary
private static String getChannelId(Session session)

getInstance	back to summary
pack-priv static WebsocketSessionManager getInstance() Internal usage only. Awkward workaround for it being unavailable via @Inject in endpoint in Tomcat+Weld/OWB.

register	back to summary
protected void register(String channelId) Register given channel identifier. Parameters channelId:String The channel identifier to register.

back to summary

protected void register(String channelId)

Parameters

channelId:String: The channel identifier to register.

register	back to summary
protected void register(Iterable<String> channelIds) Register given channel identifiers. Parameters channelIds:Iterable<String> The channel identifiers to register.

back to summary

protected void register(Iterable<String> channelIds)

Parameters

channelIds:Iterable<String>: The channel identifiers to register.

remove	back to summary
protected void remove(Session session, CloseReason reason) On close, remove given web socket session from the mapping. Parameters session:Session The closed web socket session. reason:CloseReason The close reason.

remove

back to summary

protected void remove(Session session, CloseReason reason)

On close, remove given web socket session from the mapping.

Parameters

session:Session: The closed web socket session.
reason:CloseReason: The close reason.

send back to summary

send	back to summary
protected Set<Future<Void>> send(String channelId, Object message) Encode the given message object as JSON and send it to all open web socket sessions associated with given web socket channel identifier. Parameters channelId:String The web socket channel identifier. 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 session associated with given channel identifier. The returned futures will return `null` on `Future#get()` if the message was successfully delivered and otherwise throw `ExecutionException`.

protected Set<Future<Void>> send(String channelId, Object message)

Encode the given message object as JSON and send it to all open web socket sessions associated with given web socket channel identifier.

Parameters

channelId:String: The web socket channel identifier.
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 session associated with given channel identifier. The returned futures will return null on Future#get() if the message was successfully delivered and otherwise throw ExecutionException.

send	back to summary
private void send(Session session, String text, Set<Future<Void>> results)

public Class WebsocketSessionManager

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail