public class

UnixNumericGroupPrincipal

extends Object
implements Serializable Principal
java.lang.Object
   ↳ com.sun.security.auth.UnixNumericGroupPrincipal

Class Overview

This class implements the Principal interface and represents a user's Unix group identification number (GID).

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

Summary

Public Constructors
UnixNumericGroupPrincipal(String name, boolean primaryGroup)
Create a UnixNumericGroupPrincipal using a String representation of the user's group identification number (GID).
UnixNumericGroupPrincipal(long name, boolean primaryGroup)
Create a UnixNumericGroupPrincipal using a long representation of the user's group identification number (GID).
Public Methods
boolean equals(Object o)
Compares the specified Object with this UnixNumericGroupPrincipal for equality.
String getName()
Return the user's group identification number (GID) for this UnixNumericGroupPrincipal.
int hashCode()
Return a hash code for this UnixNumericGroupPrincipal.
boolean isPrimaryGroup()
Return whether this group identification number (GID) represents the primary group to which this user belongs.
long longValue()
Return the user's group identification number (GID) for this UnixNumericGroupPrincipal as a long.
String toString()
Return a string representation of this UnixNumericGroupPrincipal.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.security.Principal

Public Constructors

public UnixNumericGroupPrincipal (String name, boolean primaryGroup)

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

Parameters
name the user's group identification number (GID) for this user.

primaryGroup true if the specified GID represents the primary group to which this user belongs.
Throws
NullPointerException if the name is null.

public UnixNumericGroupPrincipal (long name, boolean primaryGroup)

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

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

primaryGroup true if the specified GID represents the primary group to which this user belongs.

Public Methods

public boolean equals (Object o)

Compares the specified Object with this UnixNumericGroupPrincipal for equality. Returns true if the given object is also a UnixNumericGroupPrincipal and the two UnixNumericGroupPrincipals have the same group identification number (GID).

Parameters
o Object to be compared for equality with this UnixNumericGroupPrincipal.
Returns
  • true if the specified Object is equal equal to this UnixNumericGroupPrincipal.

public String getName ()

Return the user's group identification number (GID) for this UnixNumericGroupPrincipal.

Returns
  • the user's group identification number (GID) for this UnixNumericGroupPrincipal

public int hashCode ()

Return a hash code for this UnixNumericGroupPrincipal.

Returns
  • a hash code for this UnixNumericGroupPrincipal.

public boolean isPrimaryGroup ()

Return whether this group identification number (GID) represents the primary group to which this user belongs.

Returns
  • true if this group identification number (GID) represents the primary group to which this user belongs, or false otherwise.

public long longValue ()

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

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

public String toString ()

Return a string representation of this UnixNumericGroupPrincipal.

Returns
  • a string representation of this UnixNumericGroupPrincipal.