CertificateService (NHIN Direct Java RI config service jar 2.1.1 API)

All Known Subinterfaces:

ConfigurationService

All Known Implementing Classes:

CertificateServiceImpl, ConfigurationServiceImpl
```
public interface CertificateService
```
Service class for methods related to a Certificate object.

Method Summary

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

Method Detail

addCertificates

void addCertificates(java.util.Collection<org.nhindirect.config.store.Certificate> certs)
                     throws ConfigurationServiceException

Add a Certificate.

Parameters:: certs - The Certificate.
Throws:: ConfigurationServiceException

getCertificate

org.nhindirect.config.store.Certificate getCertificate(java.lang.String owner,
                                                     java.lang.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

java.util.Collection<org.nhindirect.config.store.Certificate> getCertificates(java.util.Collection<java.lang.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

java.util.Collection<org.nhindirect.config.store.Certificate> getCertificatesForOwner(java.lang.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(java.util.Collection<java.lang.Long> certificateIds,
                        org.nhindirect.config.store.EntityStatus status)
                          throws ConfigurationServiceException

Set a Certificate status.

Parameters:: certificateIds - A collection of Certificates.; status - The Certificate status.
Throws:: ConfigurationServiceException

setCertificateStatusForOwner

void setCertificateStatusForOwner(java.lang.String owner,
                                org.nhindirect.config.store.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(java.util.Collection<java.lang.Long> certificateIds)
                        throws ConfigurationServiceException

Remove a Certificate.

Parameters:: certificateIds - A collection of Certificate IDs.
Throws:: ConfigurationServiceException

removeCertificatesForOwner
```
void removeCertificatesForOwner(java.lang.String owner)
                                throws ConfigurationServiceException
```
Remove the Certificates for an owner.

Parameters:
owner - The Certificate owner.

Throws:

ConfigurationServiceException

listCertificates

java.util.Collection<org.nhindirect.config.store.Certificate> listCertificates(long lastCertificateId,
                                                                             int maxResults,
                                                                             CertificateGetOptions options)
                                                                               throws ConfigurationServiceException