com.adobe.truststore.client
Class CertificateServiceClient

java.lang.Object
  com.adobe.truststore.client.CertificateServiceClient

public class CertificateServiceClient
extends java.lang.Object

The CertificateServiceClient class enables you to programmatically interact with the LiveCycle ES2 Credential service. Using an obbject of this type, you can perform tasks such as importing and deleting certificates. A certificate is public key information that you configure for trust. LiveCycle ES2 uses certificates and credentials for several purposes:

• LiveCycle Reader Extensions ES2 uses a credential to enable Adobe Reader usage rights in PDF documents.
• The Signature service accesses certificates and credentials while performing operations such as digitally signing PDF documents.

To see an object of this type used in a code example, see the <>Importing certificates using the Java API<> quick start in Programming with LiveCycle ES4.

Constructor Summary

CertificateServiceClient(ServiceClientFactory serviceClientFactory)

Method Summary

void	addCertificate(com.adobe.truststore.businessobject.CertificateBO certificate) Adds a certificate to LiveCycle ES2.
void	deleteCertificate(java.lang.String alias) Deletes a certificate from LiveCycle ES2.
void	deregisterCacheInvalidationHandler(java.lang.String serviceName, java.lang.String operationName) deregisterCacheInvalidationHandler
Document	exportCertificate(java.lang.String alias) Exports a certificate from LiveCycle ES2.
java.util.List	findAllCertificates()
com.adobe.truststore.businessobject.CertificateBO	findCertificateByAlias(java.lang.String alias)
java.util.List	findCertificates(com.adobe.truststore.businessobject.CertificateSearchFilter searchFilter) Searches for a certificate based on search criteria.
java.lang.String	getCertificatePolicyOIDs(java.lang.String alias) Retrieves certificate OID values that exist within LiveCycle ES2.
com.adobe.truststore.businessobject.CertificateType[]	getCertificateTypes(java.lang.String locale) Retrieves certificate types that exist within LiveCycle ES2.
void	importCertificate(java.lang.String alias, Document binaryCertificate, java.lang.String[] types) Imports a certificate into LiveCycle ES2.
void	registerCacheInvalidationHandler(java.lang.String serviceName, java.lang.String operationName) registerCacheInvalidationHandler
void	setCertificatePolicyOIDs(java.lang.String alias, java.lang.String policyOIDs) This is an internal method.
void	setCertificateTypes(java.lang.String alias, java.lang.String[] certificateTypes) This is an internal method.
void	updateCertificate(java.lang.String alias, com.adobe.truststore.businessobject.CertificateBO certificate) Updates a certificate that exists within LiveCycle ES2.

Methods inherited from class java.lang.Object

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

Constructor Detail

CertificateServiceClient

public CertificateServiceClient(ServiceClientFactory serviceClientFactory)

Method Detail

getCertificateTypes

public com.adobe.truststore.businessobject.CertificateType[] getCertificateTypes(java.lang.String locale)
                                                                          throws java.lang.Exception

Retrieves certificate types that exist within LiveCycle ES2.

Parameters:

locale - The locate value of the certificate.

Returns:

An array of CertificateType objects.

Throws:

java.lang.Exception

getCertificatePolicyOIDs

public java.lang.String getCertificatePolicyOIDs(java.lang.String alias)
                                          throws java.lang.Exception

Retrieves certificate OID values that exist within LiveCycle ES2.

Parameters:

locale - The locate value of the certificate.

Returns:

A string value that specify the certificate OID value.

Throws:

java.lang.Exception

addCertificate

public void addCertificate(com.adobe.truststore.businessobject.CertificateBO certificate)
                    throws java.lang.Exception

Adds a certificate to LiveCycle ES2.

Parameters:

certificate - A CertificateBO object that represents the certificate to add.

Throws:

java.lang.Exception

importCertificate

public void importCertificate(java.lang.String alias,
                              Document binaryCertificate,
                              java.lang.String[] types)
                       throws java.lang.Exception

Imports a certificate into LiveCycle ES2. To see this method used in a code example, see the Importing certificates using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

alias - A string value that specifies the alias value for the certificate. This value is used when performing LiveCycle ES2 operations that use the certificate.

alias - binaryCertificate A com.adobe.idp.Document instance that represents the certificate.

types - A string array that contains the usage value. For example, you can specify truststore.usage.type.sign.

Throws:

java.lang.Exception

exportCertificate

public Document exportCertificate(java.lang.String alias)
                           throws java.lang.Exception

Exports a certificate from LiveCycle ES2.

Parameters:

alias - The alias value that is used to reference the certificate to export.

Returns:

A com.adobe.idp.Document object that represents the exported certificate.

Throws:

java.lang.Exception

deleteCertificate

public void deleteCertificate(java.lang.String alias)
                       throws java.lang.Exception

Deletes a certificate from LiveCycle ES2. To see this method used in a code example, see the Deleting certificates using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

alias - The alias value that is used to reference the certificate to delete.

Throws:

java.lang.Exception

updateCertificate

public void updateCertificate(java.lang.String alias,
                              com.adobe.truststore.businessobject.CertificateBO certificate)
                       throws java.lang.Exception

Updates a certificate that exists within LiveCycle ES2.

Parameters:

alias - The alias value that is used to reference the certificate to update.

certificate - A CertificateBO object that represents the updated certificate.

Throws:

java.lang.Exception

setCertificateTypes

public void setCertificateTypes(java.lang.String alias,
                                java.lang.String[] certificateTypes)
                         throws java.lang.Exception

This is an internal method. Do not invoke this method.

Throws:

java.lang.Exception

setCertificatePolicyOIDs

public void setCertificatePolicyOIDs(java.lang.String alias,
                                     java.lang.String policyOIDs)
                              throws java.lang.Exception

This is an internal method. Do not invoke this method.

Throws:

java.lang.Exception

findCertificates

public java.util.List findCertificates(com.adobe.truststore.businessobject.CertificateSearchFilter searchFilter)
                                throws java.lang.Exception

Searches for a certificate based on search criteria.

Parameters:

searchFilter - A CertificateSearchFilter that represents the certificate search criteria.

Returns:

A CertificateSearchFilter instance that contains certificate that match the search criteria.

Throws:

java.lang.Exception

findAllCertificates

public java.util.List findAllCertificates()
                                   throws java.lang.Exception

Throws:

java.lang.Exception

findCertificateByAlias

public com.adobe.truststore.businessobject.CertificateBO findCertificateByAlias(java.lang.String alias)
                                                                         throws java.lang.Exception

Throws:

java.lang.Exception

registerCacheInvalidationHandler

public void registerCacheInvalidationHandler(java.lang.String serviceName,
                                             java.lang.String operationName)
                                      throws java.lang.Exception

registerCacheInvalidationHandler

Throws:

java.lang.Exception

deregisterCacheInvalidationHandler

public void deregisterCacheInvalidationHandler(java.lang.String serviceName,
                                               java.lang.String operationName)
                                        throws java.lang.Exception

deregisterCacheInvalidationHandler

Throws:

java.lang.Exception