sun.security.x509

Class CRLReasonCodeExtension

java.lang.Object

sun.security.x509.Extension

sun.security.x509.CRLReasonCodeExtension

All Implemented Interfaces:

CertAttrSet<java.lang.String>

public class CRLReasonCodeExtension
extends Extension
implements CertAttrSet<java.lang.String>

The reasonCode is a non-critical CRL entry extension that identifies the reason for the certificate revocation. CAs are strongly encouraged to include reason codes in CRL entries; however, the reason code CRL entry extension should be absent instead of using the unspecified (0) reasonCode value.

The ASN.1 syntax for this is:

  id-ce-cRLReason OBJECT IDENTIFIER ::= { id-ce 21 }

  -- reasonCode ::= { CRLReason }

 CRLReason ::= ENUMERATED {
    unspecified             (0),
    keyCompromise           (1),
    cACompromise            (2),
    affiliationChanged      (3),
    superseded              (4),
    cessationOfOperation    (5),
    certificateHold         (6),
    removeFromCRL           (8),
    privilegeWithdrawn      (9),
    aACompromise           (10) }
 

Author:

Hemma Prafullchandra

See Also:

Extension, CertAttrSet

Field Summary

Fields

Modifier and Type	Field and Description
static int	AA_COMPROMISE
static int	AFFLIATION_CHANGED
static int	CA_COMPROMISE
static int	CERTIFICATE_HOLD
static int	CESSATION_OF_OPERATION
static int	KEY_COMPROMISE
static java.lang.String	NAME Attribute name and Reason codes
static int	PRIVILEGE_WITHDRAWN
static java.lang.String	REASON
static int	REMOVE_FROM_CRL
static int	SUPERSEDED
static int	UNSPECIFIED

Fields inherited from class sun.security.x509.Extension

critical, extensionId, extensionValue

Constructor Summary

Constructors

Constructor and Description
CRLReasonCodeExtension(boolean critical, int reason) Create a CRLReasonCodeExtension with the passed in reason.
CRLReasonCodeExtension(java.lang.Boolean critical, java.lang.Object value) Create the extension from the passed DER encoded value of the same.
CRLReasonCodeExtension(int reason) Create a CRLReasonCodeExtension with the passed in reason.

Method Summary

Methods

Modifier and Type	Method and Description
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>	getElements() Return an enumeration of names of attributes existing within this attribute.
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 Reason code.

Methods inherited from class sun.security.x509.Extension

encode, equals, getExtensionId, getExtensionValue, hashCode, isCritical

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

Attribute name and Reason codes

See Also:

Constant Field Values

REASON

public static final java.lang.String REASON

See Also:

Constant Field Values

UNSPECIFIED

public static final int UNSPECIFIED

See Also:

Constant Field Values

KEY_COMPROMISE

public static final int KEY_COMPROMISE

See Also:

Constant Field Values

CA_COMPROMISE

public static final int CA_COMPROMISE

See Also:

Constant Field Values

AFFLIATION_CHANGED

public static final int AFFLIATION_CHANGED

See Also:

Constant Field Values

SUPERSEDED

public static final int SUPERSEDED

See Also:

Constant Field Values

CESSATION_OF_OPERATION

public static final int CESSATION_OF_OPERATION

See Also:

Constant Field Values

CERTIFICATE_HOLD

public static final int CERTIFICATE_HOLD

See Also:

Constant Field Values

REMOVE_FROM_CRL

public static final int REMOVE_FROM_CRL

See Also:

Constant Field Values

PRIVILEGE_WITHDRAWN

public static final int PRIVILEGE_WITHDRAWN

See Also:

Constant Field Values

AA_COMPROMISE

public static final int AA_COMPROMISE

See Also:

Constant Field Values

Constructor Detail

CRLReasonCodeExtension

public CRLReasonCodeExtension(int reason)
                       throws java.io.IOException

Create a CRLReasonCodeExtension with the passed in reason. Criticality automatically set to false.

Parameters:

reason - the enumerated value for the reason code.

Throws:

java.io.IOException

CRLReasonCodeExtension

public CRLReasonCodeExtension(boolean critical,
                      int reason)
                       throws java.io.IOException

Create a CRLReasonCodeExtension with the passed in reason.

Parameters:

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

reason - the enumerated value for the reason code.

Throws:

java.io.IOException

CRLReasonCodeExtension

public CRLReasonCodeExtension(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 - an array of DER encoded bytes of the actual value.

Throws:

java.lang.ClassCastException - if value is not an array of bytes

java.io.IOException - on error.

Method Detail

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<java.lang.String>

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<java.lang.String>

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<java.lang.String>

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 Reason code.

Specified by:

toString in interface CertAttrSet<java.lang.String>

Overrides:

toString in class Extension

Returns:

value of this certificate attribute in printable form.

encode

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

Write the extension to the DerOutputStream.

Specified by:

encode in interface CertAttrSet<java.lang.String>

Parameters:

out - the DerOutputStream to write the extension to.

Throws:

java.io.IOException - on encoding errors.

getElements

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

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

Specified by:

getElements in interface CertAttrSet<java.lang.String>

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<java.lang.String>

Returns:

the name of this CertAttrSet.