com.talanlabs.mm.engine.IMMProcess Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of message-manager-engine Show documentation
The newest version!
package com.talanlabs.mm.engine;

import com.talanlabs.mm.engine.model.IProcessingResult;
import com.talanlabs.mm.shared.model.IMessage;
import com.talanlabs.mm.shared.model.IProcessError;
import com.talanlabs.mm.shared.model.domain.ErrorImpact;
import com.talanlabs.mm.shared.model.domain.MessageStatus;
import com.talanlabs.mm.shared.model.domain.MessageWay;
import java.time.Instant;
import java.util.List;
import java.util.Map;

/**
 * Created by NicolasP on 30/10/2015.
 */
public interface IMMProcess {

	/**
	 * The process is being initialized
	 */
	default void start() {
	}

	/**
	 * Core method of an agent, this method processes the message object.
	 * It can raise errors during the process. Those errors will be matched to the dictionary to adapt the behavior of the process accordingly
	 *
	 * @param message The message received from an Handle
	 */
	void process(F message);

	/**
	 * Close the process finished
	 * @param accepted indicates if the process is being accepted or rejected
	 */
	default void close(boolean accepted) {
	}

	/**
	 * The process is in an invalid state, it has been rejected
	 */
	void reject(Map errorMap);

	/**
	 * The process is in a valid state, it has been accepted.
	 */
	void accept(Map errorMap);

	/**
	 * Called to notify the implementing class that the message status has to be changed.
	 * If needed, use this to update the message in the database or elsewhere.
	 */
	default void notifyMessageStatus(MessageStatus newMessageStatus) {
		notifyMessageStatus(newMessageStatus, null);
	}

	/**
	 * Called to notify the implementing class that the message status has to be changed.
	 * If needed, use this to update the message in the database or elsewhere.
	 */
	void notifyMessageStatus(MessageStatus newMessageStatus, Instant nextProcessingDate);

	/**
	 * Get the list of errors raised. Used and enriched by the mm engine, see {@link IProcessingResult#getErrorMap()}.
	 */
	List getProcessErrorList();


	/**
	 * The message type name configured for this agent
	 */
	String getMessageTypeName();

	/**
	 * Get the dictionary used to match the errors to their recycling kind
	 */
	default SubDictionary getValidationDictionary(MMDictionary rootDictionary) {
		return rootDictionary;
	}

	/**
	 * The way of the message: IN or OUT
	 */
	MessageWay getMessageWay();

}