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

java.lang.Object
  extended by 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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

Field Summary
Category: Signed static int CERTIFICATE_ALREADY_REVOKED
           
Category: Signed static int FATAL_INTERNAL_ERROR
           
Category: Signed static int MALFORMED_RESPONSE
           
Category: Signed static int NO_SERVICE_BOOK_ENTRY
           
Category: Signed static int NO_STATUS_PROVIDERS
           
Category: Signed static int PROVIDER_DECODING_ERROR
           
Category: Signed static int PROVIDER_ENCODING_ERROR
           
Category: Signed static int PROXY_CONNECTION_ERROR
           
Category: Signed static int PROXY_INTERNAL_ERROR
           
Category: Signed static int PROXY_IO_ERROR
           
Category: Signed static int PROXY_MALFORMED_REQUEST
           
Category: Signed static int PROXY_NO_PROVIDERS
           
Category: Signed static int PROXY_PROVIDER_ERROR
           
Category: Signed static int PROXY_VERSION_INCORRECT
           
Category: Signed static int RADIO_IS_OFF
           
Category: Signed static int SERVICE_NOT_AVAILABLE
           
Category: Signed static int SUCCESSFUL
           
Category: Signed static int UPDATING_HANDHELD_STATUS_FAILED
           
 
Constructor Summary
Category: Signed CertificateStatusRequest(Certificate[] certChain, boolean checkEntireChain, KeyStore keyStore, CertificateStatusManagerTicket ticket, Object cookie)
          Creates a new CertificateStatusRequest for the given certificate or certificate chain.
 
Method Summary
Category: Signed  boolean checkEntireChain()
          Returns true if the status of the entire chain is to be checked.
Category: Signed  boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.
Category: Signed  Certificate[] getCertChain()
          Returns the certificate chain associated with this request.
Category: Signed  Object getCookie()
          Returns the cookie object initially passed into the constructor.
Category: Signed  int getErrorCode()
          Returns a code that describes the overall outcome of the request.
Category: Signed  String getErrorMessage()
          Returns a textual error message describing the current error condition, if any.
Category: Signed  CertificateStatus getOverallStatus()
          Returns the overall certificate status for this request.
Category: Signed  Enumeration getProviderErrorMessages()
          Returns an enumeration of strings containing error messages logged by the certificate status providers.
Category: Signed  Certificate[] getResponseCerts()
          Returns the array of certificates for which status was received (in no particular order).
Category: Signed  CertificateStatus[] getResponseStatus()
          Returns an array containing CertificateStatus objects for each certificate in the response certificate array (returned by getResponseCerts).
Category: Signed  int hashCode()
          Returns a hash code value for the object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

SUCCESSFUL

public static final int SUCCESSFUL
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

CERTIFICATE_ALREADY_REVOKED

public static final int CERTIFICATE_ALREADY_REVOKED
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

NO_STATUS_PROVIDERS

public static final int NO_STATUS_PROVIDERS
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

NO_SERVICE_BOOK_ENTRY

public static final int NO_SERVICE_BOOK_ENTRY
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

RADIO_IS_OFF

public static final int RADIO_IS_OFF
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

MALFORMED_RESPONSE

public static final int MALFORMED_RESPONSE
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

PROVIDER_ENCODING_ERROR

public static final int PROVIDER_ENCODING_ERROR
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

PROVIDER_DECODING_ERROR

public static final int PROVIDER_DECODING_ERROR
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

FATAL_INTERNAL_ERROR

public static final int FATAL_INTERNAL_ERROR
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

PROXY_CONNECTION_ERROR

public static final int PROXY_CONNECTION_ERROR
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

PROXY_IO_ERROR

public static final int PROXY_IO_ERROR
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

PROXY_VERSION_INCORRECT

public static final int PROXY_VERSION_INCORRECT
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

PROXY_MALFORMED_REQUEST

public static final int PROXY_MALFORMED_REQUEST
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

PROXY_NO_PROVIDERS

public static final int PROXY_NO_PROVIDERS
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

PROXY_PROVIDER_ERROR

public static final int PROXY_PROVIDER_ERROR
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

PROXY_INTERNAL_ERROR

public static final int PROXY_INTERNAL_ERROR
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

UPDATING_HANDHELD_STATUS_FAILED

public static final int UPDATING_HANDHELD_STATUS_FAILED
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

SERVICE_NOT_AVAILABLE

public static final int SERVICE_NOT_AVAILABLE
See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.2.0


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 may prompt later if the status changes
cookie - An object to associate with this status request. This object will be accessable when the listener is called.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0


Method Detail

hashCode

public int hashCode()
Description copied from class: Object
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), Hashtable
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

equals

public boolean equals(Object o)
Description copied from class: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:
equals in class Object
Parameters:
o - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Boolean.hashCode(), Hashtable
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

getCertChain

public Certificate[] getCertChain()
Returns the certificate chain associated with this request.

Returns:
An array of certificates.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

getCookie

public Object getCookie()
Returns the cookie object initially passed into the constructor.

Returns:
The cookie.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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:

Returns:
A CertificateStatus object describing the status, or null if the status is not available.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

getErrorCode

public int getErrorCode()
Returns a code that describes the overall outcome of the request. Possible codes are defined in CertificateStatusQuery.

Returns:
The overall return code for the request.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.0.0

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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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 ).
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal