Jakarta EE 11.0.0 · jakarta.faces.component.UIWebsocket

Modifier and Type	Class and Description
pack-priv static enum	UIWebsocket.PropertyKeys Properties that are tracked by state saving.

Modifier and Type	Field and Description
public static final String	COMPONENT_FAMILY The standard component family for this component.
public static final String	COMPONENT_TYPE The standard component type for this component.
private static final Collection<String>	CONTAINS_EVERYTHING
private static final String	ERROR_ENDPOINT_NOT_ENABLED
private static final String	ERROR_INVALID_CHANNEL
private static final String	ERROR_INVALID_USER
private static final Pattern	PATTERN_CHANNEL_NAME

Access	Constructor and Description
public	UIWebsocket() Create a new `UIWebsocket` instance with default property values.

Method Summary

Modifier and Type	Method and Description
public String	Returns: The name of the websocket channel. getChannel() Returns the name of the websocket channel.
public Collection<String>	getEventNames() Overrides jakarta.faces.component.UIComponentBase.getEventNames. Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames. Returns a non-null, empty, unmodifiable `Collection` which returns `true` on any `Collection#contains()` invocation, indicating that all client behavior event names are acceptable.
public String	getFamily() Implements abstract jakarta.faces.component.UIComponent.getFamily. Returns `UIWebsocket#COMPONENT_FAMILY`.
public String	Returns: The JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect. getOnclose() Returns the JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect.
public String	Returns: The JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect. getOnerror() Returns the JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect.
public String	Returns: The JavaScript event handler function that is invoked when a push message is received from the server. getOnmessage() Returns the JavaScript event handler function that is invoked when a push message is received from the server.
public String	Returns: The JavaScript event handler function that is invoked when the websocket is opened. getOnopen() Returns the JavaScript event handler function that is invoked when the websocket is opened.
public String	Returns: The scope of the websocket channel. getScope() Returns the scope of the websocket channel.
public Serializable	Returns: The user identifier of the websocket channel. getUser() Returns the user identifier of the websocket channel.
public boolean	Returns: Whether to (auto)connect the websocket or not. isConnected() Returns whether to (auto)connect the websocket or not.
public void	setChannel(String The name of the websocket channel. channel) Sets the name of the websocket channel.
public void	setConnected(boolean Whether to (auto)connect the websocket or not. connected) Sets whether to (auto)connect the websocket or not.
public void	setOnclose(String The JavaScript event handler function that is invoked when the websocket is closed. onclose) Sets the JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect.
public void	setOnerror(String The JavaScript event handler function that is invoked when a reconnection error has occurred. onerror) Sets the JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect.
public void	setOnmessage(String The JavaScript event handler function that is invoked when a push message is received from the server. onmessage) Sets the JavaScript event handler function that is invoked when a push message is received from the server.
public void	setOnopen(String The JavaScript event handler function that is invoked when the websocket is opened. onopen) Sets the JavaScript event handler function that is invoked when the websocket is opened.
public void	setScope(String The scope of the websocket channel. scope) Sets the scope of the websocket channel.
public void	setUser(Serializable The user identifier of the websocket channel. user) Sets the user identifier of the websocket channel, so that user-targeted push messages can be sent.
public void	setValueExpression(String Name of the attribute or property for which to set a `ValueExpression` name, ValueExpression The `ValueExpression` to set, or `null` to remove any currently set `ValueExpression` binding) Overrides jakarta.faces.component.UIComponent.setValueExpression. Set the `ValueExpression` used to calculate the value for the specified attribute or property name, if any.

COMPONENT_FAMILY	back to summary
public static final String COMPONENT_FAMILY The standard component family for this component.

COMPONENT_TYPE	back to summary
public static final String COMPONENT_TYPE The standard component type for this component.

CONTAINS_EVERYTHING	back to summary
private static final Collection<String> CONTAINS_EVERYTHING

ERROR_ENDPOINT_NOT_ENABLED	back to summary
private static final String ERROR_ENDPOINT_NOT_ENABLED

ERROR_INVALID_CHANNEL	back to summary
private static final String ERROR_INVALID_CHANNEL

ERROR_INVALID_USER	back to summary
private static final String ERROR_INVALID_USER

PATTERN_CHANNEL_NAME	back to summary
private static final Pattern PATTERN_CHANNEL_NAME

