OpenJDK 27 · sun.security.krb5.PrincipalName · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public static final int	KRB_NT_ENTERPRISE Enterprise name (alias)
public static final int	KRB_NT_PRINCIPAL Just the name of the principal as in DCE, or for users
public static final int	KRB_NT_SRV_HST Service with host name as instance (telnet, rcommands)
public static final int	KRB_NT_SRV_INST Service and other unique instance (krbtgt)
public static final int	KRB_NT_SRV_XHST Service with host as remaining components
public static final int	KRB_NT_UID Unique ID
public static final int	KRB_NT_UNKNOWN Name type not known
private static final boolean	NAME_CASE_SENSITIVE_IN_MATCH
public static final char	NAME_COMPONENT_SEPARATOR
public static final String	NAME_COMPONENT_SEPARATOR_STR
public static final char	NAME_REALM_SEPARATOR
public static final String	NAME_REALM_SEPARATOR_STR
private static final long	NAME_STRINGS_OFFSET
private final Realm	nameRealm The realm this principal belongs to.
private final String[]	nameStrings The name strings, from PrincipalName's name-strings field.
private final int	nameType The name type, from PrincipalName's name-type field.
public static final char	REALM_COMPONENT_SEPARATOR
private transient String	salt
public static final String	TGS_DEFAULT_SRV_NAME TGS Name
private static final Unsafe	UNSAFE

Constructor Summary

Access	Constructor and Description
public	PrincipalName(int nameType, String[] nameStrings, Realm nameRealm) Creates a PrincipalName.
public	PrincipalName(String[] nameParts, String realm)
public	PrincipalName(DerValue DER-encoded PrincipalName (without Realm) encoding, Realm the realm for this name realm) Returns the ASN.1 encoding of the `PrincipalName ::= SEQUENCE { name-type [0] Int32, name-string [1] SEQUENCE OF KerberosString } KerberosString ::= GeneralString (IA5String)`
public	PrincipalName(String the name name, int the type type, String the realm, null if not known. Note that when realm is not null, it will be always used even if there is a realm part in name. When realm is null, will read realm part from name, or try to map a realm (for KRB_NT_SRV_HST), or use the default realm, or fail realm) Constructs a PrincipalName from a string.
public	PrincipalName(String name, int type)
public	PrincipalName(String name)
public	PrincipalName(String name, String realm)

Method Summary

Modifier and Type	Method and Description
public byte[]	Returns: the byte array of the encoded PrncipalName object. asn1Encode() Encodes a `PrincipalName` object.
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: instance component of a multi-component name. getInstanceComponent() Returns the instance component of a 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() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv static String	mapHostToRealm(String name)
public boolean	Returns: true if two have identical values, otherwise, return false. match(PrincipalName the other `PrincipalName` object. pname) Checks if two `PrincipalName` objects have identical values in their corresponding data fields.
public static PrincipalName	Returns: an instance of `PrincipalName`, or null if the field is optional and missing. parse(DerInputStream the Der input stream value, which contains one or more marshaled value. data, byte tag number. explicitTag, boolean indicate if this data field is optional optional, Realm the realm for the name realm) Parse (unmarshal) a `PrincipalName` from a DER input stream.
private static String[]	parseName(String name)
public static PrincipalName	tgsService(String r1, String r2)
public byte[][]	toByteArray()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private static void	validateNameStrings(String[] ns)
public void	writePrincipal(CCacheOutputStream a `CCacheOutputStream` for writing data. cos) Writes data field values of `PrincipalName` in FCC format to an output stream.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

Field Detail

KRB_NT_ENTERPRISE	back to summary
public static final int KRB_NT_ENTERPRISE Enterprise name (alias)

KRB_NT_PRINCIPAL	back to summary
public static final int KRB_NT_PRINCIPAL Just the name of the principal as in DCE, or for users

KRB_NT_SRV_HST	back to summary
public static final int KRB_NT_SRV_HST Service with host name as instance (telnet, rcommands)

KRB_NT_SRV_INST	back to summary
public static final int KRB_NT_SRV_INST Service and other unique instance (krbtgt)

KRB_NT_SRV_XHST	back to summary
public static final int KRB_NT_SRV_XHST Service with host as remaining components

KRB_NT_UID	back to summary
public static final int KRB_NT_UID Unique ID

KRB_NT_UNKNOWN	back to summary
public static final int KRB_NT_UNKNOWN Name type not known

NAME_CASE_SENSITIVE_IN_MATCH	back to summary
private static final boolean NAME_CASE_SENSITIVE_IN_MATCH

NAME_COMPONENT_SEPARATOR	back to summary
public static final char NAME_COMPONENT_SEPARATOR

NAME_COMPONENT_SEPARATOR_STR	back to summary
public static final String NAME_COMPONENT_SEPARATOR_STR

NAME_REALM_SEPARATOR	back to summary
public static final char NAME_REALM_SEPARATOR

NAME_REALM_SEPARATOR_STR	back to summary
public static final String NAME_REALM_SEPARATOR_STR

NAME_STRINGS_OFFSET	back to summary
private static final long NAME_STRINGS_OFFSET

nameRealm	back to summary
private final Realm nameRealm The realm this principal belongs to.

nameStrings	back to summary
private final String[] nameStrings The name strings, from PrincipalName's name-strings field. This field must be neither null nor empty. Each entry of it must also be neither null nor empty. Make sure to clone the field when it's passed in or out.

nameType	back to summary
private final int nameType The name type, from PrincipalName's name-type field.

REALM_COMPONENT_SEPARATOR	back to summary
public static final char REALM_COMPONENT_SEPARATOR

salt	back to summary
private transient String salt

TGS_DEFAULT_SRV_NAME	back to summary
public static final String TGS_DEFAULT_SRV_NAME TGS Name

UNSAFE	back to summary
private static final Unsafe UNSAFE

Constructor Detail

PrincipalName	back to summary
public PrincipalName(int nameType, String[] nameStrings, Realm nameRealm) Creates a PrincipalName.

PrincipalName	back to summary
public PrincipalName(String[] nameParts, String realm) throws RealmException

PrincipalName back to summary

PrincipalName	back to summary
public PrincipalName(DerValue encoding, Realm realm) throws Asn1Exception, IOException 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:DerValue DER-encoded PrincipalName (without Realm) realm:Realm the realm for this name Exceptions Asn1Exception: if an error occurs while decoding an ASN1 encoded data. if there is an ASN1 encoding error IOException: if an I/O error occurs IllegalArgumentException: if encoding is null reading encoded data.

public PrincipalName(DerValue encoding, Realm realm) throws Asn1Exception, IOException

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:DerValue: DER-encoded PrincipalName (without Realm)
realm:Realm: the realm for this name

Exceptions

Asn1Exception:

if an error occurs while decoding an ASN1 encoded data.
if there is an ASN1 encoding error

IOException:

if an I/O error occurs

IllegalArgumentException:

if encoding is null reading encoded data.

PrincipalName	back to summary
public PrincipalName(String name, int type, String realm) throws RealmException Constructs a PrincipalName from a string. Parameters name:String the name type:int the type realm:String the realm, null if not known. Note that when realm is not null, it will be always used even if there is a realm part in name. When realm is null, will read realm part from name, or try to map a realm (for KRB_NT_SRV_HST), or use the default realm, or fail

PrincipalName

back to summary

public PrincipalName(String name, int type, String realm) throws RealmException

Constructs a PrincipalName from a string.

Parameters

name:String: the name
type:int: the type
realm:String: the realm, null if not known. Note that when realm is not null, it will be always used even if there is a realm part in name. When realm is null, will read realm part from name, or try to map a realm (for KRB_NT_SRV_HST), or use the default realm, or fail

PrincipalName	back to summary
public PrincipalName(String name, int type) throws RealmException

PrincipalName	back to summary
public PrincipalName(String name) throws RealmException

PrincipalName	back to summary
public PrincipalName(String name, String realm) throws RealmException

Method Detail

asn1Encode back to summary

