Package jakarta.faces.component

Class UIWebsocket

    • Field Detail

      • COMPONENT_TYPE

        public static final String COMPONENT_TYPE

        The standard component type for this component.

        See Also:
        Constant Field Values

      • COMPONENT_FAMILY

        public static final String COMPONENT_FAMILY

        The standard component family for this component.

        See Also:
        Constant Field Values

    • Constructor Detail

      • UIWebsocket

        public UIWebsocket()

        Create a new UIWebsocket instance with default property values.

        Throws:
        IllegalStateException - When Websocket endpoint is not enabled.

    • Method Detail

      • getEventNames

        public Collection<String> 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.

        Specified by:
        getEventNames in interface ClientBehaviorHolder
        Overrides:
        getEventNames in class UIComponentBase
        Returns:
        the collection of event names.

      • getChannel

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

      • setChannel

        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 - The name of the websocket channel.
        Throws:
        IllegalArgumentException - When the value does not represent a valid channel name.

      • getScope

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

      • setScope

        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 - The scope of the websocket channel.

      • getUser

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

      • setUser

        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 - The user identifier of the websocket channel.

      • getOnopen

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

      • setOnopen

        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 - The JavaScript event handler function that is invoked when the websocket is opened.

      • getOnmessage

        public String getOnmessage()
        Returns 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 a push message is received from the server.

      • setOnmessage

        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 - The JavaScript event handler function that is invoked when a push message is received from the server.

      • getOnerror

        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:
        The JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect.
        Since:
        4.0

      • setOnerror

        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 CloseReason.CloseCodes API for an elaborate list of all close codes.
        Parameters:
        onerror - The JavaScript event handler function that is invoked when a reconnection error has occurred.
        Since:
        4.0

      • getOnclose

        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:
        The JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect.

      • setOnclose

        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 CloseReason.CloseCodes API for an elaborate list of all close codes.
        Parameters:
        onclose - The JavaScript event handler function that is invoked when the websocket is closed.

      • isConnected

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

      • setConnected

        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 - Whether to (auto)connect the websocket or not.