public interface

CertificateProvider

com.microstrategy.web.certificate.CertificateProvider
Known Indirect Subclasses

Class Overview

The CertificateProvider interface represents the contract that a certificate provider will implement to support the Certificate Server application for MicroStrategy Mobile. The Certifiate Provider is instantiated as a singleton - this means the init method will be called once in the application lifecycle, and that any calls to the class should be stateless and thread-safe. A default implementation of CertificateProvider is provided in the DefaultCertificateProvider class. If you are providing custom behavior in the certificate provider, you may either extend DefaultCertificateProvider and override parts of that class, or you may implement a new class that implements this interface.

Summary

Public Methods
abstract CertificateContainer getCertificate(Map<String, String> parameters, String password, String deviceUUID)
This method is deprecated. strongly encouraged to change workflow to use signCertificate(Map, String, String) instead
abstract CertificateCollection getCertificates()
Returns the list of certificates that have been created on the system.
abstract Map<String, String> getInitializationParameters()
Returns initialization parameters.
abstract String getLoginParameters(Locale locale)
Returns an XML representing the list of login parameters the user should be prompted for.
abstract void init(Map<String, String> properties)
Initializes the provider.
abstract void revokeCertificate(String serialNumber)
Revokes the certificate with the given serial number.
abstract String signCertificate(Map<String, String> parameters, String deviceUUID, String csr)
Signs a CSR.

Public Methods

public abstract CertificateContainer getCertificate (Map<String, String> parameters, String password, String deviceUUID)

This method is deprecated.
strongly encouraged to change workflow to use signCertificate(Map, String, String) instead

Attempts to confirm the user is permitted to create a certificate, then creates the certificate, adding it to the certificate list and returning it to the caller as a PKCS 12 encoded file with the given password as the password-protection on the file.

Parameters
parameters The parameters the user entered for authentication.
password The password that should be used to encode the PKCS 12 file.
deviceUUID The device UUID of the user. Used for bookkeeping.
Returns
  • A PKCS 12 formatted file containing a newly signed certificate.
Throws
MSTRCheckedException Thrown if an error occurs.

public abstract CertificateCollection getCertificates ()

Returns the list of certificates that have been created on the system.

Returns
  • A CertificateCollection containing the certificates on the system.
Throws
MSTRCheckedException Thrown if an error occurs.

public abstract Map<String, String> getInitializationParameters ()

Returns initialization parameters.

public abstract String getLoginParameters (Locale locale)

Returns an XML representing the list of login parameters the user should be prompted for. <>

Returns
  • The XML with the login parameters.
Throws
MSTRCheckedException Thrown if an error occurs.

public abstract void init (Map<String, String> properties)

Initializes the provider. The initialization XML is fed to the provider, giving the provider an opportunity to initialize its state as necessary.

Throws
MSTRCheckedException Thrown if an error occurs.

public abstract void revokeCertificate (String serialNumber)

Revokes the certificate with the given serial number. Serial number is represented as a numeric string.

Parameters
serialNumber The serial number of the certificate to revoke.
Throws
MSTRCheckedException Thrown if an error occurs.

public abstract String signCertificate (Map<String, String> parameters, String deviceUUID, String csr)

Signs a CSR.

Parameters
parameters The parameters the user entered for authentication
deviceUUID Unique device identifier
csr Certificate Signing Request
Returns
  • resulting certificates in PEM format - this includes the signed certificate along with the signing certificate chain.