SHOW Signed SHOW CryptoExtensionAPI
 

net.rim.device.api.crypto.certificate.status
Interface ProviderRequestData


public interface ProviderRequestData

Encapsulates information to be sent from the device to the proxy during a certificate status request. Provider plugins can add the appropriate data to this interface on the device, and the matching plugins on the proxy can access the same data through a similar interface. Each provider is given its own ProviderRequestData.

There are two types of fields available using this interface: global fields and certificate fields. Global fields are data or parameters that are common for the request as a whole (an example may be the names of servers to contact from the proxy). Certificate fields contain information unique per certificate (for example, a status protocol may require the subject and issuer distinguished names for each certificate in the status request). Additionally, context information can be preserved on the device during the request process. The context object passed into this interface will be made available when the request is received from the proxy and decoded. It will not be sent to the proxy.

Category:
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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:
JDE 3.6.0
See Also:
ProviderResponseData

Method Summary
 Category: CryptoExtensionAPI Category: Signed  void addCertField(Certificate cert, int tag, byte[] value)
          Adds a data field, associated with a particular certificate, to this request data.
 Category: CryptoExtensionAPI Category: Signed  void addGlobalField(int tag, byte[] value)
          Adds a global data field (for this request) to this request data.
 Category: CryptoExtensionAPI Category: Signed  void setContextObject(Object context)
          Adds context information to this request.
 

Method Detail

addCertField

public void addCertField(Certificate cert,
                         int tag,
                         byte[] value)
Adds a data field, associated with a particular certificate, to this request data.

This field is unique to the specified certificate and will not overwrite similar fields for other certificates.

Parameters:
cert - The certificate to associate this data with.
tag - An integer value (in the range 0 to 255) that identifies this data.
value - The data to associate with the given tag.
Since:
JDE 3.6.0
Category:
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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.

addGlobalField

public void addGlobalField(int tag,
                           byte[] value)
Adds a global data field (for this request) to this request data.

Parameters:
tag - An integer value that identifies this data (this value must be in the range of 0 to 255).
value - The data to associate with the given tag.
Since:
JDE 3.6.0
Category:
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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.

setContextObject

public void setContextObject(Object context)
Adds context information to this request.

This data is not sent to the proxy, but is made available when the response is received from the proxy, providing a convenient way of preserving any stateful information during the transaction.

Parameters:
context - An object containing context information.
Since:
JDE 3.6.0
Category:
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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.



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.