com.ibm.security.auth

Class GroupIDPrincipal

java.lang.Object

com.ibm.security.auth.JAASPrincipal

com.ibm.security.auth.GroupIDPrincipal

All Implemented Interfaces:

java.io.Serializable, java.security.Principal

public class GroupIDPrincipal
extends JAASPrincipal

This class extends the JAASPrincipal class and represents a user's group identification (GID).

Principals such as this GroupIDPrincipal 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.

See Also:

Principal, Subject, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GroupIDPrincipal(long lname) Create an GroupIDPrincipal using a long representation of the user's group identification number (GID).
GroupIDPrincipal(java.lang.String name) Create a GroupIDPrincipal using a String representation of the user's group identification (GID).

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compares the specified Object with this GroupIDPrincipal for equality.
long	longValue() Return the user's group identification number (GID) for this GroupIDPrincipal as a long.
java.lang.String	toString() Return a string representation of this GroupIDPrincipal.

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

Methods inherited from interface java.security.Principal

implies

Constructor Detail

GroupIDPrincipal

public GroupIDPrincipal(java.lang.String name)

Create a GroupIDPrincipal using a String representation of the user's group identification (GID).

Parameters:

name - the user's group identification for this user.

Throws:

java.lang.NullPointerException - if the name is null.

java.lang.IllegalArgumentException - if the name has zero length.

GroupIDPrincipal

public GroupIDPrincipal(long lname)

Create an GroupIDPrincipal using a long representation of the user's group identification number (GID).

Parameters:

lname - the user's group identification number (GID) for this user represented as a long.

Method Detail

longValue

public long longValue()

Return the user's group identification number (GID) for this GroupIDPrincipal as a long.

Returns:

the user's group identification number (GID) for this GroupIDPrincipal as a long.

toString

public java.lang.String toString()

Return a string representation of this GroupIDPrincipal.

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class JAASPrincipal

Returns:

a string representation of this GroupIDPrincipal.

equals

public boolean equals(java.lang.Object o)

Compares the specified Object with this GroupIDPrincipal for equality. Returns true if the given object is also a GroupIDPrincipal and the two GroupIDPrincipals have the same group identification string.

Specified by:

equals in interface java.security.Principal

Overrides:

equals in class JAASPrincipal

Parameters:

o - Object to be compared for equality with this GroupIDPrincipal.

Returns:

true if the specified Object is equal to this GroupIDPrincipal.