Module org.omnifaces

Package org.omnifaces.cdi.push

Class SseEvent

java.lang.Object

org.omnifaces.cdi.push.SseEvent

All Implemented Interfaces:

Serializable

public final class SseEvent
extends Object

This SSE event will be fired by SseSessionManager when an SSE connection has been @SseEvent.Opened, @SseEvent.Switched or @SseEvent.Closed. An application scoped CDI bean can @Observes them.

For detailed usage instructions, see Sse javadoc.

Since:

5.2

Author:

Bauke Scholtz

See Also:

• Sse
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	SseEvent.Closed	Indicates that a SSE channel has closed.
static @interface	SseEvent.Opened	Indicates that a SSE channel has opened.
static @interface	SseEvent.Switched	Indicates that a SSE user was switched.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
String	getChannel()	Returns the push channel name.
<S extends Serializable> S	getPreviousUser()	Returns the previous user identifier, if any.
<S extends Serializable> S	getUser()	Returns the current user identifier, if any.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getChannel

public String getChannel()

Returns the push channel name.

Returns:

The push channel name.

getUser

public <S extends Serializable> S getUser()

Returns the current user identifier, if any.

Type Parameters:

S - The generic type of the user identifier.

Returns:

The current user identifier, if any.

Throws:

ClassCastException - When S is of wrong type.

getPreviousUser

public <S extends Serializable> S getPreviousUser()

Returns the previous user identifier, if any.

Type Parameters:

S - The generic type of the user identifier.

Returns:

The previous user identifier, if any.

Throws:

ClassCastException - When S is of wrong type.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object