com.ibm.security.auth
Class DomainPrincipal

java.lang.Object
  extended by com.ibm.security.auth.JAASPrincipal
      extended by com.ibm.security.auth.DomainPrincipal
All Implemented Interfaces:
java.io.Serializable, java.security.Principal

public class DomainPrincipal
extends JAASPrincipal

This class extends the JAASPrincipal class and represents the domain the user is currently logged onto.

Principals such as this DomainPrincipal may be associated with a particular Subject to augment that Subject with an additional identity. Refer to the Subject class for more information on how to achieve this. Authorization decisions can then be based upon the Principals associated with a Subject.

Author:
D. Kent Soper, Andrew Gotte
See Also:
Principal, Subject, Serialized Form

Constructor Summary
DomainPrincipal(java.lang.String name)
          Create an DomainPrincipal using a String representation of the domain.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compares the specified Object with this DomainPrincipal for equality.
 java.lang.String toString()
          Return a string representation of this DomainPrincipal.
 
Methods inherited from class com.ibm.security.auth.JAASPrincipal
getName, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DomainPrincipal

public DomainPrincipal(java.lang.String name)
Create an DomainPrincipal using a String representation of the domain.

Parameters:
name - the domain.

Throws:
java.lang.NullPointerException - if the domain is null.
java.lang.IllegalArgumentException - if the name has zero length.
Method Detail

toString

public java.lang.String toString()
Return a string representation of this DomainPrincipal.

Specified by:
toString in interface java.security.Principal
Overrides:
toString in class JAASPrincipal
Returns:
a string representation of this DomainPrincipal.

equals

public boolean equals(java.lang.Object o)
Compares the specified Object with this DomainPrincipal for equality. Returns true if the given object is also a DomainPrincipal and the two DomainPrincipals have the same domain.

Specified by:
equals in interface java.security.Principal
Overrides:
equals in class JAASPrincipal
Parameters:
o - Object to be compared for equality with this DomainPrincipal.
Returns:
true if the specified Object is equal to this DomainPrincipal.