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

NTDomainPrincipal

public class NTDomainPrincipal extends Object implements Principal, Serializable

This class implements the Principal interface and represents the name of the Windows NT domain into which the user authenticated. This will be a domain name if the user logged into a Windows NT domain, a workgroup name if the user logged into a workgroup, or a machine name if the user logged into a standalone configuration.

Principals such as this NTDomainPrincipal 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.14, 12/19/03
see
java.security.Principal
see
javax.security.auth.Subject

Fields Summary
private static final long
serialVersionUID
private String
name
Constructors Summary
public NTDomainPrincipal(String name)
Create an NTDomainPrincipal with a Windows NT domain name.

param
name the Windows NT domain name 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 NTDomainPrincipal for equality. Returns true if the given object is also a NTDomainPrincipal and the two NTDomainPrincipals have the same name.

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

    	if (o == null)
	        return false;

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

	    if (name.equals(that.getName()))
	        return true;
	    return false;
    
public java.lang.StringgetName()
Return the Windows NT domain name for this NTDomainPrincipal.

return
the Windows NT domain name for this NTDomainPrincipal

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

return
a hash code for this NTDomainPrincipal.

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

return
a string representation of this NTDomainPrincipal.

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