org.nhindirect.config.service
Interface CertificateService

All Known Subinterfaces:

ConfigurationService

All Known Implementing Classes:

CertificateServiceImpl, ConfigurationServiceImpl

public interface CertificateService

Service class for methods related to a Certificate object.

Method Summary

void	addCertificates(Collection<Certificate> certs) Add a Certificate.
boolean	contains(Certificate cert) Determines if a certificate exists in the certificate store.
Certificate	getCertificate(String owner, String thumbprint, CertificateGetOptions options) Get a Certificate.
Collection<Certificate>	getCertificates(Collection<Long> certificateIds, CertificateGetOptions options) Get a collection of Certificates.
Collection<Certificate>	getCertificatesForOwner(String owner, CertificateGetOptions options) Get a collection of Certificates for an owner.
Collection<Certificate>	listCertificates(long lastCertificateId, int maxResults, CertificateGetOptions options) Get a collection of Certificates.
void	removeCertificates(Collection<Long> certificateIds) Remove a Certificate.
void	removeCertificatesForOwner(String owner) Remove the Certificates for an owner.
void	setCertificateStatus(Collection<Long> certificateIds, EntityStatus status) Set a Certificate status.
void	setCertificateStatusForOwner(String owner, EntityStatus status) Set the Certificate status for an owner.

Method Detail

addCertificates

void addCertificates(Collection<Certificate> certs)
                     throws ConfigurationServiceException

Add a Certificate.

Parameters:

certs - The Certificate.

Throws:

ConfigurationServiceException

getCertificate

Certificate getCertificate(String owner,
                           String thumbprint,
                           CertificateGetOptions options)
                           throws ConfigurationServiceException

Get a Certificate.

Parameters:

owner - The Certificate owner.

thumbprint - The Certificate thumbprint.

options - The Certificate options.

Returns:

a Certificate.

Throws:

ConfigurationServiceException

getCertificates

Collection<Certificate> getCertificates(Collection<Long> certificateIds,
                                        CertificateGetOptions options)
                                        throws ConfigurationServiceException

Get a collection of Certificates.

Parameters:

certificateIds - A collection of Certificate IDs.

options - The Certificate options.

Returns:

a collection of Certificates.

Throws:

ConfigurationServiceException

getCertificatesForOwner

Collection<Certificate> getCertificatesForOwner(String owner,
                                                CertificateGetOptions options)
                                                throws ConfigurationServiceException

Get a collection of Certificates for an owner.

Parameters:

owner - The Certificate owner.

options - The Certificate options.

Returns:

a collection of Certificates.

Throws:

ConfigurationServiceException

setCertificateStatus

void setCertificateStatus(Collection<Long> certificateIds,
                          EntityStatus status)
                          throws ConfigurationServiceException

Set a Certificate status.

Parameters:

certificateIds - A collection of Certificates.

status - The Certificate status.

Throws:

ConfigurationServiceException

setCertificateStatusForOwner

void setCertificateStatusForOwner(String owner,
                                  EntityStatus status)
                                  throws ConfigurationServiceException

Set the Certificate status for an owner.

Parameters:

owner - The Certificate owner.

status - The Certificate status.

Throws:

ConfigurationServiceException

removeCertificates

void removeCertificates(Collection<Long> certificateIds)
                        throws ConfigurationServiceException

Remove a Certificate.

Parameters:

certificateIds - A collection of Certificate IDs.

Throws:

ConfigurationServiceException

removeCertificatesForOwner

void removeCertificatesForOwner(String owner)
                                throws ConfigurationServiceException

Remove the Certificates for an owner.

Parameters:

owner - The Certificate owner.

Throws:

ConfigurationServiceException

listCertificates

Collection<Certificate> listCertificates(long lastCertificateId,
                                         int maxResults,
                                         CertificateGetOptions options)
                                         throws ConfigurationServiceException

Get a collection of Certificates.

Parameters:

lastCertificateId - The last Certificate ID.

maxResults - The maximum number of results.

options - The Certificate options.

Returns:

a collection of Certificates.

Throws:

ConfigurationServiceException

contains

boolean contains(Certificate cert)

Determines if a certificate exists in the certificate store. Although not specific in the interface definition, certificate thumbprinting is recommended for certificate searching.

Parameters:

cert - The certificate to search for.

Returns:

True if the certificate exist in the store. False otherwise.