com.netscape.certsrv.request
Interface IRequest

All Known Subinterfaces:
IEnrollmentRequest

public interface IRequest

An interface that defines abilities of request objects,

Version:
$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Field Summary
static java.lang.String AGENT_PARAMS
           
static java.lang.String ATTR_REQUEST_OWNER
           
static java.lang.String ATTR_REQUEST_STATUS
           
static java.lang.String ATTR_REQUEST_TYPE
           
static java.lang.String ATTR_SOURCE_ID
           
static java.lang.String AUTH_TOKEN
           
static java.lang.String CA_CERT
           
static java.lang.String CACERTCHAIN
           
static java.lang.String CEP_CERT
           
static java.lang.String CERT_FILTER
           
static java.lang.String CERT_INFO
           
static java.lang.String CERT_STATUS
           
static java.lang.String CERT_TYPE
           
static java.lang.String CLA_CERT4CRL_REQUEST
           
static java.lang.String CLA_UNCERT4CRL_REQUEST
           
static java.lang.String CLIENT_CERT
           
static java.lang.String CMC_RECIPIENTNONCE
           
static java.lang.String CMC_REGINFO
           
static java.lang.String CMC_REQIDS
           
static java.lang.String CMC_SENDERNONCE
           
static java.lang.String CMC_TRANSID
           
static java.lang.String CMCREVOKE_REQUEST
           
static java.lang.String CRL
           
static java.lang.String CRL_PUBLISH_ERROR
           
static java.lang.String CRL_PUBLISH_STATUS
           
static java.lang.String CRL_UPDATE_ERROR
           
static java.lang.String CRL_UPDATE_STATUS
           
static java.lang.String CRMF_REQID
           
static java.lang.String DOGETCACHAIN
           
static java.lang.String ENROLLMENT_REQUEST
           
static java.lang.String ERROR
           
static java.lang.String ERRORS
           
static java.lang.String FINGERPRINTS
           
static java.lang.String GETCACHAIN_REQUEST
           
static java.lang.String GETCERT_STATUS_REQUEST
           
static java.lang.String GETCERTS_FOR_CHALLENGE_REQUEST
           
static java.lang.String GETCERTS_REQUEST
           
static java.lang.String GETCRL_REQUEST
           
static java.lang.String GETREVOCATIONINFO_REQUEST
           
static java.lang.String HTTP_HEADERS
           
static java.lang.String HTTP_PARAMS
           
static java.lang.String ISSUED_CERTS
           
static java.lang.String ISSUERDN
           
static java.lang.String KEY_ARCHIVAL_REQUEST
           
static java.lang.String KEY_RECOVERY_REQUEST
           
static java.lang.String KEYARCHIVAL_REQUEST
           
static java.lang.String KEYRECOVERY_REQUEST
           
static java.lang.String NETKEY_ATTR_ARCHIVE_FLAG
           
static java.lang.String NETKEY_ATTR_CUID
           
static java.lang.String NETKEY_ATTR_DRMTRANS_DES_KEY
           
static java.lang.String NETKEY_ATTR_ENC_PRIVKEY_FLAG
           
static java.lang.String NETKEY_ATTR_KEY_SIZE
           
static java.lang.String NETKEY_ATTR_SERVERSIDE_MUSCLE_FLAG
           
static java.lang.String NETKEY_ATTR_USER_CERT
           
static java.lang.String NETKEY_ATTR_USERID
           
static java.lang.String NETKEY_KEYGEN_REQUEST
           
static java.lang.String NETKEY_KEYRECOVERY_REQUEST
           
static java.lang.String OBJECT_SIGNING
           
static java.lang.String OBJECT_SIGNING_CERT
           
static java.lang.String OCSP_CERT
           
static java.lang.String OLD_CERTS
           
static java.lang.String OLD_SERIALS
           
static java.lang.String OTHER_CERT
           
static java.lang.String PKCS10_REQID
           
static java.lang.String RA_CERT
           
static java.lang.String REMOTE_REQID
           
static java.lang.String REMOTE_SERVICE_AUTHORITY
           
static java.lang.String REMOTE_STATUS
           
static java.lang.String RENEWAL_REQUEST
           
static java.lang.String REQ_FORMAT
           
static java.lang.String REQ_STATUS
           
static java.lang.String REQ_TYPE
           
static java.lang.String REQ_VERSION
           
static java.lang.String REQUEST_TRUSTEDMGR_PRIVILEGE
           
static java.lang.String REQUESTOR_AGENT
           
static java.lang.String REQUESTOR_COMMENTS
           
static java.lang.String REQUESTOR_EE
           
static java.lang.String REQUESTOR_EMAIL
           
static java.lang.String REQUESTOR_KRA
           
static java.lang.String REQUESTOR_NAME
           
static java.lang.String REQUESTOR_NETKEY_RA
           
static java.lang.String REQUESTOR_PHONE
           
