Modifier and Type	Class and Description
private static enum	WebsocketChannelManager.Scope
public static class	WebsocketChannelManager.ViewScope This helps the web socket channel manager to hold view scoped web socket channel identifiers registered by `<f:websocket>`.

Modifier and Type	Field and Description
private static final ConcurrentMap<String, String>	APPLICATION_SCOPE
pack-priv static final Map<String, String>	EMPTY_SCOPE
private static final String	ERROR_DUPLICATE_CHANNEL
private static final String	ERROR_INVALID_SCOPE
private static final int	ESTIMATED_CHANNELS_PER_APPLICATION
private static final int	ESTIMATED_CHANNELS_PER_SESSION
private static final int	ESTIMATED_CHANNELS_PER_VIEW
pack-priv static final int	ESTIMATED_TOTAL_CHANNELS
private static final int	ESTIMATED_USERS_PER_SESSION
private static final long	serialVersionUID
private final ConcurrentMap<String, String>	sessionScope
private final ConcurrentMap<Serializable, String>	sessionUsers
private WebsocketSessionManager	socketSessions
private WebsocketUserManager	socketUsers

Access	Constructor and Description
public	WebsocketChannelManager()

Method Summary

Modifier and Type	Method and Description
protected void	deregisterSessionScope() When current session scope is about to be destroyed, deregister all session scope channels and explicitly close any open web sockets associated with it to avoid stale websockets.
pack-priv static String	getChannelId(String channel, Map<String, String> sessionScope, Map<String, String> viewScope) For internal usage only.
pack-priv static Map<String, String>	getSessionScope() For internal usage only.
pack-priv static Map<String, String>	getViewScope(boolean create) For internal usage only.
private void	readObject(ObjectInputStream input)
public String	Returns: The web socket URL. register(FacesContext The involved faces context. context, String The web socket channel. channel, String The web socket scope. Supported values are `application`, `session` and `view`, case insensitive. If `null`, the default is `application`. scope, Serializable The user object representing the owner of the given channel. If not `null`, then scope may not be `application`. user) Register given channel on given scope and returns the web socket channel identifier.
private String	register(FacesContext context, Serializable user, String channel, Map<String, String> targetScope, Map<String, String>... otherScopes)
private void	writeObject(ObjectOutputStream output)

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

Field Detail

APPLICATION_SCOPE	back to summary
private static final ConcurrentMap<String, String> APPLICATION_SCOPE

EMPTY_SCOPE	back to summary
pack-priv static final Map<String, String> EMPTY_SCOPE

ERROR_DUPLICATE_CHANNEL	back to summary
private static final String ERROR_DUPLICATE_CHANNEL

ERROR_INVALID_SCOPE	back to summary
private static final String ERROR_INVALID_SCOPE

ESTIMATED_CHANNELS_PER_APPLICATION	back to summary
private static final int ESTIMATED_CHANNELS_PER_APPLICATION

ESTIMATED_CHANNELS_PER_SESSION	back to summary
private static final int ESTIMATED_CHANNELS_PER_SESSION

ESTIMATED_CHANNELS_PER_VIEW	back to summary
private static final int ESTIMATED_CHANNELS_PER_VIEW

ESTIMATED_TOTAL_CHANNELS	back to summary
pack-priv static final int ESTIMATED_TOTAL_CHANNELS

ESTIMATED_USERS_PER_SESSION	back to summary
private static final int ESTIMATED_USERS_PER_SESSION

serialVersionUID	back to summary
private static final long serialVersionUID

sessionScope	back to summary
private final ConcurrentMap<String, String> sessionScope

sessionUsers	back to summary
private final ConcurrentMap<Serializable, String> sessionUsers

socketSessions	back to summary
private WebsocketSessionManager socketSessions Annotations @Inject

socketUsers	back to summary
private WebsocketUserManager socketUsers Annotations @Inject

Constructor Detail

WebsocketChannelManager	back to summary
public WebsocketChannelManager()

Method Detail

deregisterSessionScope	back to summary
protected void deregisterSessionScope() When current session scope is about to be destroyed, deregister all session scope channels and explicitly close any open web sockets associated with it to avoid stale websockets. If any, also deregister session users. Annotations @PreDestroy

deregisterSessionScope

back to summary

protected void deregisterSessionScope()

When current session scope is about to be destroyed, deregister all session scope channels and explicitly close any open web sockets associated with it to avoid stale websockets. If any, also deregister session users.

Annotations

@PreDestroy

getChannelId	back to summary
pack-priv static String getChannelId(String channel, Map<String, String> sessionScope, Map<String, String> viewScope) For internal usage only. This makes it possible to resolve the session and view scope channel ID during push send time in `WebsocketPushContext`.

