ch.rasc.wampspring.config

Class WampSession

java.lang.Object

ch.rasc.wampspring.config.WampSession

public class WampSession
extends Object

Author:

Rossen Stoyanchev, Ralph Schaer

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESTRUCTION_CALLBACK_NAME_PREFIX Prefix for the name of session attributes used to store destruction callbacks.
static String	SESSION_COMPLETED_NAME Key set after the session is completed
static String	SESSION_MUTEX_NAME Key for the mutex session attribute

Constructor Summary

Constructors

Constructor and Description
WampSession(org.springframework.web.socket.WebSocketSession webSocketSession)

Method Summary

Modifier and Type	Method and Description
void	addPrefix(String prefix, String uri)
<T> T	getAttribute(String name) Return the value for the attribute of the given name, if any.
String[]	getAttributeNames() Retrieve the names of all attributes.
String	getAuthKey()
String	getChallenge()
String	getPrefix(String curie)
Map<String,String>	getPrefixes()
Object	getSessionMutex() Expose the object to synchronize on for the underlying session.
String	getSignature()
org.springframework.web.socket.WebSocketSession	getWebSocketSession()
String	getWebSocketSessionId() Return an id for the associated WebSocket session.
boolean	hasPrefixes()
boolean	isAuthenticated()
boolean	isAuthRequested()
boolean	isSessionCompleted() Whether the sessionCompleted() was already invoked.
void	registerDestructionCallback(String name, Runnable callback) Register a callback to execute on destruction of the specified attribute.
void	removeAttribute(String name) Remove the attribute of the given name, if it exists.
void	sessionCompleted() Invoked when the session is completed.
void	setAttribute(String name, Object value) Set the value with the given name replacing an existing value (if any).
void	setAuthKey(String authKey)
void	setChallenge(String challenge)
void	setSignature(String signature)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SESSION_MUTEX_NAME

public static final String SESSION_MUTEX_NAME

Key for the mutex session attribute

SESSION_COMPLETED_NAME

public static final String SESSION_COMPLETED_NAME

Key set after the session is completed

DESTRUCTION_CALLBACK_NAME_PREFIX

public static final String DESTRUCTION_CALLBACK_NAME_PREFIX

Prefix for the name of session attributes used to store destruction callbacks.

Constructor Detail

WampSession

public WampSession(org.springframework.web.socket.WebSocketSession webSocketSession)

Method Detail

getAttribute

public <T> T getAttribute(String name)

Return the value for the attribute of the given name, if any.

Parameters:

name - the name of the attribute

Returns:

the current attribute value, or null if not found

getWebSocketSession

public org.springframework.web.socket.WebSocketSession getWebSocketSession()

setAttribute

public void setAttribute(String name,
                         Object value)

Set the value with the given name replacing an existing value (if any).

Parameters:

name - the name of the attribute

value - the value for the attribute

removeAttribute

public void removeAttribute(String name)

Remove the attribute of the given name, if it exists.

Also removes the registered destruction callback for the specified attribute, if any. However it does not execute the callback. It is assumed the removed object will continue to be used and destroyed independently at the appropriate time.

Parameters:

name - the name of the attribute

getAttributeNames

public String[] getAttributeNames()

Retrieve the names of all attributes.

Returns:

the attribute names as String array, never null

registerDestructionCallback

public void registerDestructionCallback(String name,
                                        Runnable callback)

Register a callback to execute on destruction of the specified attribute. The callback is executed when the session is closed.

Parameters:

name - the name of the attribute to register the callback for

callback - the destruction callback to be executed

getWebSocketSessionId

public String getWebSocketSessionId()

Return an id for the associated WebSocket session.

Returns:

the session id as String (never null)

getSessionMutex

public Object getSessionMutex()

Expose the object to synchronize on for the underlying session.

Returns:

the session mutex to use (never null)

isSessionCompleted

public boolean isSessionCompleted()

Whether the sessionCompleted() was already invoked.

sessionCompleted

public void sessionCompleted()

Invoked when the session is completed. Executed completion callbacks.

isAuthRequested

public boolean isAuthRequested()

isAuthenticated

public boolean isAuthenticated()

getAuthKey

public String getAuthKey()

setAuthKey

public void setAuthKey(String authKey)

getChallenge

public String getChallenge()

setChallenge

public void setChallenge(String challenge)

getSignature

public String getSignature()

setSignature

public void setSignature(String signature)

addPrefix

public void addPrefix(String prefix,
                      String uri)

hasPrefixes

public boolean hasPrefixes()

getPrefix

public String getPrefix(String curie)

getPrefixes

public Map<String,String> getPrefixes()