com.manageengine.pam360.sdk.pki

Class Certificate

java.lang.Object

com.manageengine.pam360.sdk.pki.Certificate

public final class Certificate
extends java.lang.Object

Contains methods related to certificate operations

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Certificate.FileType Specifies the type of certificate file to be added

Constructor Summary

Constructors

Constructor and Description
Certificate(PAMService service, APIRequestHandler rest, java.util.Map<java.lang.String,java.lang.String> connectionParams)

Method Summary

Modifier and Type	Method and Description
boolean	add(Certificate.FileType fileType, java.lang.String password, java.lang.String filePath) Add a new certificate file
boolean	createCertificate(CertificateModel certificate) Create a new certificate
boolean	createCSR(CertificateModel certificate) Create a new certificate signing request
boolean	delete(java.lang.String commonName, java.lang.String serialNumber) Delete a certificate
java.lang.String	get(java.lang.String commonName, java.lang.String serialNumber) Get a certificates content
java.util.List<CertificateInfo>	getAll() Get information about all added certificates
java.util.List<CertificateExpiryInfo>	getAllExpiry() Get Expiration details of all the added certificates
java.lang.String	getKeystore(java.lang.String commonName, java.lang.String serialNumber) Get the keystore file content
java.lang.String	getPassphrase(java.lang.String commonName, java.lang.String serialNumber) Get the passphrase of a certificate

Methods inherited from class java.lang.Object

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

Constructor Detail

Certificate

public Certificate(PAMService service,
                   APIRequestHandler rest,
                   java.util.Map<java.lang.String,java.lang.String> connectionParams)
            throws SDKRegistrationException

Throws:

SDKRegistrationException

Method Detail

createCertificate

public boolean createCertificate(CertificateModel certificate)
                          throws SDKInvalidArgumentException,
                                 SDKConnectionException,
                                 SDKOperationFailedException

Create a new certificate

Parameters:

certificate - instance of CertificateModel containing all necessary information required to create a certificate

Returns:

true if account has been successfully share to the user

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

createCSR

public boolean createCSR(CertificateModel certificate)
                  throws SDKInvalidArgumentException,
                         SDKConnectionException,
                         SDKOperationFailedException

Create a new certificate signing request

Parameters:

certificate - instance of CertificateModel containing all necessary information required to create a certificate

Returns:

true if account has been successfully share to the user

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

get

public java.lang.String get(java.lang.String commonName,
                            java.lang.String serialNumber)
                     throws SDKInvalidArgumentException,
                            SDKConnectionException,
                            SDKOperationFailedException

Get a certificates content

Parameters:

commonName - not null, not empty common name of the certificate

serialNumber - optional (can be null or empty), unique identifier of the certificate

Returns:

a string containing contents of a certificate

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

getAll

public java.util.List<CertificateInfo> getAll()
                                       throws SDKConnectionException,
                                              SDKOperationFailedException

Get information about all added certificates

Returns:

a list of CertificateInfo containing information about all certificates

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

getAllExpiry

public java.util.List<CertificateExpiryInfo> getAllExpiry()
                                                   throws SDKConnectionException,
                                                          SDKOperationFailedException

Get Expiration details of all the added certificates

Returns:

list of CertificateExpiryInfo containing expiry info of each certificate

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

getKeystore

public java.lang.String getKeystore(java.lang.String commonName,
                                    java.lang.String serialNumber)
                             throws SDKInvalidArgumentException,
                                    SDKConnectionException,
                                    SDKOperationFailedException

Get the keystore file content

Parameters:

commonName - not null, not empty common name of the certificate

serialNumber - optional can be empty,the serial number of the appropriate certificate

Returns:

keystore content

Throws:

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

getPassphrase

public java.lang.String getPassphrase(java.lang.String commonName,
                                      java.lang.String serialNumber)
                               throws SDKInvalidArgumentException,
                                      SDKConnectionException,
                                      SDKOperationFailedException

Get the passphrase of a certificate

Parameters:

commonName - not null, not empty common name of the certificate whose passphrase has to be fetched

serialNumber - not null, not empty, unique identifier of the certificate

Returns:

passphrase of the certificate in string format

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

add

public boolean add(Certificate.FileType fileType,
                   java.lang.String password,
                   java.lang.String filePath)
            throws SDKConnectionException,
                   SDKOperationFailedException,
                   SDKInvalidArgumentException

Add a new certificate file

MandatoryParams: fileType, password if fileType is fileType.KEYSTORE, filePath

Parameters:

fileType - type of the certificate file. Choose from Certificate.FileType

For CERTFILE fileType, the password field need not be specified

password - password or the passphrase of the certificate file to be added

filePath - system file location (also specify the file extension. eg: C:/user/admin/certificate.cer)

Returns:

true if the certificate is added successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided

delete

public boolean delete(java.lang.String commonName,
                      java.lang.String serialNumber)
               throws SDKInvalidArgumentException,
                      SDKConnectionException,
                      SDKOperationFailedException

Delete a certificate

Parameters:

commonName - not null, not empty common name of the certificate whose passphrase has to be fetched

serialNumber - optional (can be null), unique identifier for each certificate

Returns:

true if certificate has been deleted successfully

Throws:

SDKConnectionException - if unable to connect to the server

SDKOperationFailedException - if server did not provide a proper response for the request, or if action fails. The reason for failure will be provided as a part of the exception's message

SDKInvalidArgumentException - if any of the mandatory field's values are invalid or not provided