|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.mina.common.IoFilterAdapter
org.apache.mina.filter.util.SessionAttributeInitializingFilter
public class SessionAttributeInitializingFilter
An IoFilter
that sets initial attributes when a new
IoSession
is created. By default, the attribute map is empty when
an IoSession
is newly created. Inserting this filter will make
the pre-configured attributes available after this filter executes the
sessionCreated event.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.mina.common.IoFilter |
---|
IoFilter.NextFilter |
Constructor Summary | |
---|---|
SessionAttributeInitializingFilter()
Creates a new instance with no default attributes. |
|
SessionAttributeInitializingFilter(Map<String,? extends Object> attributes)
Creates a new instance with the specified default attributes. |
Method Summary | |
---|---|
Object |
getAttribute(String key)
Returns the value of user-defined attribute. |
Set<String> |
getAttributeKeys()
Returns the set of keys of all user-defined attributes. |
Object |
removeAttribute(String key)
Removes a user-defined attribute with the specified key. |
void |
sessionCreated(IoFilter.NextFilter nextFilter,
IoSession session)
Puts all pre-configured attributes into the actual session attribute map and forward the event to the next filter. |
Object |
setAttribute(String key)
Sets a user defined attribute without a value. |
Object |
setAttribute(String key,
Object value)
Sets a user-defined attribute. |
void |
setAttributes(Map<String,? extends Object> attributes)
Sets the attribute map. |
Methods inherited from class org.apache.mina.common.IoFilterAdapter |
---|
destroy, exceptionCaught, filterClose, filterSetTrafficMask, filterWrite, init, messageReceived, messageSent, onPostAdd, onPostRemove, onPreAdd, onPreRemove, sessionClosed, sessionIdle, sessionOpened |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SessionAttributeInitializingFilter()
setAttribute(String, Object)
and setAttributes(Map)
.
public SessionAttributeInitializingFilter(Map<String,? extends Object> attributes)
setAttribute(String, Object)
and setAttributes(Map)
.
Method Detail |
---|
public Object getAttribute(String key)
key
- the key of the attribute
public Object setAttribute(String key, Object value)
key
- the key of the attributevalue
- the value of the attribute
public Object setAttribute(String key)
Boolean.TRUE
.
key
- the key of the attribute
public Object removeAttribute(String key)
public Set<String> getAttributeKeys()
public void setAttributes(Map<String,? extends Object> attributes)
public void sessionCreated(IoFilter.NextFilter nextFilter, IoSession session) throws Exception
sessionCreated
in interface IoFilter
sessionCreated
in class IoFilterAdapter
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |