public class

Realm

extends Object
implements Cloneable
java.lang.Object
   ↳ sun.security.krb5.Realm

Class Overview

Implements the ASN.1 Realm type.

Realm ::= GeneralString

Summary

Public Constructors
Realm(String name)
Realm(DerValue encoding)
Constructs a Realm object.
Public Methods
byte[] asn1Encode()
Encodes a Realm object.
Object clone()
Creates and returns a copy of this object.
boolean equals(Object obj)
Indicates whether some other object is "equal to" this one.
static String[] getRealmsList(String cRealm, String sRealm)
Returns an array of realms that may be traversed to obtain a TGT from the initiating realm cRealm to the target realm sRealm.
int hashCode()
Returns a hash code value for the object.
static Realm parse(DerInputStream data, byte explicitTag, boolean optional)
Parse (unmarshal) a realm from a DER input stream.
static String parseRealmAtSeparator(String name)
String toString()
Returns a string representation of the object.
Protected Methods
static boolean isValidRealmString(String name)
static String parseRealm(String name)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Realm (String name)

public Realm (DerValue encoding)

Constructs a Realm object.

Parameters
encoding a Der-encoded data.
Throws
Asn1Exception if an error occurs while decoding an ASN1 encoded data.
IOException if an I/O error occurs while reading encoded data.
RealmException if an error occurs while parsing a Realm object.

Public Methods

public byte[] asn1Encode ()

Encodes a Realm object.

Returns
  • the byte array of encoded KrbCredInfo 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 obj)

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
obj the reference object with which to compare.
Returns
  • true if this object is the same as the obj argument; false otherwise.

public static String[] getRealmsList (String cRealm, String sRealm)

Returns an array of realms that may be traversed to obtain a TGT from the initiating realm cRealm to the target realm sRealm.
There may be an arbitrary number of intermediate realms between cRealm and sRealm. The realms may be organized organized hierarchically, or the paths between them may be specified in the [capaths] stanza of the caller's Kerberos configuration file. The configuration file is consulted first. Then a hirarchical organization is assumed if no realms are found in the configuration file.
The returned list, if not null, contains cRealm as the first entry. sRealm is not included unless it is mistakenly listed in the configuration file as an intermediary realm.

Parameters
cRealm the initiating realm
sRealm the target realm
Throws
KrbException

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 static Realm parse (DerInputStream data, byte explicitTag, boolean optional)

Parse (unmarshal) a realm 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 Realm.

public static String parseRealmAtSeparator (String name)

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.

Protected Methods

protected static boolean isValidRealmString (String name)

protected static String parseRealm (String name)