static java.lang.String REQUESTOR_RA
           
static java.lang.String REQUESTOR_TYPE
           
static java.lang.Integer RES_ERROR
           
static java.lang.Integer RES_SUCCESS
           
static java.lang.String RESULT
           
static java.lang.String REVOCATION_CHECK_CHALLENGE_REQUEST
           
static java.lang.String REVOCATION_REQUEST
           
static java.lang.String REVOKED_CERT_RECORDS
           
static java.lang.String REVOKED_CERTS
           
static java.lang.String REVOKED_REASON
           
static java.lang.String ROUTER_CERT
           
static java.lang.String SERVER_ATTRS
           
static java.lang.String SERVER_CERT
           
static java.lang.String SMIME
           
static java.lang.String SSL_CLIENT
           
static java.lang.String SVCERRORS
           
static java.lang.String UNREVOCATION_REQUEST
           
static java.lang.String UPDATED_BY
           
 
Method Summary
 IAttrSet asIAttrSet()
          Deprecated.  
 void copyContents(IRequest req)
          Copies meta attributes (excluding request Id, etc.) of another request to this request.
 void deleteExtData(java.lang.String type)
          Removes the value of an extdata attribute.
 java.lang.String getContext()
          Gets context of this request.
 java.util.Date getCreationTime()
          Gets the time this request was created.
 java.lang.String getError(java.util.Locale locale)
          Gets localized error message from connector transfer.
 IAuthToken getExtDataInAuthToken(java.lang.String key)
          Retrieves an authtoken.
 java.math.BigInteger getExtDataInBigInteger(java.lang.String key)
          Retrieves a BigInteger value.
 java.math.BigInteger[] getExtDataInBigIntegerArray(java.lang.String key)
          Retrieves an array of BigIntegers
 boolean getExtDataInBoolean(java.lang.String type, boolean defVal)
          Gets boolean value for given type or default value if attribute is absent.
 boolean getExtDataInBoolean(java.lang.String prefix, java.lang.String type, boolean defVal)
          Gets extdata boolean value for given type or default value if attribute is absent for this request with this prefix.
 byte[] getExtDataInByteArray(java.lang.String key)
          Retrieves the data, which should be base64 encoded as a byte array.
 netscape.security.x509.X509CertImpl getExtDataInCert(java.lang.String key)
          Retrieves the data, which should be base64 encoded as a byte array.
 netscape.security.x509.X509CertImpl[] getExtDataInCertArray(java.lang.String key)
          Retrieves an array of X509CertImpl.
 netscape.security.x509.CertificateExtensions getExtDataInCertExts(java.lang.String key)
          Retrieves the CertificateExtensions associated with the key.
 netscape.security.x509.X509CertInfo getExtDataInCertInfo(java.lang.String key)
          Retrieves the data, which should be base64 encoded as a byte array.
 netscape.security.x509.X509CertInfo[] getExtDataInCertInfoArray(java.lang.String key)
          Retrieves an array of X509CertInfo.
 netscape.security.x509.CertificateSubjectName getExtDataInCertSubjectName(java.lang.String key)
          Retrieves the CertificateSubjectName associated with the key.
 java.util.Hashtable getExtDataInHashtable(java.lang.String key)
          Returns the Hashtable value for the String key.
 java.lang.Integer getExtDataInInteger(java.lang.String key)
          Retrieves an integer value.
 java.lang.Integer[] getExtDataInIntegerArray(java.lang.String key)
          Retrieves an array of Integers
 netscape.security.x509.RevokedCertImpl[] getExtDataInRevokedCertArray(java.lang.String key)
          Retrieves an array of RevokedCertImpl.
 java.lang.String getExtDataInString(java.lang.String key)
          Returns the String value stored for the String key.
 java.lang.String getExtDataInString(java.lang.String key, java.lang.String subkey)
          Helper method to retrieve an individual value from a Hashtable value.
 java.lang.String[] getExtDataInStringArray(java.lang.String key)
          Retrieves an array of Strings stored with the key.
 java.util.Vector getExtDataInStringVector(java.lang.String key)
          Returns a vector of strings for the key.
 java.util.Enumeration getExtDataKeys()
          Returns all the keys stored in ExtData
 java.util.Date getModificationTime()
          Gets the time this request was last modified (defined as updated in the queue) (See IRequestQueue.update)
 RequestId getRequestId()
          Gets the primary identifier for this request.
 java.lang.String getRequestOwner()
          Gets the current owner of this request.
 RequestStatus getRequestStatus()
          Gets the current state of this request.
 java.lang.String getRequestType()
          Gets the type of this request.
 java.lang.String getRequestVersion()
          Gets the version of this request.
 java.lang.String getSourceId()
          Gets the "sourceId" for the request.
 boolean isSimpleExtDataValue(java.lang.String key)
          Checks whether the key is storing a simple String value, or a complex (Vector/hashtable) structure.
 boolean isSuccess()
          Gets status of connector transfer.
 void setContext(java.lang.String ctx)
          Sets context of this request.
 boolean setExtData(java.lang.String key, java.math.BigInteger value)
          Helper method to store a BigInteger value.
 boolean setExtData(java.lang.String key, java.math.BigInteger[] values)
          Stores an array of BigIntegers
 boolean setExtData(java.lang.String key, byte[] data)
          Stores a byte array as base64 encoded text
 boolean setExtData(java.lang.String key, netscape.security.x509.CertificateExtensions data)
          Stores a CertificateExtensions in extdata.
 boolean setExtData(java.lang.String key, netscape.security.x509.CertificateSubjectName data)
          Stores a CertificateSubjectName in extdata.
 boolean setExtData(java.lang.String key, java.util.Hashtable value)
          Sets an Extended Data string-key string-value pair.
 boolean setExtData(java.lang.String key, IAuthToken data)
          Stores an AuthToken the same as a Hashtable.
 boolean setExtData(java.lang.String key, java.lang.Integer value)
          Helper method to store an Integer value.
 boolean setExtData(java.lang.String key, java.lang.Integer[] values)
          Stores an array of Integers
 boolean setExtData(java.lang.String key, netscape.security.x509.RevokedCertImpl[] data)
          Stores an array of RevokedCertImpls as a base64 encoded text.
 boolean setExtData(java.lang.String key, java.lang.String value)
          Sets an Extended Data string-key string-value pair.
 boolean setExtData(java.lang.String key, java.lang.String[] values)
          Stores an array of Strings in ExtData.
 boolean setExtData(java.lang.String key, java.lang.String subkey, java.lang.String value)
          Helper method to add subkey/value pair to a ExtData hashtable.
 boolean setExtData(java.lang.String key, java.lang.Throwable e)
          Helper method to store an exception.
 boolean setExtData(java.lang.String key, java.util.Vector data)
          Stores the contents of the String Vector in ExtData.
 boolean setExtData(java.lang.String key, netscape.security.x509.X509CertImpl data)
          Stores a X509CertImpl as base64 encoded text using the getEncode() method.
 boolean setExtData(java.lang.String key, netscape.security.x509.X509CertImpl[] data)
          Stores an array of X509CertImpls as a base64 encoded text.
 boolean setExtData(java.lang.String key, netscape.security.x509.X509CertInfo data)
          Stores a X509CertInfo as base64 encoded text using the getEncodedInfo() method.
 boolean setExtData(java.lang.String key, netscape.security.x509.X509CertInfo[] data)
          Stores an array of X509CertInfos as a base64 encoded text.
 void setRequestOwner(java.lang.String owner)
          Sets the current owner of this request.
 void setRequestStatus(RequestStatus s)
          Sets status of this request.
 void setRequestType(java.lang.String type)
          Sets the type or this request.
 void setSourceId(java.lang.String id)
          Sets the "sourceId" for this request.
 

