Interface AttributeResolver<K,V>

All Known Implementing Classes:
AbstractSessionAttributeResolver, MapAttributeResolver, PrincipalAttributeResolver

public interface AttributeResolver<K,V>
An attribute resolver.
Version:
$Revision: 7228 $
Author:
Julien Viet
  • Method Summary

    Modifier and Type
    Method
    Description
    getAttribute(K attrKey)
    Return an attribute from this resolver.
    Returns the set of keys of the attributes bound in that resolver.
    void
    setAttribute(K attrKey, V attrValue)
    Update an attribute value on this resolve.
  • Method Details

    • getKeys

      Set<K> getKeys()
      Returns the set of keys of the attributes bound in that resolver.
      Returns:
      a set of keys
    • getAttribute

      V getAttribute(K attrKey) throws IllegalArgumentException
      Return an attribute from this resolver.
      Parameters:
      attrKey -
      Returns:
      the attribute value or null if it is not found
      Throws:
      IllegalArgumentException - if the attribute key is not valid
    • setAttribute

      void setAttribute(K attrKey, V attrValue) throws 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:
      IllegalArgumentException - if the attribute key is not valid