|
Errai 3.0.1-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jboss.errai.bus.server.cluster.IntrabusQueueSession
public class IntrabusQueueSession
Field Summary | |
---|---|
static QueueSession |
INSTANCE
|
Method Summary | ||
---|---|---|
void |
addSessionEndListener(SessionEndListener listener)
Registers a listener that will notified when this session ends. |
|
boolean |
endSession()
Closes this session and notifies the SessionEndListener s (optional operation; not all QueueSession
implementations are closeable). |
|
|
getAttribute(Class<T> type,
String attribute)
Returns the value associated with the given key. |
|
Collection<String> |
getAttributeNames()
Returns the names of all attributes within this session. |
|
String |
getParentSessionId()
Returns the ID of the session this QueueSession wraps. |
|
String |
getSessionId()
Returns the ID of this session, which uniquely identifies it within the scope of this client (or server for a server side session). |
|
boolean |
hasAttribute(String attribute)
Returns true if the specified attribute exists. |
|
boolean |
isValid()
|
|
Object |
removeAttribute(String attribute)
Removes the specified attribute from this session. |
|
void |
setAttribute(String attribute,
Object value)
Associates the given value with the given key, replacing the existing value, if any, for the key. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final QueueSession INSTANCE
Method Detail |
---|
public String getSessionId()
QueueSession
getSessionId
in interface QueueSession
public String getParentSessionId()
QueueSession
getParentSessionId
in interface QueueSession
public boolean endSession()
QueueSession
SessionEndListener
s (optional operation; not all QueueSession
implementations are closeable).
endSession
in interface QueueSession
public void setAttribute(String attribute, Object value)
QueueSession
See the class-level documentation for a note on the scope of these attributes.
setAttribute
in interface QueueSession
attribute
- the name (key) of the attribute. Not null.value
- new value for attribute. Null is permitted.public <T> T getAttribute(Class<T> type, String attribute)
QueueSession
See the class-level documentation for a note on the scope of these attributes.
getAttribute
in interface QueueSession
T
- the typetype
- the type to attempt to cast the attribute's value toattribute
- the name (key) of the attribute. Not null.
QueueSession.hasAttribute(String)
to test for the existence of a null-valued
attribute.public Collection<String> getAttributeNames()
QueueSession
See the class-level documentation for a note on the scope of these attributes.
getAttributeNames
in interface QueueSession
public boolean hasAttribute(String attribute)
QueueSession
See the class-level documentation for a note on the scope of these attributes.
hasAttribute
in interface QueueSession
attribute
- the attribute name to search for.
public Object removeAttribute(String attribute)
QueueSession
See the class-level documentation for a note on the scope of these attributes.
removeAttribute
in interface QueueSession
attribute
- the name of the attribute to remove.
public void addSessionEndListener(SessionEndListener listener)
QueueSession
addSessionEndListener
in interface QueueSession
listener
- the listener to be notified at session end.public boolean isValid()
isValid
in interface QueueSession
|
Errai 3.0.1-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |