FileDocCategorySizeDatePackage
UnixNumericGroupPrincipal.javaAPI DocJava SE 5 API5905Fri Aug 26 14:56:14 BST 2005com.sun.security.auth

UnixNumericGroupPrincipal

public class UnixNumericGroupPrincipal extends Object implements Principal, Serializable

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.

version
1.8, 01/14/00
see
java.security.Principal
see
javax.security.auth.Subject

Fields Summary
private static final long
serialVersionUID
private String
name
private boolean
primaryGroup
Constructors Summary
public UnixNumericGroupPrincipal(String name, boolean primaryGroup)
Create a UnixNumericGroupPrincipal using a String representation of the user's group identification number (GID).

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

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


                           			            			           			      
         
	if (name == null) {
	    java.text.MessageFormat form = new java.text.MessageFormat
		(sun.security.util.ResourcesMgr.getString
			("invalid null input: value",
			"sun.security.util.AuthResources"));
	    Object[] source = {"name"};
	    throw new NullPointerException(form.format(source));
	}

	this.name = name;
	this.primaryGroup = primaryGroup;
    
public UnixNumericGroupPrincipal(long name, boolean primaryGroup)
Create a UnixNumericGroupPrincipal using a long representation of the user's group identification number (GID).

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

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

	this.name = (new Long(name)).toString();
	this.primaryGroup = primaryGroup;
    
Methods Summary
public booleanequals(java.lang.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).

param
o Object to be compared for equality with this UnixNumericGroupPrincipal.
return
true if the specified Object is equal equal to this UnixNumericGroupPrincipal.

	if (o == null)
	    return false;

        if (this == o)
            return true;
 
        if (!(o instanceof UnixNumericGroupPrincipal))
            return false;
        UnixNumericGroupPrincipal that = (UnixNumericGroupPrincipal)o;

	if (this.getName().equals(that.getName()) &&
	    this.isPrimaryGroup() == that.isPrimaryGroup())
	    return true;
	return false;
    
public java.lang.StringgetName()
Return the user's group identification number (GID) for this UnixNumericGroupPrincipal.

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

	return name;
    
public inthashCode()
Return a hash code for this UnixNumericGroupPrincipal.

return
a hash code for this UnixNumericGroupPrincipal.

	return toString().hashCode();
    
public booleanisPrimaryGroup()
Return whether this group identification number (GID) represents the primary group to which this user belongs.

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

	return primaryGroup;
    
public longlongValue()
Return the user's group identification number (GID) for this UnixNumericGroupPrincipal as a long.

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

	return ((new Long(name)).longValue());
    
public java.lang.StringtoString()
Return a string representation of this UnixNumericGroupPrincipal.

return
a string representation of this UnixNumericGroupPrincipal.


	if (primaryGroup) {
	    java.text.MessageFormat form = new java.text.MessageFormat
		(sun.security.util.ResourcesMgr.getString
			("UnixNumericGroupPrincipal [Primary Group]: name",
			"sun.security.util.AuthResources"));
	    Object[] source = {name};
	    return form.format(source);
	} else {
	    java.text.MessageFormat form = new java.text.MessageFormat
		(sun.security.util.ResourcesMgr.getString
		    ("UnixNumericGroupPrincipal [Supplementary Group]: name",
		    "sun.security.util.AuthResources"));
	    Object[] source = {name};
	    return form.format(source);
	}