com.dell.cpsd.hdp.capability.registry.client.ICapabilityRegistryLookupManager 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 java.util.List;

import com.dell.cpsd.hdp.capability.registry.api.Query;
import com.dell.cpsd.hdp.capability.registry.client.callback.ListCapabilityProvidersResponse;
import com.dell.cpsd.hdp.capability.registry.client.callback.LookupCapabilityRegistryResponse;
import com.dell.cpsd.service.common.client.exception.ServiceTimeoutException;

/**
 * This interface should be implemented by a capability registry manager.
 * 
 * Copyright © 2017 Dell Inc. or its subsidiaries.  All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 * 
 *
 * @since 1.0
 */
public interface ICapabilityRegistryLookupManager
{
    /**
     * This returns the list of capability providers.
     * 
     * @param timeout
     *            The timeout in milliseconds.
     * 
     * @return The response with the list of available capability providers.
     * 
     * @throws CapabilityRegistryException
     *             Thrown if the request fails.
     * @throws ServiceTimeoutException
     *             Thrown if the request times out.
     * 
     * @since 1.0
     */
    public ListCapabilityProvidersResponse listCapabilityProviders(final long timeout) throws CapabilityRegistryException,
            ServiceTimeoutException;

    /**
     * This returns the response to a lookup capability registry request.
     * 
     * @param queries
     *            The capability registry queries.
     * @param timeout
     *            The timeout in milliseconds.
     * 
     * @return The response with the list of matching capability providers.
     * 
     * @throws CapabilityRegistryException
     *             Thrown if the request fails.
     * @throws ServiceTimeoutException
     *             Thrown if the request times out.
     * 
     * @since 1.0
     */
    public LookupCapabilityRegistryResponse lookupCapabilityRegistry(final List queries, final long timeout)
            throws CapabilityRegistryException, ServiceTimeoutException;

    /**
     * Add a listener to be notified on registration and unregistration of a capabiltiy provider
     * 
     * @param listener
     *            the capability provider registration listener
     */
    void addCapabilityProviderRegistrationListener(ICapabilityProviderRegistrationListener listener);
}