org.exoplatform.services.security

Class ConversationState

java.lang.Object

org.exoplatform.services.security.ConversationState

All Implemented Interfaces:

org.exoplatform.container.component.ThreadContextHolder

public class ConversationState
extends Object
implements org.exoplatform.container.component.ThreadContextHolder

Created by The eXo Platform SAS
An object which stores all information about the state of the current user.

Author:

Gennady Azarenkov

Level API:

Provisional

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUBJECT "subject".

Fields inherited from interface org.exoplatform.container.component.ThreadContextHolder

MANAGE_THREAD_LOCAL

Constructor Summary

Constructors

Constructor and Description
ConversationState(Identity identity)

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String name)
Set<String>	getAttributeNames() Returns unmodifiable set of attribute names.
static ConversationState	getCurrent()
Identity	getIdentity()
org.exoplatform.container.component.ThreadContext	getThreadContext() Gives the value corresponding to the context of the thread
void	removeAttribute(String name) removes attribute.
void	setAttribute(String name, Object value) sets attribute.
static void	setCurrent(ConversationState state) Preset current ConversationState.

Methods inherited from class java.lang.Object

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

Field Detail

SUBJECT

public static final String SUBJECT

"subject".

See Also:

Constant Field Values

Constructor Detail

ConversationState

public ConversationState(Identity identity)

Method Detail

getCurrent

public static ConversationState getCurrent()

Returns:

current ConversationState or null if it was not preset

setCurrent

public static void setCurrent(ConversationState state)

Preset current ConversationState.

Parameters:

state - ConversationState

getIdentity

public Identity getIdentity()

Returns:

Identity the user identity object

setAttribute

public void setAttribute(String name,
                         Object value)

sets attribute.

Parameters:

name - the name of the attribute to set

value - the value of the attribute to set

getAttribute

public Object getAttribute(String name)

Parameters:

name - the name of the attribute to retrieve

Returns:

the value of the attribute to retrieve

getAttributeNames

public Set<String> getAttributeNames()

Returns unmodifiable set of attribute names.

Returns:

all attribute names

removeAttribute

public void removeAttribute(String name)

removes attribute.

Parameters:

name - the name of the attribute to remove

getThreadContext

public org.exoplatform.container.component.ThreadContext getThreadContext()

Gives the value corresponding to the context of the thread

Specified by:

getThreadContext in interface org.exoplatform.container.component.ThreadContextHolder

Returns:

a new instance of ThreadContext if there are some valuable ThreadLocal variables to share otherwise null is expected