com.dell.cpsd.rcm.evaluation.client.amqp.producer.IAmqpRcmEvaluationProducer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rcm-evaluation-service-api Show documentation

This repository contains the source code for the rcm evaluation service API. Use this repository to share contracts between services so you can create POJOs using defined JSON schemas and to create message transformers for the RCM evaluation service.

The newest version!

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

package com.dell.cpsd.rcm.evaluation.client.amqp.producer;

import java.util.List;

import com.dell.cpsd.rcm.evaluation.client.RcmEvaluationServiceException;

import com.dell.cpsd.rcm.evaluation.service.api.ReleaseControlMatrix;
import com.dell.cpsd.rcm.evaluation.service.api.ElementVersionDatum;

/**
 * This interface should be implemented by a producer of service request
 * messages.
 *
 * 
 * Copyright © 2017 Dell Inc. or its subsidiaries.  All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 * 
 * 
 * @version 1.0
 * 
 * @since   SINCE-TBD
 */
public interface IAmqpRcmEvaluationProducer
{
    /**
     * This publishes a message to evaluate the RCM for a system using the
     * specified system and RCM uuid.
     * 
     * @param   releaseControlMatrix    The RCM definition data.
     * @param   elementVersionData      The component version data.
     * @param   correlationId           The correlation identifier.
     * @param   consumerRoutingKey      The routing key to use when responding.
     * 
     * @throws  RcmEvaluationServiceException   Thrown if publish fails.
     * 
     * @since   1.0
     */
    public void publishEvaluateSystemRcm(
            final ReleaseControlMatrix releaseControlMatrix, 
            final List elementVersionData, 
            final String correlationId, final String consumerRoutingKey)
        throws RcmEvaluationServiceException;
}