org.ikasan.spec.flow.FlowInvocationContext Maven / Gradle / Ivy

Go to download
/* 
 * $Id$
 * $URL$
 *
 * ====================================================================
 * Ikasan Enterprise Integration Platform
 * 
 * Distributed under the Modified BSD License.
 * Copyright notice: The copyright for this software and a full listing 
 * of individual contributors are as shown in the packaged copyright.txt 
 * file. 
 * 
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice, 
 *    this list of conditions and the following disclaimer.
 *
 *  - Redistributions in binary form must reproduce the above copyright notice, 
 *    this list of conditions and the following disclaimer in the documentation 
 *    and/or other materials provided with the distribution.
 *
 *  - Neither the name of the ORGANIZATION nor the names of its contributors may
 *    be used to endorse or promote products derived from this software without 
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 */
package org.ikasan.spec.flow;

import java.util.List;

/**
 * Interface providing the contract for transfer object operations within the flow invocation
 * 
 * @author Ikasan Development Team
 *
 */
public interface FlowInvocationContext
{

    /**
     * Indicate a flow has started
     */
    void startFlowInvocation();

    /**
     * Indicate the flow has completed
     */
    void endFlowInvocation();

    /**
     * Add an FlowElement invocation event
     * @param flowElementInvocation the invocation
     */
    void addElementInvocation(FlowElementInvocation flowElementInvocation);

    /**
     * Get the epoch start time of this flow invocation
     * @return the epoch start time in milliseconds
     */
    long getFlowStartTimeMillis();

    /**
     * Get the epoch end time of this flow invocation
     * @return the epoch end time in milliseconds
     */
    long getFlowEndTimeMillis();

    /**
     * Get the name of the last invoked component recorded in the context.
     * @return componentName
     */
	String getLastComponentName();

    /** allows the flow element invoker to set a last component name in the case where the flow
     * or component is is ignoring context invocation calls
     * @param componentName the componentName
     */
    void setLastComponentName(String componentName);

    /**
     * Get the List of invocation events
     * @return the List of invocations
     */
    List getElementInvocations();

	/**
	 * Combine the incoming flowInvocationContext into this instance
	 * @param flowInvocationContext the FlowInvocationContext to combine into this instance
	 */
	void combine(FlowInvocationContext flowInvocationContext);

    /**
     * Set the final action for this event context
     * @param action the action
     */
    void setFinalAction(FinalAction action);

    /**
     * Get the final action
     *
     * @return
     */
    FinalAction getFinalAction();


    /**
     * Set the error uri
     *
     * @param errorUri
     */
    public void setErrorUri(String errorUri);

    /**
     * Get the error uri
     */
    public String getErrorUri();
}