15.17 The UserAttributes interface

Description

After user authentication, obtains attributes bound to the subject.

The package name of the UserAttributes interface is com.cosminexus.admin.auth.

Syntax

interface UserAttributes
{
  public Object getAttribute(String alias)
    throws IllegalStateException;
  public Enumeration getAttributes(String alias)
    throws IllegalStateException;
  public void addAttribute(String alias,
                                Object attr)
    throws IllegalStateException;
  public Enumeration getAttributeNames()
    throws IllegalStateException;
  public void removeAttribute(String alias)
    throws IllegalStateException;
  public int size()
    throws IllegalStateException;
  public Enumeration getAliases()
    throws IllegalStateException;
}

Methods

Method name	Functionality
`addAttribute` method	Adds an attribute to the subject.
`getAttribute` method	Obtains an attribute bound to the subject.
`getAttributeNames` method	Obtains a list of attribute names bound to the subject.
`getAttributes` method	Obtains all of the attributes bound to the subject.
`removeAttribute` method	Deletes an attribute bound to the subject.
`size` method	Obtains the total number of attributes bound to the subject.
`getAliases` method	Not recommended. Use the `getAttributeNames` method.

Remarks

If this object is invalid, calling a method causes java.lang.IllegalStateException. Note that this exception inherits from java.lang.RuntimeException and can therefore be compiled without being defined in catch or throws.

Organization of this section

To Page Top