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

import java.util.List;

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

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

import com.dell.cpsd.hal.data.provider.client.validation.handler.IEndpointValidationHandler;

import com.dell.cpsd.hal.data.provider.api.ElementIdentity;
import com.dell.cpsd.hal.data.provider.api.ElementEndpoint;

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

    /**
     * This publishes a message to request element endpoint validation by a data provider.
     *
     * @param requestExchangeName
     *            The name of the request exchange.
     * @param requestRoutingKey
     *            The request routing key.
     * @param requestId
     *            The request identifier.
     * @param elementIdentity
     *            The element identity.
     * @param elementEndpoints
     *            The element endpoints.
     *
     * @throws HalDataProviderException
     *             Thrown if the send message fails.
     *
     * @since 1.0
     */
    public void validateElementEndpoints(final String requestExchangeName, final String requestRoutingKey, final String requestId,
            final ElementIdentity elementIdentity, final List elementEndpoints) throws HalDataProviderException;
}