public class

Oid

extends Object
java.lang.Object
   ↳ org.ietf.jgss.Oid

Class Overview

This class represents Universal Object Identifiers (Oids) and their associated operations.

Oids are hierarchically globally-interpretable identifiers used within the GSS-API framework to identify mechanisms and name formats.

The structure and encoding of Oids is defined in ISOIEC-8824 and ISOIEC-8825. For example the Oid representation of Kerberos V5 mechanism is "1.2.840.113554.1.2.2"

The GSSName name class contains public static Oid objects representing the standard name types defined in GSS-API.

Summary

Public Constructors
Oid(String strOid)
Constructs an Oid object from a string representation of its integer components.
Oid(InputStream derOid)
Creates an Oid object from its ASN.1 DER encoding.
Oid(byte[] data)
Creates an Oid object from its ASN.1 DER encoding.
Public Methods
boolean containedIn(Oid[] oids)
A utility method to test if this Oid value is contained within the supplied Oid array.
boolean equals(Object other)
Tests if two Oid objects represent the same Object identifier value.
byte[] getDER()
Returns the full ASN.1 DER encoding for this oid object, which includes the tag and length.
int hashCode()
Returns a hashcode value for this Oid.
String toString()
Returns a string representation of the oid's integer components in dot separated notation.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Oid (String strOid)

Constructs an Oid object from a string representation of its integer components.

Parameters
strOid the dot separated string representation of the oid. For instance, "1.2.840.113554.1.2.2".
Throws
GSSException may be thrown when the string is incorrectly formatted

public Oid (InputStream derOid)

Creates an Oid object from its ASN.1 DER encoding. This refers to the full encoding including tag and length. The structure and encoding of Oids is defined in ISOIEC-8824 and ISOIEC-8825. This method is identical in functionality to its byte array counterpart.

Parameters
derOid stream containing the DER encoded oid
Throws
GSSException may be thrown when the DER encoding does not follow the prescribed format.

public Oid (byte[] data)

Creates an Oid object from its ASN.1 DER encoding. This refers to the full encoding including tag and length. The structure and encoding of Oids is defined in ISOIEC-8824 and ISOIEC-8825. This method is identical in functionality to its InputStream conterpart.

Parameters
data byte array containing the DER encoded oid
Throws
GSSException may be thrown when the DER encoding does not follow the prescribed format.

Public Methods

public boolean containedIn (Oid[] oids)

A utility method to test if this Oid value is contained within the supplied Oid array.

Parameters
oids the array of Oid's to search
Returns
  • true if the array contains this Oid value, false otherwise

public boolean equals (Object other)

Tests if two Oid objects represent the same Object identifier value.

Parameters
other the Oid object that has to be compared to this one
Returns
  • true if the two Oid objects represent the same value, false otherwise.

public byte[] getDER ()

Returns the full ASN.1 DER encoding for this oid object, which includes the tag and length.

Returns
  • byte array containing the DER encoding of this oid object.
Throws
GSSException may be thrown when the oid can't be encoded

public int hashCode ()

Returns a hashcode value for this Oid.

Returns
  • a hashCode value

public String toString ()

Returns a string representation of the oid's integer components in dot separated notation.

Returns
  • string representation in the following format: "1.2.3.4.5"