Field Detail

REQ_VERSION

static final java.lang.String REQ_VERSION
See Also:
Constant Field Values

REQ_STATUS

static final java.lang.String REQ_STATUS
See Also:
Constant Field Values

REQ_TYPE

static final java.lang.String REQ_TYPE
See Also:
Constant Field Values

REQ_FORMAT

static final java.lang.String REQ_FORMAT
See Also:
Constant Field Values

ENROLLMENT_REQUEST

static final java.lang.String ENROLLMENT_REQUEST
See Also:
Constant Field Values

RENEWAL_REQUEST

static final java.lang.String RENEWAL_REQUEST
See Also:
Constant Field Values

REVOCATION_REQUEST

static final java.lang.String REVOCATION_REQUEST
See Also:
Constant Field Values

CMCREVOKE_REQUEST

static final java.lang.String CMCREVOKE_REQUEST
See Also:
Constant Field Values

UNREVOCATION_REQUEST

static final java.lang.String UNREVOCATION_REQUEST
See Also:
Constant Field Values

KEYARCHIVAL_REQUEST

static final java.lang.String KEYARCHIVAL_REQUEST
See Also:
Constant Field Values

KEYRECOVERY_REQUEST

static final java.lang.String KEYRECOVERY_REQUEST
See Also:
Constant Field Values

KEY_RECOVERY_REQUEST

static final java.lang.String KEY_RECOVERY_REQUEST
See Also:
Constant Field Values

KEY_ARCHIVAL_REQUEST

static final java.lang.String KEY_ARCHIVAL_REQUEST
See Also:
Constant Field Values

GETCACHAIN_REQUEST

static final java.lang.String GETCACHAIN_REQUEST
See Also:
Constant Field Values

GETREVOCATIONINFO_REQUEST

static final java.lang.String GETREVOCATIONINFO_REQUEST
See Also:
Constant Field Values

GETCRL_REQUEST

static final java.lang.String GETCRL_REQUEST
See Also:
Constant Field Values

