SHOW Signed

net.rim.device.api.crypto.certificate.status
Class CertificateStatusRequest

java.lang.Object
  |
  +--net.rim.device.api.crypto.certificate.status.CertificateStatusRequest

public class CertificateStatusRequest

extends Object

Encapsulates the information necessary for an over-the-air certificate status request. Once a request is generated, it can be passed on to a provider for processing. When the process is complete, this object is updated with either the returned status or the error condition.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 3.6.0

Constructor Summary

CertificateStatusRequest(Certificate[] certChain, boolean checkEntireChain, KeyStore keyStore, CertificateStatusManagerTicket ticket, Object cookie) Creates a new CertificateStatusRequest for the given certificate or certificate chain.

Method Summary

	boolean	checkEntireChain() Returns true if the status of the entire chain is to be checked.
	Certificate[]	getCertChain() Returns the certificate chain associated with this request.
	Object	getCookie() Returns the cookie object initially passed into the constructor.
	String	getErrorMessage() Returns a textual error message describing the current error condition, if any.
	CertificateStatus	getOverallStatus() Returns the overall certificate status for this request.
	Enumeration	getProviderErrorMessages() Returns an enumeration of strings containing error messages logged by the certificate status providers.
	Certificate[]	getResponseCerts() Returns the array of certificates for which status was received (in no particular order).
	CertificateStatus[]	getResponseStatus() Returns an array containing CertificateStatus objects for each certificate in the response certificate array (returned by getResponseCerts).

Methods inherited from class java.lang.Object

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

Constructor Detail

CertificateStatusRequest

public CertificateStatusRequest(Certificate[] certChain,
                                boolean checkEntireChain,
                                KeyStore keyStore,
                                CertificateStatusManagerTicket ticket,
                                Object cookie)

Creates a new CertificateStatusRequest for the given certificate or certificate chain.

Parameters:

certChain - The certificate chain containing the certificate(s) in question. Usually, it will be necessary to include at least the certificate in question's issuer in the chain. Note that the end-entity certificate must appear at array index [0]

checkEntireChain - If this is false, only the status for the first certificate in the chain will be requested. If this is true, the status for the first certificate and as many certificates above it as possible will be requested.

keyStore - The KeyStore that should be used to build up incomplete certificate chains. This parameter is simply passed on to the certificate status providers, so exact usage will depend upon the specific provider.

ticket - A CertificateStatusManagerTicket that can be used to update the Key Store with the new status automatically. If this is null, the Key Store will not be updated.

cookie - An object to associate with this status request. This object will be accessable when the listener is called.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Method Detail

getCertChain

public Certificate[] getCertChain()

Returns the certificate chain associated with this request.

Returns:

An array of certificates.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

checkEntireChain

public boolean checkEntireChain()

Returns true if the status of the entire chain is to be checked.

Returns:

A boolean that indicates if the entire chain will be checked.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getCookie

public Object getCookie()

Returns the cookie object initially passed into the constructor.

Returns:

The cookie.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getOverallStatus

public CertificateStatus getOverallStatus()

Returns the overall certificate status for this request. If the request is for a single certificate, this method returns only that certificate's status. If, however, the request is for an entire certificate chain, a status representing the overall status of the chain is returned, as calculated by the following rules:

• If any certificates in the chain are revoked, the overall status is revoked
• If any certificates in the chain have unknown status, and none are revoked, the overall status is unknown
• If all certificates in the chain are good, the overall status is good

Returns:

A CertificateStatus object describing the status, or null if the status is not available.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getResponseCerts

public Certificate[] getResponseCerts()

Returns the array of certificates for which status was received (in no particular order). This array may differ from the certificate array passed into the constructor initially. For example, if the chain status is requested, it may contain contain additional CA or root cerficiates not initially specified (that would have been found in the Key Store).

Returns:

An array of certificates.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getResponseStatus

public CertificateStatus[] getResponseStatus()

Returns an array containing CertificateStatus objects for each certificate in the response certificate array (returned by getResponseCerts). The status of a given certificate may be found in the element with the same index as the certificate in the response array.

Returns:

An array of CertificateStatus objects describing the status of each certificate in the response, or null in the case of an error.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getErrorMessage

public String getErrorMessage()

Returns a textual error message describing the current error condition, if any. If this method returns a non-null value (when getOverallStatus and getCertificateStatus return null), an error has occurred.

Returns:

A String describing the error condition.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getProviderErrorMessages

public Enumeration getProviderErrorMessages()

Returns an enumeration of strings containing error messages logged by the certificate status providers. Since there may be several providers, multiple error messages may be returned.

Returns:

An enumeration containing the provider error messages ( which are Srings ).

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.