org.ikasan.framework.initiator
Interface Initiator

All Known Subinterfaces:

EventDrivenInitiator, JmsMessageDrivenInitiator, JmsMessageDrivenInitiator, QuartzDrivenInitiator

All Known Implementing Classes:

AbstractInitiator, EventDrivenInitiatorImpl, EventMessageDrivenInitiator, EventMessageDrivenInitiator, JmsMessageDrivenInitiatorImpl, JmsMessageDrivenInitiatorImpl, QuartzStatefulScheduledDrivenInitiator, RawMessageDrivenInitiator, RawMessageDrivenInitiator, SimpleInitiator

public interface Initiator

Ikasan initiator interface defining the operations on an initiator.

Author:

Ikasan Development Team

Method Summary

IkasanExceptionHandler	getExceptionHandler() Accessor for exceptionHandler
Flow	getFlow() Returns the flow that this invokes
long	getHandledEventCount()
Date	getLastEventTime()
String	getName() The flow initiator's name.
Integer	getRetryCount() Accessor for retryCount
InitiatorState	getState() Returns the current state of the Initiator
String	getType() Returns the type of the initiator
boolean	isError() Is this initiator in an error state.
boolean	isRecovering() Is this initiator in a recovering state.
boolean	isRunning() Is this initiator running.
void	start() Start this initiator.
void	stop() Stop this initiator.

Method Detail

getName

String getName()

The flow initiator's name.

Returns:

name

getType

String getType()

Returns the type of the initiator

Returns:

type

start

void start()
           throws InitiatorOperationException

Start this initiator.

Throws:

InitiatorOperationException - Exception if we cannot start the Initiator

stop

void stop()
          throws InitiatorOperationException

Stop this initiator.

Throws:

InitiatorOperationException - Exception if we cannot stop the Initiator

getState

InitiatorState getState()

Returns the current state of the Initiator

Returns:

InitiatorState representing the current state of the Initiators

isRunning

boolean isRunning()

Is this initiator running.

Returns:

boolean

isError

boolean isError()

Is this initiator in an error state. This error state also denotes this initiator as stopped.

Returns:

boolean

isRecovering

boolean isRecovering()

Is this initiator in a recovering state. This recovering state also denotes this initiator as running.

Returns:

boolean

getFlow

Flow getFlow()

Returns the flow that this invokes

Returns:

Flow

getRetryCount

Integer getRetryCount()

Accessor for retryCount

Returns:

no of attempts made to retry

getExceptionHandler

IkasanExceptionHandler getExceptionHandler()

Accessor for exceptionHandler

Returns:

ExceptionHandler if any

getHandledEventCount

long getHandledEventCount()

getLastEventTime

Date getLastEventTime()