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

Go to download
/**
 * Copyright © 2017 Dell Inc. or its subsidiaries. All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 */

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

import java.util.List;

import com.dell.cpsd.hdp.capability.registry.api.Capability;
import com.dell.cpsd.hdp.capability.registry.api.Identity;

/**
 * This interface should be implemented by a manager for capability provider registration.
 * 
 * Copyright © 2017 Dell Inc. or its subsidiaries.  All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 * 
 *
 * @since 1.0
 */
public interface ICapabilityRegistryBindingManager
{
    /**
     * This starts the capability registration manager.
     * 
     * @since 1.0
     */
    public void start();

    /**
     * This stops the capability registration manager.
     * 
     * @since 1.0
     */
    public void stop();

    /**
     * This registers the capability profiles for a capability provider.
     * 
     * @param identity
     *            The capability provider identity.
     * @param capabilities
     *            The capabilities of the provider.
     * 
     * @throws CapabilityRegistryException
     *             Thrown if the register fails.
     * 
     * @since 1.0
     */
    void registerCapabilityProvider(final Identity identity, final List capabilities) throws CapabilityRegistryException;

    /**
     * This unregisters the capability profiles for a capability provider.
     * 
     * @param identity
     *            The capability provider identity.
     * 
     * @throws CapabilityRegistryException
     *             Thrown if the unregister fails.
     * 
     * @since 1.0
     */
    void unregisterCapabilityProvider(final Identity identity) throws CapabilityRegistryException;
}