GETCERTS_REQUEST

static final java.lang.String GETCERTS_REQUEST
See Also:
Constant Field Values

REVOCATION_CHECK_CHALLENGE_REQUEST

static final java.lang.String REVOCATION_CHECK_CHALLENGE_REQUEST
See Also:
Constant Field Values

GETCERT_STATUS_REQUEST

static final java.lang.String GETCERT_STATUS_REQUEST
See Also:
Constant Field Values

GETCERTS_FOR_CHALLENGE_REQUEST

static final java.lang.String GETCERTS_FOR_CHALLENGE_REQUEST
See Also:
Constant Field Values

CLA_CERT4CRL_REQUEST

static final java.lang.String CLA_CERT4CRL_REQUEST
See Also:
Constant Field Values

CLA_UNCERT4CRL_REQUEST

static final java.lang.String CLA_UNCERT4CRL_REQUEST
See Also:
Constant Field Values

NETKEY_KEYGEN_REQUEST

static final java.lang.String NETKEY_KEYGEN_REQUEST
See Also:
Constant Field Values

NETKEY_KEYRECOVERY_REQUEST

static final java.lang.String NETKEY_KEYRECOVERY_REQUEST
See Also:
Constant Field Values

REQUESTOR_NAME

static final java.lang.String REQUESTOR_NAME
See Also:
Constant Field Values

REQUESTOR_PHONE

static final java.lang.String REQUESTOR_PHONE
See Also:
Constant Field Values

REQUESTOR_EMAIL

static final java.lang.String REQUESTOR_EMAIL
See Also:
Constant Field Values

REQUESTOR_COMMENTS

static final java.lang.String REQUESTOR_COMMENTS
See Also:
Constant Field Values

AUTH_TOKEN

static final java.lang.String AUTH_TOKEN
See Also:
Constant Field Values

HTTP_PARAMS

static final java.lang.String HTTP_PARAMS
See Also:
Constant Field Values

HTTP_HEADERS

static final java.lang.String HTTP_HEADERS
See Also:
Constant Field Values

AGENT_PARAMS

static final java.lang.String AGENT_PARAMS
See Also:
Constant Field Values

SERVER_ATTRS

static final java.lang.String SERVER_ATTRS
See Also:
Constant Field Values

RESULT

static final java.lang.String RESULT
See Also:
Constant Field Values

RES_SUCCESS

static final java.lang.Integer RES_SUCCESS

RES_ERROR

static final java.lang.Integer RES_ERROR

REMOTE_SERVICE_AUTHORITY

static final java.lang.String REMOTE_SERVICE_AUTHORITY
See Also:
Constant Field Values

SVCERRORS

static final java.lang.String SVCERRORS
See Also:
Constant Field Values

REMOTE_STATUS

static final java.lang.String REMOTE_STATUS
See Also:
Constant Field Values

REMOTE_REQID

static final java.lang.String REMOTE_REQID
See Also:
Constant Field Values

CERT_STATUS

static final java.lang.String CERT_STATUS
See Also:
Constant Field Values

CERT_TYPE

static final java.lang.String CERT_TYPE
See Also:
Constant Field Values

CRMF_REQID

static final java.lang.String CRMF_REQID
See Also:
Constant Field Values

PKCS10_REQID

static final java.lang.String PKCS10_REQID
See Also:
Constant Field Values

CMC_REQIDS

static final java.lang.String CMC_REQIDS
See Also:
Constant Field Values

CMC_TRANSID

static final java.lang.String CMC_TRANSID
See Also:
Constant Field Values

CMC_SENDERNONCE

static final java.lang.String CMC_SENDERNONCE
See Also:
Constant Field Values

CMC_RECIPIENTNONCE

static final java.lang.String CMC_RECIPIENTNONCE
See Also:
Constant Field Values

CMC_REGINFO

static final java.lang.String CMC_REGINFO
See Also:
Constant Field Values

CERT_INFO

static final java.lang.String CERT_INFO
See Also:
Constant Field Values

ISSUED_CERTS

static final java.lang.String ISSUED_CERTS
See Also:
Constant Field Values

REQUEST_TRUSTEDMGR_PRIVILEGE

static final java.lang.String REQUEST_TRUSTEDMGR_PRIVILEGE
See Also:
Constant Field Values

FINGERPRINTS

static final java.lang.String FINGERPRINTS
See Also:
Constant Field Values

SERVER_CERT

static final java.lang.String SERVER_CERT
See Also:
Constant Field Values

CLIENT_CERT

static final java.lang.String CLIENT_CERT
See Also:
Constant Field Values

CA_CERT

static final java.lang.String CA_CERT
See Also:
Constant Field Values

RA_CERT

static final java.lang.String RA_CERT
See Also:
Constant Field Values

OCSP_CERT

static final java.lang.String OCSP_CERT
See Also:
Constant Field Values

OBJECT_SIGNING_CERT

