Package org.mozilla.jss.netscape.security.x509

Class HoldInstructionExtension

java.lang.Object

org.mozilla.jss.netscape.security.x509.Extension

org.mozilla.jss.netscape.security.x509.HoldInstructionExtension

All Implemented Interfaces:

java.io.Serializable, CertAttrSet

public class HoldInstructionExtension
extends Extension
implements CertAttrSet

Represent the CRL Hold Instruction Code Extension.

The hold instruction code is a non-critical CRL entry extension that provides a registered instruction identifier which indicates the action to be taken after encountering a certificate that has been placed on hold.

See Also:

Extension, CertAttrSet, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ObjectIdentifier	CALL_ISSUER_HOLD_INSTR_OID
static java.lang.String	CALL_ISSUER_HOLD_INSTR_OID_STR
static java.lang.String	HOLD_INSTRUCTION
static java.lang.String	NAME	Attribute name.
static ObjectIdentifier	NONE_HOLD_INSTR_OID
static java.lang.String	NONE_HOLD_INSTR_OID_STR
static java.lang.String	OID	The Object Identifier for this extension.
static ObjectIdentifier	REJECT_HOLD_INSTR_OID
static java.lang.String	REJECT_HOLD_INSTR_OID_STR

Fields inherited from class org.mozilla.jss.netscape.security.x509.Extension

critical, extensionId, extensionValue

Constructor Summary

Constructors

Constructor	Description
HoldInstructionExtension(int code)	Create a HoldInstructionExtension with the date.
HoldInstructionExtension(java.lang.Boolean critical, int code)	Create a HoldInstructionExtension with the date.
HoldInstructionExtension(java.lang.Boolean critical, java.lang.Object value)	Create the extension from the passed DER encoded value of the same.
HoldInstructionExtension(java.lang.Boolean critical, java.lang.String oidStr)	Create a HoldInstructionExtension with the date.
HoldInstructionExtension(java.lang.Boolean critical, ObjectIdentifier oid)	Create a HoldInstructionExtension with the date.
HoldInstructionExtension(java.lang.String oidStr)	Create a HoldInstructionExtension with the date.
HoldInstructionExtension(ObjectIdentifier oid)	Create a HoldInstructionExtension with the date.

Method Summary

Modifier and Type	Method	Description
void	decode(java.io.InputStream in)	Decode the extension from the InputStream.
void	delete(java.lang.String name)	Delete the attribute value.
void	encode(java.io.OutputStream out)	Write the extension to the DerOutputStream.
java.lang.Object	get(java.lang.String name)	Get the attribute value.
java.util.Enumeration<java.lang.String>	getAttributeNames()	Return an enumeration of names of attributes existing within this attribute.
ObjectIdentifier	getHoldInstructionCode()	Get the hold instruction code.
java.lang.String	getHoldInstructionCodeDescription()
java.lang.String	getName()	Return the name of this attribute.
void	set(java.lang.String name, java.lang.Object obj)	Set the attribute value.
java.lang.String	toString()	Returns a printable representation of the HoldInstructionExtension.

Methods inherited from class org.mozilla.jss.netscape.security.x509.Extension

clearValue, encode, getExtensionId, getExtensionValue, isCritical, setCritical, setExtensionId, setExtensionValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

Attribute name.

See Also:

Constant Field Values

HOLD_INSTRUCTION

public static final java.lang.String HOLD_INSTRUCTION

See Also:

Constant Field Values

OID

public static final java.lang.String OID

The Object Identifier for this extension.

See Also:

Constant Field Values

NONE_HOLD_INSTR_OID_STR

public static final java.lang.String NONE_HOLD_INSTR_OID_STR

See Also:

Constant Field Values

NONE_HOLD_INSTR_OID

public static final ObjectIdentifier NONE_HOLD_INSTR_OID

CALL_ISSUER_HOLD_INSTR_OID_STR

public static final java.lang.String CALL_ISSUER_HOLD_INSTR_OID_STR

See Also:

Constant Field Values

CALL_ISSUER_HOLD_INSTR_OID

public static final ObjectIdentifier CALL_ISSUER_HOLD_INSTR_OID

REJECT_HOLD_INSTR_OID_STR

public static final java.lang.String REJECT_HOLD_INSTR_OID_STR

See Also:

Constant Field Values

REJECT_HOLD_INSTR_OID

