com.sun.gssapi

Interface GSSNameSpi

public interface GSSNameSpi

This class represents a mechanism specific name element. One or more instances of this class are contained in an instance of a GSSName object. Each GSSNameSpi object represents at most 1 mechanism specific name element.

Method Summary

Object
clone()
Produces a copy of this object.
boolean
equals(GSSNameSpi name)
Equal method for the GSSNameSpi objects.
byte[]
export()
Returns a flat name representation for this object.
Oid
getMech()
Get the mechanism type that this NameElement corresponds to.
Oid
getNameType()
Returns the name type oid for this name.
Oid
getStringNameType()
Returns the oid describing the format of the printable name.
void
init(String name, Oid nameType)
Initializer for the GSSNameSpi object using a String.
void
init(byte[] externalName, Oid nameType)
Initializer for the GSSNameSpi object using a byte array.
boolean
isAnonymousName()
Indicates if this name object represents an Anonymous name.
String
toString()
Returns a string representation for this name.

Method Details

clone

public Object clone()
Produces a copy of this object.

equals

public boolean equals(GSSNameSpi name)
            throws GSSException
Equal method for the GSSNameSpi objects. If either name denotes an anonymous principal, the call should return false.
Parameters:
name - to be compared with
Throws:
GSSException - with major codes of BAD_NAMETYPE, BAD_NAME, FAILURE

export

public byte[] export()
            throws GSSException
Returns a flat name representation for this object. The name format is defined in RFC 2078.
Returns:
the flat name representation for this object
Throws:
GSSException - with major codes NAME_NOT_MN, BAD_NAME, BAD_NAME, FAILURE.

getMech

public Oid getMech()
Get the mechanism type that this NameElement corresponds to.
Returns:
the Oid of the mechanism type

getNameType

public Oid getNameType()
Returns the name type oid for this name.
Returns:
the name type oid for this name

getStringNameType

public Oid getStringNameType()
Returns the oid describing the format of the printable name.
Returns:
the Oid for the format of the printed name

init

public void init(String name,
                 Oid nameType)
            throws GSSException
Initializer for the GSSNameSpi object using a String.
Parameters:
name - string which is to be interpreted based on the nameType
nameType - - oid representing the type of name supplied
Throws:
GSSException - The major codes can be BAD_NAMETYPE, BAD_NAME, and FAILURE.

init

public void init(byte[] externalName,
                 Oid nameType)
            throws GSSException
Initializer for the GSSNameSpi object using a byte array.
Parameters:
nameType - - oid representing the type of name supplied
Throws:
GSSException - The major codes can be BAD_NAMETYPE, BAD_NAME, and FAILURE.

isAnonymousName

public boolean isAnonymousName()
Indicates if this name object represents an Anonymous name.

toString

public String toString()
Returns a string representation for this name. The printed name type can be obtained by calling getStringNameType().
Returns:
string form of this name