static final java.lang.String OBJECT_SIGNING_CERT
See Also:
Constant Field Values

OTHER_CERT

static final java.lang.String OTHER_CERT
See Also:
Constant Field Values

ROUTER_CERT

static final java.lang.String ROUTER_CERT
See Also:
Constant Field Values

CEP_CERT

static final java.lang.String CEP_CERT
See Also:
Constant Field Values

OLD_CERTS

static final java.lang.String OLD_CERTS
See Also:
Constant Field Values

OLD_SERIALS

static final java.lang.String OLD_SERIALS
See Also:
Constant Field Values

ISSUERDN

static final java.lang.String ISSUERDN
See Also:
Constant Field Values

REVOKED_CERTS

static final java.lang.String REVOKED_CERTS
See Also:
Constant Field Values

REVOKED_REASON

static final java.lang.String REVOKED_REASON
See Also:
Constant Field Values

REVOKED_CERT_RECORDS

static final java.lang.String REVOKED_CERT_RECORDS
See Also:
Constant Field Values

CRL_UPDATE_STATUS

static final java.lang.String CRL_UPDATE_STATUS
See Also:
Constant Field Values

CRL_UPDATE_ERROR

static final java.lang.String CRL_UPDATE_ERROR
See Also:
Constant Field Values

CRL_PUBLISH_STATUS

static final java.lang.String CRL_PUBLISH_STATUS
See Also:
Constant Field Values

CRL_PUBLISH_ERROR

static final java.lang.String CRL_PUBLISH_ERROR
See Also:
Constant Field Values

REQUESTOR_TYPE

static final java.lang.String REQUESTOR_TYPE
See Also:
Constant Field Values

NETKEY_ATTR_CUID

static final java.lang.String NETKEY_ATTR_CUID
See Also:
Constant Field Values

NETKEY_ATTR_USERID

static final java.lang.String NETKEY_ATTR_USERID
See Also:
Constant Field Values

NETKEY_ATTR_DRMTRANS_DES_KEY

static final java.lang.String NETKEY_ATTR_DRMTRANS_DES_KEY
See Also:
Constant Field Values

NETKEY_ATTR_ARCHIVE_FLAG

static final java.lang.String NETKEY_ATTR_ARCHIVE_FLAG
See Also:
Constant Field Values

NETKEY_ATTR_SERVERSIDE_MUSCLE_FLAG

static final java.lang.String NETKEY_ATTR_SERVERSIDE_MUSCLE_FLAG
See Also:
Constant Field Values

NETKEY_ATTR_ENC_PRIVKEY_FLAG

static final java.lang.String NETKEY_ATTR_ENC_PRIVKEY_FLAG
See Also:
Constant Field Values

NETKEY_ATTR_USER_CERT

static final java.lang.String NETKEY_ATTR_USER_CERT
See Also:
Constant Field Values

NETKEY_ATTR_KEY_SIZE

static final java.lang.String NETKEY_ATTR_KEY_SIZE
See Also:
Constant Field Values

REQUESTOR_EE

static final java.lang.String REQUESTOR_EE
See Also:
Constant Field Values

REQUESTOR_RA

static final java.lang.String REQUESTOR_RA
See Also:
Constant Field Values

REQUESTOR_NETKEY_RA

static final java.lang.String REQUESTOR_NETKEY_RA
See Also:
Constant Field Values

REQUESTOR_KRA

static final java.lang.String REQUESTOR_KRA
See Also:
Constant Field Values

REQUESTOR_AGENT

static final java.lang.String REQUESTOR_AGENT
See Also:
Constant Field Values

CACERTCHAIN

static final java.lang.String CACERTCHAIN
See Also:
Constant Field Values

CRL

static final java.lang.String CRL
See Also:
Constant Field Values

DOGETCACHAIN

static final java.lang.String DOGETCACHAIN
See Also:
Constant Field Values

CERT_FILTER

static final java.lang.String CERT_FILTER
See Also:
Constant Field Values

ERRORS

static final java.lang.String ERRORS
See Also:
Constant Field Values

SMIME

static final java.lang.String SMIME
See Also:
Constant Field Values

OBJECT_SIGNING

static final java.lang.String OBJECT_SIGNING
See Also:
Constant Field Values

SSL_CLIENT

static final java.lang.String SSL_CLIENT
See Also:
Constant Field Values

ATTR_REQUEST_OWNER

static final java.lang.String ATTR_REQUEST_OWNER
See Also:
Constant Field Values

ATTR_REQUEST_STATUS

static final java.lang.String ATTR_REQUEST_STATUS
See Also:
Constant Field Values

ATTR_SOURCE_ID

static final java.lang.String ATTR_SOURCE_ID
See Also:
Constant Field Values

ATTR_REQUEST_TYPE

static final java.lang.String ATTR_REQUEST_TYPE
See Also:
Constant Field Values

UPDATED_BY

