com.tacitknowledge.simulator.RouteManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simulator-core Show documentation

The newest version!

package com.tacitknowledge.simulator;

/**
 * Defines the interface for the RouteManager Implementations
 *
 * @author Alexandru Dereveanco ([email protected])
 */
public interface RouteManager
{

    /**
     * Starts the route manager
     * 
     * @throws Exception
     */
    void start() throws Exception;
    
    /**
     * Stops the route manager
     * 
     * @throws Exception
     */
    void stop() throws Exception;
    
    /**
     * Builds simulation route using conversation object. Assigns adapter beans to the route,
     * assigns simulation execution bean to the route. Adds route to the current camel context.
     *
     * @param conversation object to be used in the route.
     * @throws Exception in case of an error
     */
    void activate(Conversation conversation) throws Exception;

    /**
     * Stops the camel route without removing it from the context.
     *
     * @param conversation object to be used in the route.
     * @throws Exception in case of an error.
     */
    void deactivate(Conversation conversation) throws Exception;

    /**
     * @param conversation - Conversation object
     * @return true if conversation is active
     * @throws SimulatorException if an error occurs
     */
    boolean isActive(Conversation conversation) throws SimulatorException;

    /**
     * @param conversation Conversation object
     * @throws Exception if an error occurs
     */
    void delete(Conversation conversation) throws Exception;
}