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

UnixPrincipal

public class UnixPrincipal extends Object implements Principal, Serializable

This class implements the Principal interface and represents a Unix user.

Principals such as this UnixPrincipal 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
Constructors Summary
public UnixPrincipal(String name)
Create a UnixPrincipal with a Unix username.

param
name the Unix username for this user.
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;
Methods Summary
public booleanequals(java.lang.Object o)
Compares the specified Object with this UnixPrincipal for equality. Returns true if the given object is also a UnixPrincipal and the two UnixPrincipals have the same username.

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

	if (o == null)
	    return false;

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

	if (this.getName().equals(that.getName()))
	    return true;
	return false;
public java.lang.StringgetName()
Return the Unix username for this UnixPrincipal.

return
the Unix username for this UnixPrincipal

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

return
a hash code for this UnixPrincipal.

	return name.hashCode();
public java.lang.StringtoString()
Return a string representation of this UnixPrincipal.

return
a string representation of this UnixPrincipal.

	java.text.MessageFormat form = new java.text.MessageFormat
		(sun.security.util.ResourcesMgr.getString
			("UnixPrincipal: name",
			"sun.security.util.AuthResources"));
	Object[] source = {name};
	return form.format(source);