com.ibm.security.auth
Class WkstationPrincipal

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

public class WkstationPrincipal
extends JAASPrincipal

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

Principals such as this WkstationPrincipal 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
WkstationPrincipal(java.lang.String name)
          Create an WkstationPrincipal using a String representation of the workstation name.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compares the specified Object with this WkstationPrincipal for equality.
 java.lang.String toString()
          Return a string representation of this WkstationPrincipal.
 
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

WkstationPrincipal

public WkstationPrincipal(java.lang.String name)
Create an WkstationPrincipal using a String representation of the workstation name.

Parameters:
name - the name of the workstation.

Throws:
java.lang.NullPointerException - if the name 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 WkstationPrincipal.

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

equals

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

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