UIWebsocket	back to summary
public UIWebsocket() Create a new `UIWebsocket` instance with default property values. Exceptions IllegalStateException: When Websocket endpoint is not enabled.

Method Detail

getChannel	back to summary
public String getChannel() Returns the name of the websocket channel. Returns:String The name of the websocket channel.

getChannel

back to summary

public String getChannel()

Returns the name of the websocket channel.

Returns:String: The name of the websocket channel.

getEventNames back to summary

getEventNames	back to summary
public Collection<String> getEventNames() Overrides jakarta.faces.component.UIComponentBase.getEventNames. Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames. Returns a non-null, empty, unmodifiable `Collection` which returns `true` on any `Collection#contains()` invocation, indicating that all client behavior event names are acceptable. Returns:Collection<String> Doc from jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames. an unmodifiable collection of event names. Annotations @Override

public Collection<String> getEventNames()

Overrides jakarta.faces.component.UIComponentBase.getEventNames.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Returns a non-null, empty, unmodifiable Collection which returns true on any Collection#contains() invocation, indicating that all client behavior event names are acceptable.

Returns:Collection<String>

Doc from jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames.

an unmodifiable collection of event names.

Annotations

@Override

getFamily back to summary

getFamily	back to summary
public String getFamily() Implements abstract jakarta.faces.component.UIComponent.getFamily. Returns `UIWebsocket#COMPONENT_FAMILY`. Returns:String Doc from jakarta.faces.component.UIComponent.getFamily. the component family (not null). Annotations @Override

public String getFamily()

Implements abstract jakarta.faces.component.UIComponent.getFamily.

Returns UIWebsocket#COMPONENT_FAMILY.

Returns:String

Doc from jakarta.faces.component.UIComponent.getFamily.

the component family (not null).

Annotations

@Override

getOnclose	back to summary
public String getOnclose() Returns the JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect. Returns:String The JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect.

getOnclose

back to summary

public String getOnclose()

Returns the JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect.

Returns:String: The JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect.

getOnerror	back to summary
public String getOnerror() Returns the JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect. Returns:String The JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect. Since 4.0

getOnerror

back to summary

public String getOnerror()

Returns the JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect.

Returns:String: The JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect.
Since: 4.0

getOnmessage	back to summary
public String getOnmessage() Returns the JavaScript event handler function that is invoked when a push message is received from the server. Returns:String The JavaScript event handler function that is invoked when a push message is received from the server.

getOnmessage

back to summary

public String getOnmessage()

Returns the JavaScript event handler function that is invoked when a push message is received from the server.

Returns:String: The JavaScript event handler function that is invoked when a push message is received from the server.

getOnopen	back to summary
public String getOnopen() Returns the JavaScript event handler function that is invoked when the websocket is opened. Returns:String The JavaScript event handler function that is invoked when the websocket is opened.

getOnopen

back to summary

public String getOnopen()

Returns the JavaScript event handler function that is invoked when the websocket is opened.

Returns:String: The JavaScript event handler function that is invoked when the websocket is opened.

getScope	back to summary
public String getScope() Returns the scope of the websocket channel. Returns:String The scope of the websocket channel.

getScope

back to summary

public String getScope()

Returns the scope of the websocket channel.

Returns:String: The scope of the websocket channel.

getUser	back to summary
public Serializable getUser() Returns the user identifier of the websocket channel. Returns:Serializable The user identifier of the websocket channel.

getUser

back to summary

public Serializable getUser()

Returns the user identifier of the websocket channel.

Returns:Serializable: The user identifier of the websocket channel.

isConnected	back to summary
public boolean isConnected() Returns whether to (auto)connect the websocket or not. Returns:boolean Whether to (auto)connect the websocket or not.

isConnected

back to summary

public boolean isConnected()

Returns whether to (auto)connect the websocket or not.

Returns:boolean: Whether to (auto)connect the websocket or not.

setChannel	back to summary
public void setChannel(String channel) Sets the name of the websocket channel. It may not be an Jakarta Expression Language expression and it may only contain alphanumeric characters, hyphens, underscores and periods. All open websockets on the same channel will receive the same push message from the server. Parameters channel:String The name of the websocket channel. Exceptions IllegalArgumentException: When the value does not represent a valid channel name.

setChannel

back to summary

public void setChannel(String channel)

