com.rsa.certj.crmf

Class RegistrationToken

java.lang.Object
  |
  +--com.rsa.certj.crmf.Control
        |
        +--com.rsa.certj.crmf.RegistrationToken

All Implemented Interfaces:

Cloneable, Serializable

public class RegistrationToken

extends Control

implements Cloneable, Serializable

This class holds, encodes, and decodes the Registration Token control. A RegToken control contains one-time information (either based on a secret value or on knowledge) intended to be used by the CA to verify the identity of the subject prior to issuing a certificate. Upon receipt of a certification request that contains a value for RegToken, the receiving CA verifies the information in order to confirm the identity claimed in the certification request.

The RegToken control would typically be used only for initialization of an endentity into PKI.

In some instances of use the value for RegToken could be a text string or a numeric quantity such as a random number. The value in the latter case could be encoded either as a binary quantity or as a text string representation of the binary quantity. To ensure a uniform encoding of values regardless of the nature of the quantity, the encoding of RegToken SHALL be UTF8.

 regToken ::= UTF8String

Copyright © RSA Security Inc., 2000-2001. All rights reserved.

See Also

Serialized Form

Fields inherited from class com.rsa.certj.crmf.Control

AUTHENTICATOR, NON_STANDARD, OLD_CERT_ID, PKI_ARCHIVE_OPTIONS, PKI_PUBLICATION_INFO, PROTOCOL_ENCR_KEY, REG_TOKEN

Constructor Summary

RegistrationToken()

Constructs an empty RegistrationToken object.

Method Summary

Object	clone() Gets a deeper clone than the default.
boolean	equals(Object obj) Returns true if this object and obj contain the same RegistrationToken, returns false otherwise.
byte[]	getValue() Gets the value of the Registration Token control.
void	setValue(byte[] value, int offset, int len) Sets the value of the Registration Token control.

Methods inherited from class com.rsa.certj.crmf.Control

compareOID, derEncodeControlLen, getControlType, getControlTypeString, getDEREncoding, getDERLen, getInstance, getInstance, getNextBEROffset, getOID, isControlType, setEnvironment

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegistrationToken

public RegistrationToken()

Constructs an empty RegistrationToken object.

Method Detail

setValue

public void setValue(byte[] value,
                     int offset,
                     int len)
              throws CRMFException

Sets the value of the Registration Token control.

Parameters

	value		The one-time information intended to be used by the CA to verify the identity of the subject prior to issuing a certificate.
	offset		The offset into value where the value begins
	len		The length of the value

Throws

CRMFException - If the passed in value is NULL

getValue

public byte[] getValue()

Gets the value of the Registration Token control.

Returns

The one-time information intended to be used by the CA to verify the identity of the subject prior to issuing a certificate; if this value is not set yet, returns NULL.

clone

public Object clone()
             throws CloneNotSupportedException

Gets a deeper clone than the default.

Overrides

clone in class Control

Returns

A copy of this object in its current state

Throws

CloneNotSupportedException - If the cloning operation is not successful.

equals

public boolean equals(Object obj)

Returns true if this object and obj contain the same RegistrationToken, returns false otherwise.

Overrides

equals in class Control

Parameters

obj

The instance of RegistrationToken object

Returns

A boolean that indicates whether these objects are equal.