GSSName JDK 1.6)

Description

public interface GSSName

This interface encapsulates a single GSS-API principal entity.

This interface encapsulates a single GSS-API principal entity. The application obtains an implementation of this interface through one of the createName methods that exist in the GSSManager class. Conceptually a GSSName contains many representations of the entity or many primitive name elements, one for each supported underlying mechanism. In GSS terminology, a GSSName that contains an element from just one mechanism is called a Mechanism Name (MN)

Since different authentication mechanisms may employ different namespaces for identifying their principals, GSS-API's naming support is necessarily complex in multi-mechanism environments (or even in some single-mechanism environments where the underlying mechanism supports multiple namespaces). Different name formats and their definitions are identified with Oid's and some standard types are defind in this interface. The format of the names can be derived based on the unique Oid of its name type.

Included below are code examples utilizing the GSSName interface. The code below creates a GSSName, converts it to an MN, performs a comparison, obtains a printable representation of the name, exports it to a byte array and then re-imports to obtain a new GSSName.

      GSSManager manager = GSSManager.getInstance();

      // create a host based service name
      GSSName name = manager.createName("service@host",
                   GSSName.NT_HOSTBASED_SERVICE);

      Oid krb5 = new Oid("1.2.840.113554.1.2.2");

      GSSName mechName = name.canonicalize(krb5);
   
      // the above two steps are equivalent to the following
      GSSName mechName = manager.createName("service@host",
                      GSSName.NT_HOSTBASED_SERVICE, krb5);
   
      // perform name comparison
      if (name.equals(mechName))
              print("Names are equals.");
   
      // obtain textual representation of name and its printable
      // name type
      print(mechName.toString() +
                      mechName.getStringNameType().toString());
   
      // export and re-import the name
      byte [] exportName = mechName.export();
   
      // create a new name object from the exported buffer
      GSSName newName = manager.createName(exportName,
                      GSSName.NT_EXPORT_NAME);

See also: GSSName.export() GSSName.equals(GSSName) GSSManager.createName(String, Oid) GSSManager.createName(String, Oid, Oid) GSSManager.createName(byte[], Oid)

Methods

Hide/Show inherited methods

public GSSName canonicalize (Oid mech) throws GSSException

Creates a name that is canonicalized for some mechanism.

Creates a name that is canonicalized for some
mechanism.
Returns: a GSSName that contains just one primitive element representing this name in a canonicalized form for the desired mechanism.
Parameters:
- mech - the oid for the mechanism for which the canonical form of the name is requested.
Throws:
- GSSException - containing the following major error codes: {@link GSSException#BAD_MECH GSSException.BAD_MECH}, {@link GSSException#BAD_NAMETYPE GSSException.BAD_NAMETYPE}, {@link GSSException#BAD_NAME GSSException.BAD_NAME}, {@link GSSException#FAILURE GSSException.FAILURE}

public boolean equals (GSSName another) throws GSSException

Compares two GSSName objects to determine if they refer to the same entity.

Compares two GSSName objects to determine if they refer to the
same entity.
Returns: true if the two names contain at least one primitive element in common. If either of the names represents an anonymous entity, the method will return false.
Parameters:
- another - the GSSName to compare this name with
Throws:
- GSSException - when the names cannot be compared, containing the following major error codes: {@link GSSException#BAD_NAMETYPE GSSException.BAD_NAMETYPE}, {@link GSSException#FAILURE GSSException.FAILURE}

public boolean equals (Object another)

Compares this GSSName object to another Object that might be a GSSName.

Compares this GSSName object to another Object that might be a
GSSName. The behaviour is exactly the same as in equals except that no GSSException is thrown;
instead, false will be returned in the situation where an error
occurs.
Returns: true if the object to compare to is also a GSSName and the two names refer to the same entity.
Parameters:
- another - the object to compare this name to
See Also: GSSName.equals(GSSName),

public byte export () throws GSSException

Returns a canonical contiguous byte representation of a mechanism name (MN), suitable for direct, byte by byte comparison by authorization functions.

public Oid getStringNameType () throws GSSException

Returns the name type of the printable representation of this name that can be obtained from the


 toString

method.

Returns the name type of the printable
representation of this name that can be obtained from the


 toString

method.
Returns: an Oid representing the namespace of the name returned from the toString method.
Throws:
- GSSException - containing the following major error codes: {@link GSSException#FAILURE GSSException.FAILURE}

public int hashCode ()

Returns a hashcode value for this GSSName.

public boolean isAnonymous ()

Tests if this name object represents an anonymous entity.

public boolean isMN ()

Tests if this name object represents a Mechanism Name (MN).

public String toString ()

Returns a textual representation of the GSSName object.

Returns a textual representation of the GSSName object. To retrieve
the printed name format, which determines the syntax of the returned
string, use the getStringNameType
method.
Returns: a String representing this name in printable form.

Fields

Hide/Show inherited fields

publicfinalstatic Oid NT_ANONYMOUS

Name type for representing an anonymous entity.

publicfinalstatic Oid NT_EXPORT_NAME

Name type used to indicate an exported name produced by the export method.

publicfinalstatic Oid NT_HOSTBASED_SERVICE

Oid indicating a host-based service name form.

publicfinalstatic Oid NT_MACHINE_UID_NAME

Name type to indicate a numeric user identifier corresponding to a user on a local system.

publicfinalstatic Oid NT_STRING_UID_NAME

Name type to indicate a string of digits representing the numeric user identifier of a user on a local system.

publicfinalstatic Oid NT_USER_NAME

Name type to indicate a named user on a local system.