com.dell.cpsd.hal.data.provider.client.discovery.IDeviceDataDiscoveryManager 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.hal.data.provider.client.discovery;

import com.dell.cpsd.hal.data.provider.client.exceptions.HalDataProviderException;

import com.dell.cpsd.hal.data.provider.client.discovery.handler.IDeviceDataDiscoveryHandler;

import com.dell.cpsd.hal.data.provider.api.DeviceDiscoveryCriteria;

import com.dell.cpsd.hal.data.provider.client.IHalDataProviderWorkManager;

/**
 * This interface should be implemented by a device data discovery manager.
 *
 * 
 * Copyright © 2017 Dell Inc. or its subsidiaries. All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 * 
 *
 * @since 1.0
 */
public interface IDeviceDataDiscoveryManager extends IHalDataProviderWorkManager
{
    /**
     * This returns the name of the device data discovery capability.
     *
     * @return The name of the device data discovery capability.
     *
     * @since 1.0
     */
    public String getCapability();

    /**
     * This publishes a message to request device discovery by a data provider.
     *
     * @param requestExchangeName
     *            The name of the request exchange.
     * @param requestRoutingKey
     *            The request routing key.
     * @param requestId
     *            The request identifier.
     * @param deviceDiscoveryCriteria
     *            The device discovery criteria.
     *
     * @throws HalDataProviderException
     *             Thrown if the send message fails.
     *
     * @since 1.0
     */
    public void discoverDeviceData(final String requestExchangeName, final String requestRoutingKey, final String requestId,
            final DeviceDiscoveryCriteria deviceDiscoveryCriteria) throws HalDataProviderException;
}