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

All Known Subinterfaces:

ConfigurationService

All Known Implementing Classes:

AnchorServiceImpl, ConfigurationServiceImpl
```
public interface AnchorService
```
Service class for methods related to an Anchor object.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAnchors(java.util.Collection<org.nhindirect.config.store.Anchor> anchors)` Add a collection of Anchors.
`org.nhindirect.config.store.Anchor`	`getAnchor(java.lang.String owner, java.lang.String thumbprint, CertificateGetOptions options)` Get an Anchor.
`java.util.Collection<org.nhindirect.config.store.Anchor>`	`getAnchors(java.util.Collection<java.lang.Long> anchorIds, CertificateGetOptions options)` Get a collection of Anchors.
`java.util.Collection<org.nhindirect.config.store.Anchor>`	`getAnchorsForOwner(java.lang.String owner, CertificateGetOptions options)` Get a collection of Anchors for an owner.
`java.util.Collection<org.nhindirect.config.store.Anchor>`	`getIncomingAnchors(java.lang.String owner, CertificateGetOptions options)` Get a collection of incoming Anchors.
`java.util.Collection<org.nhindirect.config.store.Anchor>`	`getOutgoingAnchors(java.lang.String owner, CertificateGetOptions options)` Get a collection of outgoing Anchors.
`java.util.Collection<org.nhindirect.config.store.Anchor>`	`listAnchors(java.lang.Long lastAnchorID, int maxResults, CertificateGetOptions options)` Get a collection of Anchors.
`void`	`removeAnchors(java.util.Collection<java.lang.Long> anchorIds)` Remove an Anchor.
`void`	`removeAnchorsForOwner(java.lang.String owner)` Remove the Anchors for an owner.
`void`	`setAnchorStatusForOwner(java.lang.String owner, org.nhindirect.config.store.EntityStatus status)` Set an Anchor status for a given owner.

Method Detail

addAnchors

void addAnchors(java.util.Collection<org.nhindirect.config.store.Anchor> anchors)
                throws ConfigurationServiceException

Add a collection of Anchors.

Parameters:: anchors - A collection of Anchors.
Throws:: ConfigurationServiceException

getAnchor

org.nhindirect.config.store.Anchor getAnchor(java.lang.String owner,
                                           java.lang.String thumbprint,
                                           CertificateGetOptions options)
                                             throws ConfigurationServiceException

Get an Anchor.

Parameters:: owner - The Anchor owner.; thumbprint - The Anchor thumbprint.; options - The Anchor options.
Returns:: an Anchor.
Throws:: ConfigurationServiceException

getAnchors

java.util.Collection<org.nhindirect.config.store.Anchor> getAnchors(java.util.Collection<java.lang.Long> anchorIds,
                                                                  CertificateGetOptions options)
                                                                    throws ConfigurationServiceException

Get a collection of Anchors.

Parameters:: anchorIds - A collection of Anchor IDs.; options - The Anchor options.
Returns:: a collection of Anchors.
Throws:: ConfigurationServiceException

getAnchorsForOwner

java.util.Collection<org.nhindirect.config.store.Anchor> getAnchorsForOwner(java.lang.String owner,
                                                                          CertificateGetOptions options)
                                                                            throws ConfigurationServiceException

Get a collection of Anchors for an owner.

Parameters:: owner - The Anchor owner.; options - The Anchor options.
Returns:: a collection of Anchors.
Throws:: ConfigurationServiceException

getIncomingAnchors

java.util.Collection<org.nhindirect.config.store.Anchor> getIncomingAnchors(java.lang.String owner,
                                                                          CertificateGetOptions options)
                                                                            throws ConfigurationServiceException

Get a collection of incoming Anchors.

Parameters:: owner - The Anchor owner.; options - The Anchor options.
Returns:: a collection of Anchors.
Throws:: ConfigurationServiceException

getOutgoingAnchors

java.util.Collection<org.nhindirect.config.store.Anchor> getOutgoingAnchors(java.lang.String owner,
                                                                          CertificateGetOptions options)
                                                                            throws ConfigurationServiceException

Get a collection of outgoing Anchors.

Parameters:: owner - The Anchor owner.; options - The Anchor options.
Returns:: a collection of Anchors.
Throws:: ConfigurationServiceException

setAnchorStatusForOwner

void setAnchorStatusForOwner(java.lang.String owner,
                           org.nhindirect.config.store.EntityStatus status)
                             throws ConfigurationServiceException

Set an Anchor status for a given owner.

Parameters:: owner - The anchor owner.; status - The anchor status.
Throws:: ConfigurationServiceException

listAnchors

java.util.Collection<org.nhindirect.config.store.Anchor> listAnchors(java.lang.Long lastAnchorID,
                                                                   int maxResults,
                                                                   CertificateGetOptions options)
                                                                     throws ConfigurationServiceException