Sets the name of the websocket channel. It may not be an Jakarta Expression Language expression and it may only contain alphanumeric characters, hyphens, underscores and periods. All open websockets on the same channel will receive the same push message from the server.

Parameters

channel:String: The name of the websocket channel.

Exceptions

IllegalArgumentException:: When the value does not represent a valid channel name.

setConnected back to summary

setConnected	back to summary
public void setConnected(boolean connected) Sets whether to (auto)connect the websocket or not. Defaults to `true`. It's interpreted as a JavaScript instruction whether to open or close the websocket push connection. Note that this attribute is re-evaluated on every ajax request. You can also explicitly set it to `false` and then manually control in JavaScript by `faces.push.open("channelName")` and `faces.push.close("channelName")`. Parameters connected:boolean Whether to (auto)connect the websocket or not.

public void setConnected(boolean connected)

Sets whether to (auto)connect the websocket or not. Defaults to true. It's interpreted as a JavaScript instruction whether to open or close the websocket push connection. Note that this attribute is re-evaluated on every ajax request. You can also explicitly set it to false and then manually control in JavaScript by faces.push.open("channelName") and faces.push.close("channelName").

Parameters

connected:boolean: Whether to (auto)connect the websocket or not.

setOnclose back to summary

setOnclose	back to summary
public void setOnclose(String onclose) Sets the JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect. The function will be invoked with three arguments: the close reason code, the channel name and the raw `CloseEvent` itself. Note that this will also be invoked when the close is caused by an error and that you can inspect the close reason code if an actual connection error occurred and which one (i.e. when the code is not 1000 or 1008). See also RFC 6455 section 7.4.1 and `CloseCodes` API for an elaborate list of all close codes. Parameters onclose:String The JavaScript event handler function that is invoked when the websocket is closed.

public void setOnclose(String onclose)

Sets the JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect. The function will be invoked with three arguments: the close reason code, the channel name and the raw CloseEvent itself. Note that this will also be invoked when the close is caused by an error and that you can inspect the close reason code if an actual connection error occurred and which one (i.e. when the code is not 1000 or 1008). See also RFC 6455 section 7.4.1 and CloseCodes API for an elaborate list of all close codes.

Parameters

onclose:String: The JavaScript event handler function that is invoked when the websocket is closed.

setOnerror back to summary

setOnerror	back to summary
public void setOnerror(String onerror) Sets the JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect. The function will be invoked with three arguments: the error reason code, the channel name and the raw `CloseEvent` itself. Note that this will not be invoked on final close of the websocket, even when the final close is caused by an error. See also RFC 6455 section 7.4.1 and `CloseCodes` API for an elaborate list of all close codes. Parameters onerror:String The JavaScript event handler function that is invoked when a reconnection error has occurred. Since 4.0

public void setOnerror(String onerror)

Sets the JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect. The function will be invoked with three arguments: the error reason code, the channel name and the raw CloseEvent itself. Note that this will not be invoked on final close of the websocket, even when the final close is caused by an error. See also RFC 6455 section 7.4.1 and CloseCodes API for an elaborate list of all close codes.

Parameters

onerror:String: The JavaScript event handler function that is invoked when a reconnection error has occurred.

Since

4.0

setOnmessage	back to summary
public void setOnmessage(String onmessage) Sets the JavaScript event handler function that is invoked when a push message is received from the server. The function will be invoked with three arguments: the push message, the channel name and the raw MessageEvent itself. Parameters onmessage:String The JavaScript event handler function that is invoked when a push message is received from the server.

setOnmessage

back to summary

public void setOnmessage(String onmessage)

Sets the JavaScript event handler function that is invoked when a push message is received from the server. The function will be invoked with three arguments: the push message, the channel name and the raw MessageEvent itself.

Parameters

onmessage:String: The JavaScript event handler function that is invoked when a push message is received from the server.

setOnopen	back to summary
public void setOnopen(String onopen) Sets the JavaScript event handler function that is invoked when the websocket is opened. The function will be invoked with one argument: the channel name. Parameters onopen:String The JavaScript event handler function that is invoked when the websocket is opened.

setOnopen

back to summary

public void setOnopen(String onopen)

Sets the JavaScript event handler function that is invoked when the websocket is opened. The function will be invoked with one argument: the channel name.

Parameters

onopen:String: The JavaScript event handler function that is invoked when the websocket is opened.

setScope back to summary