asn1Encode	back to summary
public byte[] asn1Encode() throws Asn1Exception, IOException Encodes a `PrincipalName` object. Note that only the type and names are encoded. To encode the realm, call getRealm().asn1Encode(). Returns:byte[] the byte array of the encoded PrncipalName object. Exceptions Asn1Exception: if an error occurs while decoding an ASN1 encoded data. IOException: if an I/O error occurs while reading encoded data.

public byte[] asn1Encode() throws Asn1Exception, IOException

Encodes a PrincipalName object. Note that only the type and names are encoded. To encode the realm, call getRealm().asn1Encode().

Returns:byte[]

the byte array of the encoded PrncipalName object.

Exceptions

Asn1Exception:: if an error occurs while decoding an ASN1 encoded data.
IOException:: if an I/O error occurs while reading encoded data.

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Doc from java.lang.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.

public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.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.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. 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`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getInstanceComponent	back to summary
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. Returns:String instance component of a multi-component name.

getInstanceComponent

back to summary

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.

Returns:String: instance component of a multi-component name.

getName	back to summary
public String getName()

getNameString	back to summary
public String getNameString()

getNameStrings	back to summary
public String[] getNameStrings()

getNameType	back to summary
public int getNameType()

getPrincipalNameAsString	back to summary
public String getPrincipalNameAsString()

getRealm	back to summary
public Realm getRealm()

getRealmAsString	back to summary
public String getRealmAsString()

getRealmString	back to summary
public String getRealmString()

getSalt	back to summary
public String getSalt()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. 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` 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` 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 hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

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

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 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 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 hash tables.

Annotations

@Override

mapHostToRealm	back to summary
pack-priv static String mapHostToRealm(String name)

match back to summary

match	back to summary
public boolean match(PrincipalName pname) Checks if two `PrincipalName` objects have identical values in their corresponding data fields. If `jdk.security.krb5.name.case.sensitive` is set to true, the name comparison is case-sensitive. Otherwise, it's case-insensitive. It is used in `sun.security.krb5.internal.ccache.FileCredentialsCache` and `sun.security.krb5.internal.ktab.KeyTab` to retrieve ccache or keytab entry for a principal. Parameters pname:PrincipalName the other `PrincipalName` object. Returns:boolean true if two have identical values, otherwise, return false.

public boolean match(PrincipalName pname)

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

If jdk.security.krb5.name.case.sensitive is set to true, the name comparison is case-sensitive. Otherwise, it's case-insensitive.

It is used in sun.security.krb5.internal.ccache.FileCredentialsCache and sun.security.krb5.internal.ktab.KeyTab to retrieve ccache or keytab entry for a principal.

Parameters

pname:PrincipalName: the other PrincipalName object.

Returns:boolean

true if two have identical values, otherwise, return false.

parse back to summary

parse	back to summary
public static PrincipalName parse(DerInputStream data, byte explicitTag, boolean optional, Realm realm) throws Asn1Exception, IOException, RealmException 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:DerInputStream the Der input stream value, which contains one or more marshaled value. explicitTag:byte tag number. optional:boolean indicate if this data field is optional realm:Realm the realm for the name Returns:PrincipalName an instance of `PrincipalName`, or null if the field is optional and missing. Exceptions Asn1Exception: on error.

public static PrincipalName parse(DerInputStream data, byte explicitTag, boolean optional, Realm realm) throws Asn1Exception, IOException, RealmException

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:DerInputStream: the Der input stream value, which contains one or more marshaled value.
explicitTag:byte: tag number.
optional:boolean: indicate if this data field is optional
realm:Realm: the realm for the name

Returns:PrincipalName

an instance of PrincipalName, or null if the field is optional and missing.

Exceptions

Asn1Exception:: on error.

parseName	back to summary
private static String[] parseName(String name)

tgsService	back to summary
public static PrincipalName tgsService(String r1, String r2) throws KrbException

toByteArray	back to summary
public byte[][] toByteArray()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

validateNameStrings	back to summary
private static void validateNameStrings(String[] ns)

writePrincipal back to summary

public void writePrincipal(CCacheOutputStream cos) throws IOException

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

Parameters

cos:CCacheOutputStream: a CCacheOutputStream for writing data.

Exceptions

IOException:: if an I/O exception occurs.

public Class PrincipalName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail