com.ibm.security.auth

Class PrimaryGroupIDPrincipal

java.lang.Object

com.ibm.security.auth.JAASPrincipal

com.ibm.security.auth.PrimaryGroupIDPrincipal

All Implemented Interfaces:

java.io.Serializable, java.security.Principal

public class PrimaryGroupIDPrincipal
extends JAASPrincipal

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

Principals such as this PrimaryGroupIDPrincipal 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
PrimaryGroupIDPrincipal(long lname) Create an PrimaryGroupIDPrincipal using a long representation of the user's primary group identification number (GID).
PrimaryGroupIDPrincipal(java.lang.String name) Create a PrimaryGroupIDPrincipal using a String representation of the user's primary group identification.

Method Summary

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

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

PrimaryGroupIDPrincipal

public PrimaryGroupIDPrincipal(java.lang.String name)

Create a PrimaryGroupIDPrincipal using a String representation of the user's primary group identification.

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.

PrimaryGroupIDPrincipal

public PrimaryGroupIDPrincipal(long lname)

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

Parameters:

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

Method Detail

longValue

public long longValue()

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

Returns:

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

toString

public java.lang.String toString()

Return a string representation of this PrimaryGroupIDPrincipal.

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class JAASPrincipal

Returns:

a string representation of this PrimaryGroupIDPrincipal.

equals

public boolean equals(java.lang.Object o)

Compares the specified Object with this PrimaryGroupIDPrincipal for equality. Returns true if the given object is also a PrimaryGroupIDPrincipal and the two PrimaryGroupIDPrincipals 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 PrimaryGroupIDPrincipal.

Returns:

true if the specified Object is equal to this PrimaryGroupIDPrincipal.