static final java.lang.String UPDATED_BY
See Also:
Constant Field Values

ERROR

static final java.lang.String ERROR
See Also:
Constant Field Values
Method Detail

getRequestId

RequestId getRequestId()
Gets the primary identifier for this request.

Returns:
request id

getRequestStatus

RequestStatus getRequestStatus()
Gets the current state of this request.

Returns:
request status

getSourceId

java.lang.String getSourceId()
Gets the "sourceId" for the request. The sourceId is assigned by the originator of the request (for example, the EE servlet or the RA servlet.

The sourceId should be unique so that it can be used to retrieve request later without knowing the locally assigned primary id (RequestID)

Returns:
the sourceId value (or null if none has been set)

setSourceId

void setSourceId(java.lang.String id)
Sets the "sourceId" for this request. The request must be updated in the database for this change to take effect. This can be done by calling IRequestQueue.update() or by performing one of the other operations like processRequest or approveRequest.

Parameters:
id - source id for this request

getRequestOwner

java.lang.String getRequestOwner()
Gets the current owner of this request.

Returns:
request owner

setRequestOwner

void setRequestOwner(java.lang.String owner)
Sets the current owner of this request.

Parameters:
owner - The new owner of this request. If this value is set to null there will be no current owner

getRequestType

java.lang.String getRequestType()
Gets the type of this request.

Returns:
request type

setRequestType

void setRequestType(java.lang.String type)
Sets the type or this request.

Parameters:
type - request type

getRequestVersion

java.lang.String getRequestVersion()
Gets the version of this request.

Returns:
request version

getCreationTime

java.util.Date getCreationTime()
Gets the time this request was created.

Returns:
request creation time

getModificationTime

java.util.Date getModificationTime()
Gets the time this request was last modified (defined as updated in the queue) (See IRequestQueue.update)

Returns:
request last modification time

copyContents

void copyContents(IRequest req)
Copies meta attributes (excluding request Id, etc.) of another request to this request.

Parameters:
req - another request

getContext

java.lang.String getContext()
Gets context of this request.

Returns:
request context

setContext

void setContext(java.lang.String ctx)
Sets context of this request.

Parameters:
ctx - request context

setRequestStatus

void setRequestStatus(RequestStatus s)
Sets status of this request.

Parameters:
s - request status

isSuccess

boolean isSuccess()
Gets status of connector transfer.

Returns:
status of connector transfer

getError

java.lang.String getError(java.util.Locale locale)
Gets localized error message from connector transfer.

Parameters:
locale - request locale
Returns:
error message from connector transfer

setExtData

boolean setExtData(java.lang.String key,
                   java.lang.String value)
Sets an Extended Data string-key string-value pair. All keys are lower cased because LDAP does not preserve case.

Parameters:
key - The extended data key
value - The extended data value
Returns:
false if key is invalid.

setExtData

boolean setExtData(java.lang.String key,
                   java.util.Hashtable value)
Sets an Extended Data string-key string-value pair. The key and hashtable keys are all lowercased because LDAP does not preserve case.

Parameters:
key - The extended data key
value - The extended data value the Hashtable contains an illegal key.
Returns:
false if the key or hashtable keys are invalid

isSimpleExtDataValue

boolean isSimpleExtDataValue(java.lang.String key)
Checks whether the key is storing a simple String value, or a complex (Vector/hashtable) structure.

Parameters:
key - The key to check for.
Returns:
True if the key maps to a string. False if it maps to a hashtable.

getExtDataInString

java.lang.String getExtDataInString(java.lang.String key)
Returns the String value stored for the String key. Returns null if not found. Throws exception if key stores a complex data structure (Vector/Hashtable).

Parameters:
key - The key to lookup (case-insensitive)
Returns:
The value associated with the key. null if not found or if the key is associated with a non-string value.

getExtDataInHashtable

java.util.Hashtable getExtDataInHashtable(java.lang.String key)
Returns the Hashtable value for the String key. Returns null if not found. Throws exception if the key stores a String value. The Hashtable returned is actually a subclass of Hashtable that lowercases all keys used to access the hashtable. Its purpose is to to make lookups seemless, but be aware it is not a normal hashtable and might behave strangely in some cases (e.g., iterating keys)

Parameters:
key - The key to lookup (case-insensitive)
Returns:
The hashtable value associated with the key. null if not found or if the key is associated with a string-value.

getExtDataKeys

java.util.Enumeration getExtDataKeys()
Returns all the keys stored in ExtData

Returns:
Enumeration of all the keys.

setExtData

boolean setExtData(java.lang.String key,
                   java.lang.String[] values)
Stores an array of Strings in ExtData. The indices of the array are used as subkeys.

Parameters:
key - the ExtData key
values - the array of string values to store
Returns:
False if the key is invalid

getExtDataInStringArray

java.lang.String[] getExtDataInStringArray(java.lang.String key)
Retrieves an array of Strings stored with the key. This only works if the data was stored as an array. If the data is not correct, this method will return null.

Parameters:
key - The ExtData key
Returns:
The value. Null if not found or the data isn't an array.

deleteExtData

void deleteExtData(java.lang.String type)
Removes the value of an extdata attribute.

Parameters:
type - key to delete

setExtData

boolean setExtData(java.lang.String key,
                   java.lang.String subkey,
                   java.lang.String value)
Helper method to add subkey/value pair to a ExtData hashtable. If the hashtable it exists, the subkey/value are added to it. Otherwise a new hashtable is created. The key and subkey are lowercased because LDAP does not preserve case.

Parameters:
key - The top level key
subkey - The hashtable data key
value - The hashtable value
Returns:
False if the key or subkey are invalid

getExtDataInString

java.lang.String getExtDataInString(java.lang.String key,
                                    java.lang.String subkey)
Helper method to retrieve an individual value from a Hashtable value.

Parameters:
key - the ExtData key
subkey - the key in the Hashtable value (case insensitive)
Returns:
the value corresponding to the key/subkey

setExtData

boolean setExtData(java.lang.String key,
                   java.lang.Integer value)
Helper method to store an Integer value. It converts the integer value to a String and stores it.

Parameters:
key - the ExtData key
value - the Integer to store (as a String)
Returns:
False if the key or value are invalid

getExtDataInInteger

java.lang.Integer getExtDataInInteger(java.lang.String key)
Retrieves an integer value. Returns null if not found or the value can't be represented as an Integer.

Parameters:
key - The ExtData key to lookup
Returns:
The integer value or null if not possible.

setExtData

boolean setExtData(java.lang.String key,
                   java.lang.Integer[] values)
Stores an array of Integers

Parameters:
key - The extdata key
values - The array of Integers to store
Returns:
false if the key is invalid

getExtDataInIntegerArray

java.lang.Integer[] getExtDataInIntegerArray(java.lang.String key)
Retrieves an array of Integers

Parameters:
key - The extdata key
Returns:
The array of Integers or null on error.

setExtData

boolean setExtData(java.lang.String key,
                   java.math.BigInteger value)
Helper method to store a BigInteger value. It converts the integer value to a String and stores it.

Parameters:
key - the ExtData key
value - the BigInteger to store (as a String)
Returns:
False if the key or value are invalid

getExtDataInBigInteger

java.math.BigInteger getExtDataInBigInteger(java.lang.String key)
Retrieves a BigInteger value. Returns null if not found or the value can't be represented as a BigInteger.

Parameters:
key - The ExtData key to lookup
Returns:
The integer value or null if not possible.

setExtData

boolean setExtData(java.lang.String key,
                   java.math.BigInteger[] values)
Stores an array of BigIntegers

Parameters:
key - The extdata key
values - The array of BigIntegers to store
Returns:
false if the key is invalid

getExtDataInBigIntegerArray

java.math.BigInteger[] getExtDataInBigIntegerArray(java.lang.String key)
Retrieves an array of BigIntegers

Parameters:
key - The extdata key
Returns:
The array of BigIntegers or null on error.

setExtData

boolean setExtData(java.lang.String key,
                   java.lang.Throwable e)
Helper method to store an exception. It actually stores the e.toString() value.

Parameters:
key - The ExtData key to store under
e - The throwable to store
Returns:
False if the key is invalid.

setExtData

boolean setExtData(java.lang.String key,
                   byte[] data)
Stores a byte array as base64 encoded text

Parameters:
key - The ExtData key
data - The byte array to store
Returns:
False if the key is invalid.

getExtDataInByteArray

byte[] getExtDataInByteArray(java.lang.String key)
Retrieves the data, which should be base64 encoded as a byte array.

Parameters:
key - The ExtData key
Returns:
The data, or null if an error occurs.

setExtData

boolean setExtData(java.lang.String key,
                   netscape.security.x509.X509CertImpl data)
Stores a X509CertImpl as base64 encoded text using the getEncode() method.

Parameters:
key - The ExtData key
data - certificate
Returns:
False if the key is invalid.

getExtDataInCert

netscape.security.x509.X509CertImpl getExtDataInCert(java.lang.String key)
Retrieves the data, which should be base64 encoded as a byte array.

Parameters:
key - The ExtData key
Returns:
The data, or null if an error occurs.

setExtData

boolean setExtData(java.lang.String key,
                   netscape.security.x509.X509CertImpl[] data)
Stores an array of X509CertImpls as a base64 encoded text.

Parameters:
key - The ExtData key
data - The array of certs to store
Returns:
False if the key or data is invalid.

getExtDataInCertArray

netscape.security.x509.X509CertImpl[] getExtDataInCertArray(java.lang.String key)
Retrieves an array of X509CertImpl.

Parameters:
key - The ExtData key
Returns:
Array of certs, or null if not found or invalid data.

setExtData

boolean setExtData(java.lang.String key,
                   netscape.security.x509.X509CertInfo data)
Stores a X509CertInfo as base64 encoded text using the getEncodedInfo() method.

Parameters:
key - The ExtData key
data - certificate
Returns:
False if the key is invalid.

getExtDataInCertInfo

netscape.security.x509.X509CertInfo getExtDataInCertInfo(java.lang.String key)
Retrieves the data, which should be base64 encoded as a byte array.

Parameters:
key - The ExtData key
Returns:
The data, or null if an error occurs.

setExtData

boolean setExtData(java.lang.String key,
                   netscape.security.x509.X509CertInfo[] data)
Stores an array of X509CertInfos as a base64 encoded text.

Parameters:
key - The ExtData key
data - The array of cert infos to store
Returns:
False if the key or data is invalid.

getExtDataInCertInfoArray

netscape.security.x509.X509CertInfo[] getExtDataInCertInfoArray(java.lang.String key)
Retrieves an array of X509CertInfo.

Parameters:
key - The ExtData key
Returns:
Array of cert infos, or null if not found or invalid data.

setExtData

boolean setExtData(java.lang.String key,
                   netscape.security.x509.RevokedCertImpl[] data)
Stores an array of RevokedCertImpls as a base64 encoded text.

Parameters:
key - The ExtData key
data - The array of cert infos to store
Returns:
False if the key or data is invalid.

getExtDataInRevokedCertArray

netscape.security.x509.RevokedCertImpl[] getExtDataInRevokedCertArray(java.lang.String key)
Retrieves an array of RevokedCertImpl.

Parameters:
key - The ExtData key
Returns:
Array of cert infos, or null if not found or invalid data.

setExtData

boolean setExtData(java.lang.String key,
                   java.util.Vector data)
Stores the contents of the String Vector in ExtData. TODO - as soon as we're allowed to use JDK5 this should be changed to use Vector data. Note that modifications to the Vector are not automatically reflected after it is stored. You must call set() again to make the changes.

Parameters:
key - The extdata key to store
data - A vector of Strings to store
Returns:
False on key error or invalid data.

getExtDataInStringVector

java.util.Vector getExtDataInStringVector(java.lang.String key)
Returns a vector of strings for the key. Note that the returned vector, if modified, does not make changes in ExtData. You must call setExtData() to propogate changes back into ExtData.

Parameters:
key - The extdata key
Returns:
A Vector of strings, or null on error.

getExtDataInBoolean

boolean getExtDataInBoolean(java.lang.String type,
                            boolean defVal)
Gets boolean value for given type or default value if attribute is absent.

Parameters:
type - attribute type
defVal - default attribute value
Returns:
attribute value

getExtDataInBoolean

boolean getExtDataInBoolean(java.lang.String prefix,
                            java.lang.String type,
                            boolean defVal)
Gets extdata boolean value for given type or default value if attribute is absent for this request with this prefix.

Parameters:
prefix - request prefix
type - attribute type
defVal - default attribute value
Returns:
attribute value

setExtData

boolean setExtData(java.lang.String key,
                   IAuthToken data)
Stores an AuthToken the same as a Hashtable.

Parameters:
key - The ExtData key
data - The authtoken to store
Returns:
False if the key or data is invalid.

getExtDataInAuthToken

IAuthToken getExtDataInAuthToken(java.lang.String key)
Retrieves an authtoken.

Parameters:
key - The ExtData key
Returns:
AuthToken, or null if not found or invalid data.

setExtData

boolean setExtData(java.lang.String key,
                   netscape.security.x509.CertificateExtensions data)
Stores a CertificateExtensions in extdata.

Parameters:
key - The ExtData key
data - The CertificateExtensions to store
Returns:
False if the key or data is invalid.

getExtDataInCertExts

netscape.security.x509.CertificateExtensions getExtDataInCertExts(java.lang.String key)
Retrieves the CertificateExtensions associated with the key.

Parameters:
key - The ExtData key
Returns:
the object, or null if not found or invalid data.

setExtData

boolean setExtData(java.lang.String key,
                   netscape.security.x509.CertificateSubjectName data)
Stores a CertificateSubjectName in extdata.

Parameters:
key - The ExtData key
data - The CertificateSubjectName to store
Returns:
False if the key or data is invalid.

getExtDataInCertSubjectName

netscape.security.x509.CertificateSubjectName getExtDataInCertSubjectName(java.lang.String key)
Retrieves the CertificateSubjectName associated with the key.

Parameters:
key - The ExtData key
Returns:
the object, or null if not found or invalid data.

asIAttrSet

IAttrSet asIAttrSet()
Deprecated. 

This method returns an IAttrSet wrapper for the IRequest. Use of this method is strongly discouraged. It provides extremely limited functionality, and is only provided for the two places IRequest is being used as such in the code. If you are considering using this method, please don't.

Returns:
IAttrSet wrapper with basic "get" functionality.