public static final ObjectIdentifier REJECT_HOLD_INSTR_OID

Constructor Detail

HoldInstructionExtension

public HoldInstructionExtension(int code)
                         throws java.io.IOException

Create a HoldInstructionExtension with the date. The criticality is set to false.

Parameters:

code - the value to be set for the extension.

Throws:

java.io.IOException

HoldInstructionExtension

public HoldInstructionExtension(java.lang.String oidStr)
                         throws java.io.IOException

Create a HoldInstructionExtension with the date. The criticality is set to false.

Parameters:

oidStr - the value to be set for the extension.

Throws:

java.io.IOException

HoldInstructionExtension

public HoldInstructionExtension(ObjectIdentifier oid)
                         throws java.io.IOException

Create a HoldInstructionExtension with the date. The criticality is set to false.

Parameters:

oid - the value to be set for the extension.

Throws:

java.io.IOException

HoldInstructionExtension

public HoldInstructionExtension(java.lang.Boolean critical,
                                int code)
                         throws java.io.IOException

Create a HoldInstructionExtension with the date. The criticality is set to false.

Parameters:

critical - true if the extension is to be treated as critical.

code - the value to be set for the extension.

Throws:

java.io.IOException

HoldInstructionExtension

public HoldInstructionExtension(java.lang.Boolean critical,
                                java.lang.String oidStr)
                         throws java.io.IOException

Create a HoldInstructionExtension with the date. The criticality is set to false.

Parameters:

critical - true if the extension is to be treated as critical.

oidStr - the value to be set for the extension.

Throws:

java.io.IOException

HoldInstructionExtension

public HoldInstructionExtension(java.lang.Boolean critical,
                                ObjectIdentifier oid)
                         throws java.io.IOException

Create a HoldInstructionExtension with the date. The criticality is set to false.

Parameters:

critical - true if the extension is to be treated as critical.

oid - the value to be set for the extension.

Throws:

java.io.IOException

HoldInstructionExtension

public HoldInstructionExtension(java.lang.Boolean critical,
                                java.lang.Object value)
                         throws java.io.IOException

Create the extension from the passed DER encoded value of the same.

Parameters:

critical - true if the extension is to be treated as critical.

value - Array of DER encoded bytes of the actual value.

Throws:

java.io.IOException - on error.

Method Detail

getHoldInstructionCode

public ObjectIdentifier getHoldInstructionCode()

Get the hold instruction code.

getHoldInstructionCodeDescription

public java.lang.String getHoldInstructionCodeDescription()

set

public void set(java.lang.String name,
                java.lang.Object obj)
         throws java.io.IOException

Set the attribute value.

Specified by:

set in interface CertAttrSet

Parameters:

name - the name of the attribute (e.g. "x509.info.key")

obj - the attribute object.

Throws:

java.io.IOException - on other errors.

get

public java.lang.Object get(java.lang.String name)
                     throws java.io.IOException

Get the attribute value.

Specified by:

get in interface CertAttrSet

Parameters:

name - the name of the attribute to return.

Throws:

java.io.IOException - on other errors.

delete

public void delete(java.lang.String name)
            throws java.io.IOException

Delete the attribute value.

Specified by:

delete in interface CertAttrSet

Parameters:

name - the name of the attribute to delete.

Throws:

java.io.IOException - on other errors.

toString

public java.lang.String toString()

Returns a printable representation of the HoldInstructionExtension.

Specified by:

toString in interface CertAttrSet

Overrides:

toString in class Extension

Returns:

value of this certificate attribute in printable form.

decode

public void decode(java.io.InputStream in)
            throws java.io.IOException

Decode the extension from the InputStream.

Specified by:

decode in interface CertAttrSet

Parameters:

in - the InputStream to unmarshal the contents from.

Throws:

java.io.IOException - on decoding or validity errors.

encode

public void encode(java.io.OutputStream out)
            throws java.io.IOException

Write the extension to the DerOutputStream.

Specified by:

encode in interface CertAttrSet

Parameters:

out - the DerOutputStream to write the extension to.

Throws:

java.io.IOException - on encoding errors.

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

Return an enumeration of names of attributes existing within this attribute.

Specified by:

getAttributeNames in interface CertAttrSet

Returns:

an enumeration of the attribute names.

getName

public java.lang.String getName()

Return the name of this attribute.

Specified by:

getName in interface CertAttrSet

Returns:

the name of this CertAttrSet.