com.dell.cpsd.hdp.capability.registry.client.ICapabilityRegistryNotifier 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.
 * Dell EMC Confidential/Proprietary Information
 */

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

import com.dell.cpsd.hdp.capability.registry.api.CapabilityProvider;

/**
 * This interface should be implemented to notify capability registries that the provider is running.
 * 
 * Copyright © 2017 Dell Inc. or its subsidiaries.  All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 * 
 *
 * @since 1.0
 */
public interface ICapabilityRegistryNotifier
{
    /**
     * This sets the capability provider information.
     * 
     * @param capabilityProvider
     *            The capability provider information.
     * 
     * @since 1.0
     */
    public void setCapabilityProvider(final CapabilityProvider capabilityProvider);

    /**
     * This starts notifying the capability registries.
     * 
     * @since 1.0
     */
    public void start();

    /**
     * This method notifies capability registries.
     * 
     * @throws CapabilityRegistryException
     *             Thrown if the notification fails.
     * 
     * @since 1.0
     */
    public void notifyRegistry() throws CapabilityRegistryException;

    /**
     * This stops notifying the capability registries.
     * 
     * @since 1.0
     */
    public void stop();
}