javax.servlet.sip

Interface AttributeStore

All Known Subinterfaces:

ForkingContext, InviteBranch, SipApplicationSession, SipServletMessage, SipServletRequest, SipServletResponse, SipSession

public interface AttributeStore

Interface representing a store of attributes. Attributes are objects bound to the store with a specified name. Note that this interface provide happens before concurrency guarantee that retrieval operations (getAttribute) reflects the most recently completed update operation (setAttribute and removeAttribute).

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAttributes() Remove all the attributes set by the application from this attribute store.
Object	getAttribute(String name) Returns the object bound with the specified name in this store, or null if no object is bound under the name.
Set<String>	getAttributeNameSet() Returns a Set of the String objects containing the names of all the objects bound to this store.
void	removeAttribute(String name) Removes the object bound with the specified name from this store.
void	setAttribute(String name, Object attribute) Binds an object to this store, using the name specified.

Method Detail

getAttribute

Object getAttribute(String name)

Returns the object bound with the specified name in this store, or null if no object is bound under the name.

Parameters:

name - a string specifying the name of the object

Returns:

the object with the specified name

Throws:

IllegalStateException - if this method is called on an invalid attribute store

NullPointerException - if the name is null

removeAttribute

void removeAttribute(String name)

Removes the object bound with the specified name from this store. If the session does not have an object bound with the specified name, this method does nothing.

Parameters:

name - the name of the object to remove from this store

Throws:

IllegalStateException - if this method is called on an invalid attribute store

setAttribute

void setAttribute(String name,
                Object attribute)

Binds an object to this store, using the name specified. If an object of the same name is already bound to the store, the object is replaced.

Parameters:

name - the name to which the object is bound; cannot be null

attribute - the object to be bound; cannot be null

Throws:

IllegalStateException - if this method is called on an invalid attribute store

NullPointerException - if the name or attribute is null

getAttributeNameSet

Set<String> getAttributeNameSet()

Returns a Set of the String objects containing the names of all the objects bound to this store.

Returns:

a Set of the String objects specifying the names of all the objects bound to this store.

Throws:

IllegalStateException - if this method is called on an invalid attribute store

clearAttributes

void clearAttributes()

Remove all the attributes set by the application from this attribute store.

Throws:

IllegalStateException - if this method is called on an invalid attribute store