org.jboss.portal.common.invocation
Interface AttributeResolver

All Known Subinterfaces:
NavigationalStateContext
All Known Implementing Classes:
AbstractSessionAttributeResolver, EmptyAttributeResolver, MapAttributeResolver, PortalObjectNavigationalStateContext, PrincipalAttributeResolver, RequestAttributeResolver, SessionAttributeResolver

public interface AttributeResolver

An attribute resolver.

Version:
$Revision: 7228 $
Author:
Julien Viet

Method Summary
 java.lang.Object getAttribute(java.lang.Object attrKey)
          Return an attribute from this resolver.
 java.util.Set getKeys()
          Returns the set of keys of the attributes bound in that resolver.
 void setAttribute(java.lang.Object attrKey, java.lang.Object attrValue)
          Update an attribute value on this resolve.
 

Method Detail

getKeys

java.util.Set getKeys()
Returns the set of keys of the attributes bound in that resolver.

Returns:
a set of keys

getAttribute

java.lang.Object getAttribute(java.lang.Object attrKey)
                              throws java.lang.IllegalArgumentException
Return an attribute from this resolver.

Parameters:
attrKey -
Returns:
the attribute value or null if it is not found
Throws:
java.lang.IllegalArgumentException - if the attribute key is not valid

setAttribute

void setAttribute(java.lang.Object attrKey,
                  java.lang.Object attrValue)
                  throws java.lang.IllegalArgumentException
Update an attribute value on this resolve. If the attribute value is null the resolver must treat the operation as a removal of the attribute.

Parameters:
attrKey -
attrValue - the attribute value
Throws:
java.lang.IllegalArgumentException - if the attribute key is not valid