Home » openjdk-7 » javax.security » auth » kerberos » [javadoc | source]
javax.security.auth.kerberos
public final class: KerberosPrincipal [javadoc | source]
java.lang.Object
   javax.security.auth.kerberos.KerberosPrincipal

All Implemented Interfaces:
    Principal, Serializable

This class encapsulates a Kerberos principal.
Field Summary
public static final  int KRB_NT_UNKNOWN    unknown name type. 
public static final  int KRB_NT_PRINCIPAL    user principal name type. 
public static final  int KRB_NT_SRV_INST    service and other unique instance (krbtgt) name type. 
public static final  int KRB_NT_SRV_HST    service with host name as instance (telnet, rcommands) name type. 
public static final  int KRB_NT_SRV_XHST    service with host as remaining components name type. 
public static final  int KRB_NT_UID    unique ID name type. 
Constructor:
 public KerberosPrincipal(String name) 
    Constructs a KerberosPrincipal from the provided string input. The name type for this principal defaults to KRB_NT_PRINCIPAL This string is assumed to contain a name in the format that is specified in Section 2.1.1. (Kerberos Principal Name Form) of RFC 1964 (for example, duke@FOO.COM, where duke represents a principal, and FOO.COM represents a realm).

    If the input name does not contain a realm, the default realm is used. The default realm can be specified either in a Kerberos configuration file or via the java.security.krb5.realm system property. For more information, Kerberos Requirements

    Parameters:
    name - the principal name
    Throws:
    IllegalArgumentException - if name is improperly formatted, if name is null, or if name does not contain the realm to use and the default realm is not specified in either a Kerberos configuration file or via the java.security.krb5.realm system property.
 public KerberosPrincipal(String name,
    int nameType) 
    Constructs a KerberosPrincipal from the provided string and name type input. The string is assumed to contain a name in the format that is specified in Section 2.1 (Mandatory Name Forms) of RFC 1964. Valid name types are specified in Section 6.2 (Principal Names) of RFC 4120. The input name must be consistent with the provided name type. (for example, duke@FOO.COM, is a valid input string for the name type, KRB_NT_PRINCIPAL where duke represents a principal, and FOO.COM represents a realm).

    If the input name does not contain a realm, the default realm is used. The default realm can be specified either in a Kerberos configuration file or via the java.security.krb5.realm system property. For more information, see Kerberos Requirements.

    Parameters:
    name - the principal name
    nameType - the name type of the principal
    Throws:
    IllegalArgumentException - if name is improperly formatted, if name is null, if the nameType is not supported, or if name does not contain the realm to use and the default realm is not specified in either a Kerberos configuration file or via the java.security.krb5.realm system property.
Method from javax.security.auth.kerberos.KerberosPrincipal Summary:
equals,   getName,   getNameType,   getRealm,   hashCode,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.security.auth.kerberos.KerberosPrincipal Detail:
 public boolean equals(Object other) 
    Compares the specified Object with this Principal for equality. Returns true if the given object is also a KerberosPrincipal and the two KerberosPrincipal instances are equivalent. More formally two KerberosPrincipal instances are equal if the values returned by getName() are equal and the values returned by getNameType() are equal.
 public String getName() 
    The returned string corresponds to the single-string representation of a Kerberos Principal name as specified in Section 2.1 of RFC 1964.
 public int getNameType() 
    Returns the name type of the KerberosPrincipal. Valid name types are specified in Section 6.2 of RFC4120.
 public String getRealm() 
    Returns the realm component of this Kerberos principal.
 public int hashCode() 
    Returns a hashcode for this principal. The hash code is defined to be the result of the following calculation:
    
     hashCode = getName().hashCode();
    
 public String toString()