Create a new UIWebsocket instance with default property values.

Exceptions

IllegalStateException:

When Websocket endpoint is not enabled.

Returns the name of the websocket channel.

Returns:String

The name of the websocket channel.

Overrides javax.faces.component.UIComponentBase.getEventNames.

Implements javax.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 javax.faces.component.behavior.ClientBehaviorHolder.getEventNames.

an unmodifiable collection of event names.

Annotations

@Override

Implements abstract javax.faces.component.UIComponent.getFamily.

Returns UIWebsocket#COMPONENT_FAMILY.

Returns:String

Doc from javax.faces.component.UIComponent.getFamily.

the component family (not null).

Annotations

@Override

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

Returns:String

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

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.

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.

Returns the scope of the websocket channel.

Returns:String

The scope of the websocket channel.

Returns the user identifier of the websocket channel.

Returns:Serializable

The user identifier of the websocket channel.

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

Returns:boolean

Whether to (auto)connect the websocket or not.

Sets the name of the websocket channel. It may not be an EL 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.

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 OmniFaces.Push.open("channelName") and OmniFaces.Push.close("channelName").

Parameters

connected:boolean

Whether to (auto)connect the websocket or not.

Sets the JavaScript event handler function that is invoked when the websocket is closed. 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 on errors and that you can inspect the close reason code if an error occurred and which one (i.e. when the code is not 1000). 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.

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.

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.

Sets the scope of the websocket channel. It may not be an EL 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.

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.

Overrides javax.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 javax.faces.component.UIComponent.setValueExpression.

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

binding:ValueExpression

Doc from javax.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.