getSessionScope	back to summary
pack-priv static Map<String, String> getSessionScope() For internal usage only. This makes it possible to remember session scope channel IDs during injection time of `WebsocketPushContext` (the CDI session scope is not necessarily active during push send time).

getViewScope	back to summary
pack-priv static Map<String, String> getViewScope(boolean create) For internal usage only. This makes it possible to remember view scope channel IDs during injection time of `WebsocketPushContext` (the CDI view scope is not necessarily active during push send time).

readObject	back to summary
private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException Annotations @SuppressWarnings:unchecked

register	back to summary
public String register(FacesContext context, String channel, String scope, Serializable user) Register given channel on given scope and returns the web socket channel identifier. Parameters context:FacesContext The involved faces context. channel:String The web socket channel. scope:String The web socket scope. Supported values are `application`, `session` and `view`, case insensitive. If `null`, the default is `application`. user:Serializable The user object representing the owner of the given channel. If not `null`, then scope may not be `application`. Returns:String The web socket URL. Annotations @SuppressWarnings:unchecked Exceptions IllegalArgumentException: When the scope is invalid or when channel already exists on a different scope.

public String register(FacesContext context, String channel, String scope, Serializable user)

Parameters

context:FacesContext: The involved faces context.
channel:String: The web socket channel.
scope:String: The web socket scope. Supported values are application, session and view, case insensitive. If null, the default is application.
user:Serializable: The user object representing the owner of the given channel. If not null, then scope may not be application.

Returns:String

The web socket URL.

Annotations

@SuppressWarnings:unchecked

Exceptions

IllegalArgumentException:: When the scope is invalid or when channel already exists on a different scope.

register	back to summary
private String register(FacesContext context, Serializable user, String channel, Map<String, String> targetScope, Map<String, String>... otherScopes) Annotations @SuppressWarnings:unchecked

writeObject	back to summary
private void writeObject(ObjectOutputStream output) throws IOException

com.sun.faces.push back to summary

private final Enum WebsocketChannelManager.Scope

Class Inheritance

extends Enum<WebsocketChannelManager.Scope>

java.lang.Object
java.lang.Enum
com.sun.faces.push.WebsocketChannelManager.Scope

Field Summary

Modifier and Type	Field and Description
public static final WebsocketChannelManager.Scope	APPLICATION
public static final WebsocketChannelManager.Scope	SESSION
public static final WebsocketChannelManager.Scope	VIEW

Constructor Summary

Access	Constructor and Description
private	Scope()

Method Summary

Modifier and Type	Method and Description
pack-priv static WebsocketChannelManager.Scope	of(String value, Serializable user)
public static WebsocketChannelManager.Scope	valueOf(String name)
public static WebsocketChannelManager.Scope[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

APPLICATION	back to summary
public static final WebsocketChannelManager.Scope APPLICATION

SESSION	back to summary
public static final WebsocketChannelManager.Scope SESSION

VIEW	back to summary
public static final WebsocketChannelManager.Scope VIEW

Constructor Detail

Scope	back to summary
private Scope()

Method Detail

of	back to summary
pack-priv static WebsocketChannelManager.Scope of(String value, Serializable user)

valueOf	back to summary
public static WebsocketChannelManager.Scope valueOf(String name)

values	back to summary
public static WebsocketChannelManager.Scope[] values()

com.sun.faces.push back to summary

public Class WebsocketChannelManager.ViewScope

Class Inheritance

extends Object
implements Serializable

java.lang.Object
com.sun.faces.push.WebsocketChannelManager.ViewScope

All Implemented Interfaces

java.io.Serializable

Annotations

@ViewScoped

This helps the web socket channel manager to hold view scoped web socket channel identifiers registered by <f:websocket>.

Author: Bauke Scholtz
Since: 2.3
See Also: WebsocketChannelManager

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID
private ConcurrentMap<String, String>	viewScope

Constructor Summary

Access	Constructor and Description
public	ViewScope()

Method Summary

Modifier and Type	Method and Description
protected void	deregisterViewScope() When current view scope is about to be destroyed, deregister all view scope channels and explicitly close any open web sockets associated with it to avoid stale websockets.

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

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID

viewScope	back to summary
private ConcurrentMap<String, String> viewScope

Constructor Detail

ViewScope	back to summary
public ViewScope()

Method Detail

deregisterViewScope	back to summary
protected void deregisterViewScope() When current view scope is about to be destroyed, deregister all view scope channels and explicitly close any open web sockets associated with it to avoid stale websockets. Annotations @PreDestroy

deregisterViewScope

back to summary

protected void deregisterViewScope()

When current view scope is about to be destroyed, deregister all view scope channels and explicitly close any open web sockets associated with it to avoid stale websockets.

Annotations

@PreDestroy

public Class WebsocketChannelManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum WebsocketChannelManager.Scope

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class WebsocketChannelManager.ViewScope

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail