com.sap.smp.client.android.certificateprovider

Interface CertificateProvider

All Known Implementing Classes:

CDSProvider, FederationProvider

public interface CertificateProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANDROID_APPID_KEY Used to identify one entry from a HashMap, passed through the argument of {setParameters(Map)}.
static java.lang.String	ANDROID_CONTEXT_KEY Used to identify one entry from a HashMap, passed through the argument of {setParameters(Map)}.

Method Summary

Modifier and Type	Method and Description
void	deleteStoredCertificate() Removes the certificate (and private key) which is stored locally.
void	getCertificate(CertificateProviderListener callback) Deprecated. Not for public use. This method is expected to be retained only as a package private method. Replaced by initialize(CertificateProviderListener callbackObject)
javax.net.ssl.X509KeyManager	getStoredCertificate() Synchronous method to get the certificate from the provider.
void	initialize(CertificateProviderListener callback) Used to initialize the CertificateProvider when appropriate.
void	setParameters(java.util.Map<java.lang.Object,java.lang.Object> params) This method is expected to be retained only as a package private method.

Field Detail

ANDROID_CONTEXT_KEY

static final java.lang.String ANDROID_CONTEXT_KEY

Used to identify one entry from a HashMap, passed through the argument of {setParameters(Map)}. Android context.

See Also:

Constant Field Values

ANDROID_APPID_KEY

static final java.lang.String ANDROID_APPID_KEY

Used to identify one entry from a HashMap, passed through the argument of {setParameters(Map)}. Application ID.

See Also:

Constant Field Values

Method Detail

initialize

void initialize(CertificateProviderListener callback)
         throws CertificateProviderException

Used to initialize the CertificateProvider when appropriate. Can present a native UI screen when needed. The provided callback is used to notify the client about the outcome of the initialization.

Parameters:

callback -

Throws:

CertificateProviderException

getStoredCertificate

javax.net.ssl.X509KeyManager getStoredCertificate()

Synchronous method to get the certificate from the provider. This should provide the certificate which is stored by the provider, it shouldn't access any external server (e.g. Afaria) and it shouldn't show up any UI to enter parameters.

Returns:

keyManager - container for the client certificate and private key, can be null

deleteStoredCertificate

void deleteStoredCertificate()

Removes the certificate (and private key) which is stored locally.

getCertificate

@Deprecated
void getCertificate(CertificateProviderListener callback)

Deprecated. Not for public use. This method is expected to be retained only as a package private method. Replaced by initialize(CertificateProviderListener callbackObject)

Asynchronous callback to get a certificate. The provided callback is used to notify the client about the outcome of the certificate retrieval.

Parameters:

callback -

setParameters

void setParameters(java.util.Map<java.lang.Object,java.lang.Object> params)

This method is expected to be retained only as a package private method.

Parameters:

params - Provider specific parameter map. Reserved keys are:

• ANDROID_CONTEXT_KEY - context passed from caller application used to present activities
• ANDROID_APPID_KEY - application id of the caller application