com.dell.cpsd.hdp.capability.registry.client.binder.CapabilityBindingService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hdp-capability-registry-client Show documentation

This repository contains the source code for the capability registry API. This API exposes the interface through which a consumer or provider interacts with the capability registry.

There is a newer version: 1.1.0

Show newest version

/**
 * Copyright © 2017 Dell Inc. or its subsidiaries.  All Rights Reserved.
 */

package com.dell.cpsd.hdp.capability.registry.client.binder;

import java.util.List;

import com.dell.cpsd.hdp.capability.registry.client.CapabilityRegistryException;
import com.dell.cpsd.service.common.client.exception.ServiceTimeoutException;

/**
 * 
 * Copyright © 2017 Dell Inc. or its subsidiaries.  All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 * 
 *
 * @since 1.0
 */
public interface CapabilityBindingService
{
    /**
     * Looks up capabilities using the specified capability matchers
     * 
     * @param matchers
     *            The matchers array
     * @return List of capability data matched the capability matcher
     * @throws CapabilityRegistryException
     *             Thrown if the request fails.
     * @throws ServiceTimeoutException
     *             Thrown if the request times out.
     */
    List lookupCapabilities(CapabilityMatcher... matchers) throws CapabilityRegistryException, ServiceTimeoutException;

    /**
     * Looks up capabilities using the specified capability matchers
     * 
     * @param matchers
     *            The matchers list
     * @return List of capability data matched the capability matcher
     * @throws CapabilityRegistryException
     *             Thrown if the request fails.
     * @throws ServiceTimeoutException
     *             Thrown if the request times out.
     */
    List lookupCapabilities(List matchers) throws CapabilityRegistryException, ServiceTimeoutException;

    /**
     * Adds a capability
     * 
     * @param capabilityData
     *            The capability data
     * @throws CapabilityRegistryException
     *             Thrown if the request fails.
     */
    void add(CapabilityData capabilityData) throws CapabilityRegistryException;

    /**
     * Removes capability
     * 
     * @param capabilityData
     *            The capability data
     * @throws CapabilityRegistryException
     *             Thrown if the request fails.
     */
    void remove(CapabilityData capabilityData) throws CapabilityRegistryException;
}