public class

PrincipalName

extends Object
implements Cloneable
java.lang.Object
   ↳ sun.security.krb5.PrincipalName
Known Direct Subclasses

Class Overview

This class encapsulates a Kerberos principal.

Summary

Constants
int KRB_NT_PRINCIPAL Just the name of the principal as in DCE, or for users
int KRB_NT_SRV_HST Service with host name as instance (telnet, rcommands)
int KRB_NT_SRV_INST Service and other unique instance (krbtgt)
int KRB_NT_SRV_XHST Service with host as remaining components
int KRB_NT_UID Unique ID
int KRB_NT_UNKNOWN Name type not known
char NAME_COMPONENT_SEPARATOR
String NAME_COMPONENT_SEPARATOR_STR
char NAME_REALM_SEPARATOR
String NAME_REALM_SEPARATOR_STR
char REALM_COMPONENT_SEPARATOR
String REALM_COMPONENT_SEPARATOR_STR
int TGS_DEFAULT_NT
String TGS_DEFAULT_SRV_NAME TGS Name
Public Constructors
PrincipalName(String[] nameParts, int type)
PrincipalName(String[] nameParts)
PrincipalName(DerValue encoding)
Returns the ASN.1 encoding of the PrincipalName ::= SEQUENCE { name-type [0] Int32, name-string [1] SEQUENCE OF KerberosString } KerberosString ::= GeneralString (IA5String)

This definition reflects the Network Working Group RFC 4120 specification available at http://www.ietf.org/rfc/rfc4120.txt.

PrincipalName(String name, int type)
PrincipalName(String name)
PrincipalName(String name, String realm)
Protected Constructors
PrincipalName()
PrincipalName(String primary, String instance, String realm, int type)
Creates a KRB_NT_SRV_INST name from the supplied name components and realm.
Public Methods
byte[] asn1Encode()
Encodes a PrincipalName object.
Object clone()
Creates and returns a copy of this object.
boolean equals(Object o)
Indicates whether some other object is "equal to" this one.
boolean equals(PrincipalName other)
String getInstanceComponent()
Returns the instance component of a name.
String getName()
String getNameString()
String[] getNameStrings()
int getNameType()
String getPrincipalNameAsString()
Realm getRealm()
String getRealmAsString()
String getRealmString()
String getSalt()
int hashCode()
Returns a hash code value for the object.
boolean match(PrincipalName pname)
Checks if two PrincipalName objects have identical values in their corresponding data fields.
static PrincipalName parse(DerInputStream data, byte explicitTag, boolean optional)
Parse (unmarshal) a PrincipalName from a DER input stream.
void setRealm(String realmsString)
void setRealm(Realm new_nameRealm)
void setSalt(String salt)
byte[][] toByteArray()
String toString()
Returns a string representation of the object.
void writePrincipal(CCacheOutputStream cos)
Writes data field values of PrincipalName in FCC format to an output stream.
Protected Methods
static String[] parseName(String name)
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int KRB_NT_PRINCIPAL

Just the name of the principal as in DCE, or for users

Constant Value: 1 (0x00000001)

public static final int KRB_NT_SRV_HST

Service with host name as instance (telnet, rcommands)

Constant Value: 3 (0x00000003)

public static final int KRB_NT_SRV_INST

Service and other unique instance (krbtgt)

Constant Value: 2 (0x00000002)

public static final int KRB_NT_SRV_XHST

Service with host as remaining components

Constant Value: 4 (0x00000004)

public static final int KRB_NT_UID

Unique ID

Constant Value: 5 (0x00000005)

public static final int KRB_NT_UNKNOWN

Name type not known

Constant Value: 0 (0x00000000)

public static final char NAME_COMPONENT_SEPARATOR

Constant Value: 47 (0x0000002f)

public static final String NAME_COMPONENT_SEPARATOR_STR

Constant Value: "/"

public static final char NAME_REALM_SEPARATOR

Constant Value: 64 (0x00000040)

public static final String NAME_REALM_SEPARATOR_STR

Constant Value: "@"

public static final char REALM_COMPONENT_SEPARATOR

Constant Value: 46 (0x0000002e)

public static final String REALM_COMPONENT_SEPARATOR_STR

Constant Value: "."

public static final int TGS_DEFAULT_NT

Constant Value: 2 (0x00000002)

public static final String TGS_DEFAULT_SRV_NAME

TGS Name

Constant Value: "krbtgt"

Public Constructors

public PrincipalName (String[] nameParts, int type)

public PrincipalName (String[] nameParts)

Throws
IOException

public PrincipalName (DerValue encoding)

Returns the ASN.1 encoding of the

PrincipalName ::= SEQUENCE { name-type [0] Int32, name-string [1] SEQUENCE OF KerberosString } KerberosString ::= GeneralString (IA5String)

This definition reflects the Network Working Group RFC 4120 specification available at http://www.ietf.org/rfc/rfc4120.txt.

Parameters
encoding a Der-encoded data.
Throws
Asn1Exception if an error occurs while decoding an ASN1 encoded data.
Asn1Exception if there is an ASN1 encoding error
IOException if an I/O error occurs
IllegalArgumentException if encoding is null reading encoded data.

public PrincipalName (String name, int type)

public PrincipalName (String name)

public PrincipalName (String name, String realm)

Protected Constructors

protected PrincipalName ()

protected PrincipalName (String primary, String instance, String realm, int type)

Creates a KRB_NT_SRV_INST name from the supplied name components and realm.

Parameters
primary the primary component of the name
instance the instance component of the name
realm the realm
Throws
KrbException

Public Methods

public byte[] asn1Encode ()

Encodes a PrincipalName object.

Returns
  • the byte array of the encoded PrncipalName object.
Throws
Asn1Exception if an error occurs while decoding an ASN1 encoded data.
IOException if an I/O error occurs while reading encoded data.

public Object clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x
will be true, and that the expression:
 x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
 x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Returns
  • a clone of this instance.

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o the reference object with which to compare.
Returns
  • true if this object is the same as the obj argument; false otherwise.

public boolean equals (PrincipalName other)

public String getInstanceComponent ()

Returns the instance component of a name. In a multi-component name such as a KRB_NT_SRV_INST name, the second component is returned. Null is returned if there are not two or more components in the name.

public String getName ()

public String getNameString ()

public String[] getNameStrings ()

public int getNameType ()

public String getPrincipalNameAsString ()

public Realm getRealm ()

public String getRealmAsString ()

public String getRealmString ()

public String getSalt ()

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
  • a hash code value for this object.

public boolean match (PrincipalName pname)

Checks if two PrincipalName objects have identical values in their corresponding data fields.

Parameters
pname the other PrincipalName object.
Returns
  • true if two have identical values, otherwise, return false.

public static PrincipalName parse (DerInputStream data, byte explicitTag, boolean optional)

Parse (unmarshal) a PrincipalName from a DER input stream. This form parsing might be used when expanding a value which is part of a constructed sequence and uses explicitly tagged type.

Parameters
data the Der input stream value, which contains one or more marshaled value.
explicitTag tag number.
optional indicate if this data field is optional
Returns
  • an instance of PrincipalName.
Throws
Asn1Exception on error.
IOException

public void setRealm (String realmsString)

public void setRealm (Realm new_nameRealm)

public void setSalt (String salt)

public byte[][] toByteArray ()

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
  • a string representation of the object.

public void writePrincipal (CCacheOutputStream cos)

Writes data field values of PrincipalName in FCC format to an output stream.

Parameters
cos a CCacheOutputStream for writing data.
Throws
IOException if an I/O exception occurs.
See Also
  • sun.security.krb5.internal.ccache.CCacheOutputStream

Protected Methods

protected static String[] parseName (String name)