setScope	back to summary
public void setScope(String scope) Sets the scope of the websocket channel. It may not be an Jakarta Expression Language expression and allowed values are `application`, `session` and `view`, case insensitive. When the value is `application`, then all channels with the same name throughout the application will receive the same push message. When the value is `session`, then only the channels with the same name in the current user session will receive the same push message. When the value is `view`, then only the channel in the current view will receive the push message. The default scope is `application`. When the `user` attribute is specified, then the default scope is `session`. Parameters scope:String The scope of the websocket channel.

public void setScope(String scope)

Sets the scope of the websocket channel. It may not be an Jakarta Expression Language expression and allowed values are application, session and view, case insensitive. When the value is application, then all channels with the same name throughout the application will receive the same push message. When the value is session, then only the channels with the same name in the current user session will receive the same push message. When the value is view, then only the channel in the current view will receive the push message. The default scope is application. When the user attribute is specified, then the default scope is session.

Parameters

scope:String: The scope of the websocket channel.

setUser back to summary

setUser	back to summary
public void setUser(Serializable user) Sets the user identifier of the websocket channel, so that user-targeted push messages can be sent. All open websockets on the same channel and user will receive the same push message from the server. It must implement `Serializable` and preferably have low memory footprint. Suggestion: use `#{request.remoteUser}` or `#{someLoggedInUser.id}`. Parameters user:Serializable The user identifier of the websocket channel.

public void setUser(Serializable user)

Sets the user identifier of the websocket channel, so that user-targeted push messages can be sent. All open websockets on the same channel and user will receive the same push message from the server. It must implement Serializable and preferably have low memory footprint. Suggestion: use #{request.remoteUser} or #{someLoggedInUser.id}.

Parameters

user:Serializable: The user identifier of the websocket channel.

setValueExpression back to summary

setValueExpression	back to summary
public void setValueExpression(String name, ValueExpression binding) Overrides jakarta.faces.component.UIComponent.setValueExpression. Set the `ValueExpression` used to calculate the value for the specified attribute or property name, if any. If a `ValueExpression` is set for the `channel` or `scope` property, regardless of the value, throw an illegal argument exception. If a `ValueExpression` is set for the `user` property, and the non-null value is not an instance of `Serializable`, throw an illegal argument exception. Parameters name:String Doc from jakarta.faces.component.UIComponent.setValueExpression. Name of the attribute or property for which to set a `ValueExpression` binding:ValueExpression Doc from jakarta.faces.component.UIComponent.setValueExpression. The `ValueExpression` to set, or `null` to remove any currently set `ValueExpression` Annotations @Override Exceptions IllegalArgumentException: If `name` is one of `id`, `parent`, `channel` or `scope`, or it `name` is `user` and the non-null value is not an instance of `Serializable`. NullPointerException: If `name` is `null`.

public void setValueExpression(String name, ValueExpression binding)

Overrides jakarta.faces.component.UIComponent.setValueExpression.

Set the ValueExpression used to calculate the value for the specified attribute or property name, if any. If a ValueExpression is set for the channel or scope property, regardless of the value, throw an illegal argument exception. If a ValueExpression is set for the user property, and the non-null value is not an instance of Serializable, throw an illegal argument exception.

Parameters

name:String

Doc from jakarta.faces.component.UIComponent.setValueExpression.

Name of the attribute or property for which to set a ValueExpression

binding:ValueExpression

Doc from jakarta.faces.component.UIComponent.setValueExpression.

The ValueExpression to set, or null to remove any currently set ValueExpression

Annotations

@Override

Exceptions

IllegalArgumentException:: If name is one of id, parent, channel or scope, or it name is user and the non-null value is not an instance of Serializable.
NullPointerException:: If name is null.

Modifier and Type	Method and Description
public static UIWebsocket.PropertyKeys	valueOf(String name)
public static UIWebsocket.PropertyKeys[]	values()

public Class UIWebsocket

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum UIWebsocket.PropertyKeys

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
public static final UIWebsocket.PropertyKeys	channel
public static final UIWebsocket.PropertyKeys	connected
public static final UIWebsocket.PropertyKeys	onclose
public static final UIWebsocket.PropertyKeys	onerror
public static final UIWebsocket.PropertyKeys	onmessage
public static final UIWebsocket.PropertyKeys	onopen
public static final UIWebsocket.PropertyKeys	scope
public static final UIWebsocket.PropertyKeys	user