/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.runtime.module.extension.internal.runtime.source;

import org.mule.runtime.core.api.InternalEvent;
import org.mule.runtime.core.api.functional.Either;
import org.mule.runtime.core.api.exception.MessagingException;

import java.util.Map;

import org.reactivestreams.Publisher;

/**
 * Handles the result of flow processing.
 *
 * @since 4.0
 */
public interface SourceCompletionHandler {

  /**
   * Invoked on successful completion of flow processing.
   * <p>
   * Exceptions found while processing are to be notified through
   * the {@code exceptionCallback}, which might (depending on {@code HandledCompletionExceptionResult})
   * produce a new value as the result of handling such error
   *
   * @param event            the result of the flow execution
   */
  Publisher<Void> onCompletion(InternalEvent event, Map<String, Object> parameters);

  /**
   * Invoked when a failure occurs during the flow processing
   *  @param exception the exception thrown during processing
   *
   */
  Publisher<Void> onFailure(MessagingException exception, Map<String, Object> parameters);

  void onTerminate(Either<MessagingException, InternalEvent> eventOrException) throws Exception;

  /**
   * Resolves the set of parameters of the response function of the source against
   * the supplied {@code Event}.
   *
   * @param event the {@code Event} with the result of the successful flow processing.
   * @return the response function parameters with it's values.
   */
  Map<String, Object> createResponseParameters(InternalEvent event) throws MessagingException;

  /**
   * Resolves the set of parameters of the failure response function of the source against
   * the supplied {@code Event}.
   *
   * @param event the {@code Event} with the result of the failed flow processing.
   * @return the failed response function parameters with it's values.
   */
  Map<String, Object> createFailureResponseParameters(InternalEvent event) throws MessagingException;

}
