com.codebullets.sagalib.ExecutionContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of saga-lib Show documentation
Java saga pattern library to organize and handle domain events.
The newest version!
/*
 * Copyright 2013 Stefan Domnanovits
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.codebullets.sagalib;

import javax.annotation.Nullable;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Stream;

/**
 * Holds and controls the the state when executing one ore more
 * sagas based for a single message.
 */
public interface ExecutionContext {
    /**
     * Stops the execution of further message handlers for the current message.
     */
    void stopDispatchingCurrentMessageToHandlers();

    /**
     * Gets a value indicating whether message dispatching is to be stopped.
     */
    boolean dispatchingStopped();

    /**
     * Gets the current message handled as part of the current handler chain.
     */
    Object message();

    /**
     * Gets the current saga handler instance executed at this moment.
     */
    Saga saga();

    /**
     * Gets the list of available header values.
     * @deprecated Use {@link #getAllHeaders()} instead.
     */
    @Deprecated
    Iterable getHeaders();

    /**
     * Gets a stream of all headers stored in the current context.
     */
    Stream, Object>> getAllHeaders();

    /**
     * Gets the value of a specific header. If the header is not defined null is returned.
     * @deprecated Use {@link #getHeaderValue(HeaderName)} instead.
     */
    @Deprecated
    Object getHeaderValue(String header);

    /**
     * Gets the typed value of a specific header. If the header is not defined
     * {@code empty} is returned.
     */
     Optional getHeaderValue(HeaderName header);

    /**
     * Sets a specific header value.
     * @deprecated Use {@link #setHeaderValue(HeaderName, Object)} instead.
     */
    @Deprecated
    void setHeaderValue(String header, Object value);

    /**
     * Sets a specific header value.
     */
     void setHeaderValue(HeaderName header, T value);

    /**
     * Gets the optional parent execution context. A parent context might exist if
     * saga handling was triggered within another saga.
     *
     * @return Returns the current parent context or {@code null} if no parent
     *         context is available.
     */
    @Nullable
    ExecutionContext parentContext();

    /**
     * Gets an optional execution error that occurred during saga handling.
     * This error might be of interest in modules finally bock to
     * get an indication of successful or failed handling in the finished
     * execution block.
     */
    Optional error();
}