org.nhindirect.config.service
Interface AnchorService

All Known Subinterfaces:
ConfigurationService
All Known Implementing Classes:
AnchorServiceImpl, ConfigurationServiceImpl

public interface AnchorService

Service class for methods related to an Anchor object.


Method Summary
 void addAnchors(Collection<Anchor> anchors)
          Add a collection of Anchors.
 Anchor getAnchor(String owner, String thumbprint, CertificateGetOptions options)
          Get an Anchor.
 Collection<Anchor> getAnchors(Collection<Long> anchorIds, CertificateGetOptions options)
          Get a collection of Anchors.
 Collection<Anchor> getAnchorsForOwner(String owner, CertificateGetOptions options)
          Get a collection of Anchors for an owner.
 Collection<Anchor> getIncomingAnchors(String owner, CertificateGetOptions options)
          Get a collection of incoming Anchors.
 Collection<Anchor> getOutgoingAnchors(String owner, CertificateGetOptions options)
          Get a collection of outgoing Anchors.
 Collection<Anchor> listAnchors(Long lastAnchorID, int maxResults, CertificateGetOptions options)
          Get a collection of Anchors.
 void removeAnchors(Collection<Long> anchorIds)
          Remove an Anchor.
 void removeAnchorsForOwner(String owner)
          Remove the Anchors for an owner.
 void setAnchorStatusForOwner(String owner, EntityStatus status)
          Set an Anchor status for a given owner.
 

Method Detail

addAnchors

void addAnchors(Collection<Anchor> anchors)
                throws ConfigurationServiceException
Add a collection of Anchors.

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

getAnchor

Anchor getAnchor(String owner,
                 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

Collection<Anchor> getAnchors(Collection<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

Collection<Anchor> getAnchorsForOwner(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

Collection<Anchor> getIncomingAnchors(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

Collection<Anchor> getOutgoingAnchors(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(String owner,
                             EntityStatus status)
                             throws ConfigurationServiceException
Set an Anchor status for a given owner.

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

listAnchors

Collection<Anchor> listAnchors(Long lastAnchorID,
                               int maxResults,
                               CertificateGetOptions options)
                               throws ConfigurationServiceException
Get a collection of Anchors.

Parameters:
lastAnchorID - The last Anchor ID.
maxResults - The maximum number of results.
options - The Anchor options.
Returns:
a collection of Anchors.
Throws:
ConfigurationServiceException

removeAnchors

void removeAnchors(Collection<Long> anchorIds)
                   throws ConfigurationServiceException
Remove an Anchor.

Parameters:
anchorIds - A collection of Anchor IDs.
Throws:
ConfigurationServiceException

removeAnchorsForOwner

void removeAnchorsForOwner(String owner)
                           throws ConfigurationServiceException
Remove the Anchors for an owner.

Parameters:
owner - The Anchor owner.
Throws:
ConfigurationServiceException


Copyright © 2010. All Rights Reserved.