org.nhindirect.config.service.AnchorService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of config-service-jar Show documentation
NHIN Direct Java RI config service jar.
There is a newer version: 8.0.5
/* 
Copyright (c) 2010, NHIN Direct Project
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this Collection of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this Collection of conditions and the following disclaimer 
   in the documentation and/or other materials provided with the distribution.  
3. Neither the name of the The NHIN Direct Project (nhindirect.org) nor the names of its contributors may be used to endorse or promote 
   products derived from this software without specific prior written permission.
   
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.nhindirect.config.service;

import java.util.Collection;

import javax.jws.WebMethod;
import javax.jws.WebParam;

import org.nhindirect.config.service.impl.CertificateGetOptions;
import org.nhindirect.config.store.Anchor;
import org.nhindirect.config.store.EntityStatus;

/**
 * Service class for methods related to an Anchor object.
 */
public interface AnchorService {

    /**
     * Add a collection of Anchors.
     * 
     * @param anchors
     *            A collection of Anchors.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "addAnchor", action = "urn:AddAnchor")
    public void addAnchors(@WebParam(name = "anchor") Collection anchors) throws ConfigurationServiceException;

    /**
     * Get an Anchor.
     * 
     * @param owner
     *            The Anchor owner.
     * @param thumbprint
     *            The Anchor thumbprint.
     * @param options
     *            The Anchor options.
     * @return an Anchor.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "getAnchor", action = "urn:GetAnchor")
    public Anchor getAnchor(@WebParam(name = "owner") String owner, @WebParam(name = "thumbprint") String thumbprint,
            @WebParam(name = "options") CertificateGetOptions options) throws ConfigurationServiceException;

    /**
     * Get a collection of Anchors.
     * 
     * @param anchorIds
     *            A collection of Anchor IDs.
     * @param options
     *            The Anchor options.
     * @return a collection of Anchors.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "getAnchors", action = "urn:GetAnchors")
    public Collection getAnchors(@WebParam(name = "anchorId") Collection anchorIds,
            @WebParam(name = "options") CertificateGetOptions options) throws ConfigurationServiceException;

    /**
     * Get a collection of Anchors for an owner.
     * 
     * @param owner
     *            The Anchor owner.
     * @param options
     *            The Anchor options.
     * @return a collection of Anchors.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "getAnchorsForOwner", action = "urn:GetAnchorsForOwner")
    public Collection getAnchorsForOwner(@WebParam(name = "owner") String owner,
            @WebParam(name = "options") CertificateGetOptions options) throws ConfigurationServiceException;

    /**
     * Get a collection of incoming Anchors.
     * 
     * @param owner
     *            The Anchor owner.
     * @param options
     *            The Anchor options.
     * @return a collection of Anchors.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "getIncomingAnchors", action = "urn:GetIncomingAnchors")
    public Collection getIncomingAnchors(@WebParam(name = "owner") String owner,
            @WebParam(name = "options") CertificateGetOptions options) throws ConfigurationServiceException;

    /**
     * Get a collection of outgoing Anchors.
     * 
     * @param owner
     *            The Anchor owner.
     * @param options
     *            The Anchor options.
     * @return a collection of Anchors.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "getOutgoingAnchors", action = "urn:GetOutgoingAnchors")
    public Collection getOutgoingAnchors(@WebParam(name = "owner") String owner,
            @WebParam(name = "options") CertificateGetOptions options) throws ConfigurationServiceException;

    /**
     * Set an Anchor status for a given owner.
     * 
     * @param owner
     *            The anchor owner.
     * @param status
     *            The anchor status.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "setAnchorStatusForOwner", action = "urn:SetAnchorStatusForOwner")
    public void setAnchorStatusForOwner(@WebParam(name = "owner") String owner,
            @WebParam(name = "status") EntityStatus status) throws ConfigurationServiceException;

    /**
     * Get a collection of Anchors.
     * 
     * @param lastAnchorID
     *            The last Anchor ID.
     * @param maxResults
     *            The maximum number of results.
     * @param options
     *            The Anchor options.
     * @return a collection of Anchors.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "listAnchors", action = "urn:ListAnchors")
    public Collection listAnchors(@WebParam(name = "lastAnchorId") Long lastAnchorID,
            @WebParam(name = "maxResults") int maxResults, @WebParam(name = "options") CertificateGetOptions options)
            throws ConfigurationServiceException;

    /**
     * Remove an Anchor.
     * 
     * @param anchorIds
     *            A collection of Anchor IDs.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "removeAnchors", action = "urn:RemoveAnchors")
    public void removeAnchors(@WebParam(name = "anchorId") Collection anchorIds)
            throws ConfigurationServiceException;

    /**
     * Remove the Anchors for an owner.
     * 
     * @param owner
     *            The Anchor owner.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "removeAnchorsForOwner", action = "urn:RemoveAnchorsForOwner")
    public void removeAnchorsForOwner(@WebParam(name = "owner") String owner) throws ConfigurationServiceException;

}