org.apache.mina.core.session

Class DefaultIoSessionDataStructureFactory.DefaultIoSessionAttributeMap

java.lang.Object

org.apache.mina.core.session.DefaultIoSessionDataStructureFactory.DefaultIoSessionAttributeMap

All Implemented Interfaces:

IoSessionAttributeMap

Enclosing class:

DefaultIoSessionDataStructureFactory

private static class DefaultIoSessionDataStructureFactory.DefaultIoSessionAttributeMap
extends java.lang.Object
implements IoSessionAttributeMap

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.ConcurrentHashMap<java.lang.Object,java.lang.Object>	attributes

Constructor Summary

Constructors

Constructor and Description
DefaultIoSessionAttributeMap() Default constructor

Method Summary

Modifier and Type	Method and Description
boolean	containsAttribute(IoSession session, java.lang.Object key) Returns true if this session contains the attribute with the specified key.
void	dispose(IoSession session) Disposes any releases associated with the specified session.
java.lang.Object	getAttribute(IoSession session, java.lang.Object key, java.lang.Object defaultValue) Returns the value of user defined attribute associated with the specified key.
java.util.Set<java.lang.Object>	getAttributeKeys(IoSession session) Returns the set of keys of all user-defined attributes.
java.lang.Object	removeAttribute(IoSession session, java.lang.Object key) Removes a user-defined attribute with the specified key.
boolean	removeAttribute(IoSession session, java.lang.Object key, java.lang.Object value) Removes a user defined attribute with the specified key if the current attribute value is equal to the specified value.
boolean	replaceAttribute(IoSession session, java.lang.Object key, java.lang.Object oldValue, java.lang.Object newValue) Replaces a user defined attribute with the specified key if the value of the attribute is equals to the specified old value.
java.lang.Object	setAttribute(IoSession session, java.lang.Object key, java.lang.Object value) Sets a user-defined attribute.
java.lang.Object	setAttributeIfAbsent(IoSession session, java.lang.Object key, java.lang.Object value) Sets a user defined attribute if the attribute with the specified key is not set yet.

Methods inherited from class java.lang.Object

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

Field Detail

attributes

private final java.util.concurrent.ConcurrentHashMap<java.lang.Object,java.lang.Object> attributes

Constructor Detail

DefaultIoSessionAttributeMap

public DefaultIoSessionAttributeMap()

Default constructor

Method Detail

getAttribute

public java.lang.Object getAttribute(IoSession session,
                                     java.lang.Object key,
                                     java.lang.Object defaultValue)

Returns the value of user defined attribute associated with the specified key. If there's no such attribute, the specified default value is associated with the specified key, and the default value is returned. This method is same with the following code except that the operation is performed atomically.

 if (containsAttribute(key)) {
     return getAttribute(key);
 } else {
     setAttribute(key, defaultValue);
     return defaultValue;
 }
 

Specified by:

getAttribute in interface IoSessionAttributeMap

setAttribute

public java.lang.Object setAttribute(IoSession session,
                                     java.lang.Object key,
                                     java.lang.Object value)

Sets a user-defined attribute.

Specified by:

setAttribute in interface IoSessionAttributeMap

key - the key of the attribute

value - the value of the attribute

Returns:

The old value of the attribute. null if it is new.

setAttributeIfAbsent

public java.lang.Object setAttributeIfAbsent(IoSession session,
                                             java.lang.Object key,
                                             java.lang.Object value)

Sets a user defined attribute if the attribute with the specified key is not set yet. This method is same with the following code except that the operation is performed atomically.

 if (containsAttribute(key)) {
     return getAttribute(key);
 } else {
     return setAttribute(key, value);
 }
 

Specified by:

setAttributeIfAbsent in interface IoSessionAttributeMap

removeAttribute

public java.lang.Object removeAttribute(IoSession session,
                                        java.lang.Object key)

Removes a user-defined attribute with the specified key.

Specified by:

removeAttribute in interface IoSessionAttributeMap

Returns:

The old value of the attribute. null if not found.

removeAttribute

public boolean removeAttribute(IoSession session,
                               java.lang.Object key,
                               java.lang.Object value)

Removes a user defined attribute with the specified key if the current attribute value is equal to the specified value. This method is same with the following code except that the operation is performed atomically.

 if (containsAttribute(key) && getAttribute(key).equals(value)) {
     removeAttribute(key);
     return true;
 } else {
     return false;
 }
 

Specified by:

removeAttribute in interface IoSessionAttributeMap

replaceAttribute

public boolean replaceAttribute(IoSession session,
                                java.lang.Object key,
                                java.lang.Object oldValue,
                                java.lang.Object newValue)

Replaces a user defined attribute with the specified key if the value of the attribute is equals to the specified old value. This method is same with the following code except that the operation is performed atomically.

 if (containsAttribute(key) && getAttribute(key).equals(oldValue)) {
     setAttribute(key, newValue);
     return true;
 } else {
     return false;
 }
 

Specified by:

replaceAttribute in interface IoSessionAttributeMap

containsAttribute

public boolean containsAttribute(IoSession session,
                                 java.lang.Object key)

Returns true if this session contains the attribute with the specified key.

Specified by:

containsAttribute in interface IoSessionAttributeMap

getAttributeKeys

public java.util.Set<java.lang.Object> getAttributeKeys(IoSession session)

Returns the set of keys of all user-defined attributes.

Specified by:

getAttributeKeys in interface IoSessionAttributeMap

dispose

public void dispose(IoSession session)
             throws java.lang.Exception

Disposes any releases associated with the specified session. This method is invoked on disconnection.

Specified by:

dispose in interface IoSessionAttributeMap

Throws:

java.lang.Exception