WebsocketFacesListener (Mojarra 4.0.0 4.0.0 API)

java.lang.Object
- com.sun.faces.push.WebsocketFacesListener

All Implemented Interfaces:

FacesListener, SystemEventListener, EventListener
```
public class WebsocketFacesListener
extends Object
implements SystemEventListener
```
This Faces listener for UIViewRoot ensures that the necessary JavaScript code to open or close the WebSocket is properly rendered depending on rendered and connected attributes.

Since:

2.3

Author:

Bauke Scholtz

See Also:

Push

Constructor Summary

Constructors
Constructor Description

WebsocketFacesListener()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isListenerForSource(Object source)`	Only listens on `UIViewRoot`.
`static boolean`	`isNew(FacesContext context, UIWebsocket websocket)`
`void`	`processEvent(SystemEvent event)`	If the websocket has just switched its `rendered` or `connected` attribute, then render either the `open()` script or the `close()` script.
`static void`	`subscribeIfNecessary(FacesContext context)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebsocketFacesListener
```
public WebsocketFacesListener()
```
- Method Detail
  - subscribeIfNecessary
```
public static void subscribeIfNecessary(FacesContext context)
```
  - isNew
```
public static boolean isNew(FacesContext context,
                            UIWebsocket websocket)
```
  - isListenerForSource
```
public boolean isListenerForSource(Object source)
```
    Only listens on UIViewRoot.
    
    Specified by:
    
    isListenerForSource in interface SystemEventListener
    
    Parameters:
    
    source - the source that is inquiring about the appropriateness of sending an event to this listener instance.
    
    Returns:
    
    the value as specified above
  - processEvent
```
public void processEvent(SystemEvent event)
                  throws AbortProcessingException
```
    If the websocket has just switched its rendered or connected attribute, then render either the open() script or the close() script. During an ajax request with partial rendering, it's added as <eval> by partial response writer, else it's just added as a script component with target="body".
    
    Specified by:
    
    processEvent in interface SystemEventListener
    
    Parameters:
    
    event - the SystemEvent instance that is being processed.
    
    Throws:
    
    AbortProcessingException - if lifecycle processing should cease for this request.