org.ikasan.recovery

Class ScheduledRecoveryManager<ID>

java.lang.Object

org.ikasan.recovery.ScheduledRecoveryManager<ID>

All Implemented Interfaces:

IsConsumerAware, IsErrorReportingServiceAware, IsExclusionServiceAware, RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>, org.quartz.Job

@DisallowConcurrentExecution
public class ScheduledRecoveryManager<ID>
extends Object
implements RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>, org.quartz.Job, IsExclusionServiceAware, IsErrorReportingServiceAware, IsConsumerAware

Scheduled based stateful Recovery implementation.

Author:

Ikasan Development Team

Constructor Summary

Constructors

Constructor and Description
ScheduledRecoveryManager(org.quartz.Scheduler scheduler, ScheduledJobFactory scheduledJobFactory, String flowName, String moduleName) Constructor

Method Summary

Modifier and Type	Method and Description
void	cancel(ID identifier)
void	cancelAll() Cancel an in progress recovery.
void	execute(org.quartz.JobExecutionContext context) Callback from the scheduler.
protected FinalAction	getFinalAction(ExceptionAction exceptionAction)
ExceptionResolver	getResolver() Get the specific exception resolver
void	initialise()
boolean	isRecovering() Are we currently running an active recovery.
boolean	isUnrecoverable() Is the situation unrecoverable.
protected org.quartz.Trigger	newRecoveryTrigger(long delay) Factory method for creating a new recovery trigger.
protected org.quartz.Trigger	newRecoveryTrigger(String cronExpression) Factory method for creating a new recovery trigger.
protected void	recover(ExceptionAction action, String componentName, Throwable throwable, ID id) Common resolution of the action for the componentName and throwable instance
<T> void	recover(FlowInvocationContext flowInvocationContext, Throwable throwable, T event, ID identifier) Execute recovery based on the specified flowInvocationContext, exception, event and event identifier.
void	recover(String componentName, Throwable throwable) Execute recovery based on the specified component name and exception.
void	setConsumer(Consumer consumer)
void	setErrorReportingService(ErrorReportingService errorReportingService)
void	setExclusionService(ExclusionService exclusionService)
<L> void	setManagedResources(L managedResources)
void	setResolver(ExceptionResolver exceptionResolver) Set a specific exception resolver
protected void	startManagedResources() Start the components marked as including Managed Resources.
protected void	stopManagedResources()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScheduledRecoveryManager

public ScheduledRecoveryManager(org.quartz.Scheduler scheduler,
                                ScheduledJobFactory scheduledJobFactory,
                                String flowName,
                                String moduleName)

Constructor

Parameters:

scheduler - the Scheduler

scheduledJobFactory - a ScheduledJobFactory

flowName - the name of the flow to which this manager is attached

moduleName - the module name

Method Detail

setResolver

public void setResolver(ExceptionResolver exceptionResolver)

Set a specific exception resolver

Specified by:

setResolver in interface RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>

Parameters:

exceptionResolver - an ExceptionResolver

getResolver

public ExceptionResolver getResolver()

Get the specific exception resolver

Specified by:

getResolver in interface RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>

Returns:

exceptionResolver

isRecovering

public boolean isRecovering()

Are we currently running an active recovery.

Specified by:

isRecovering in interface RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>

Returns:

boolean

recover

protected void recover(ExceptionAction action,
                       String componentName,
                       Throwable throwable,
                       ID id)

Common resolution of the action for the componentName and throwable instance

Parameters:

action - the given ExceptionAction

componentName - the name of the component that threw the original exception

throwable - the exception that was thrown

id - the identifier of the FlowEvent

recover

public void recover(String componentName,
                    Throwable throwable)

Execute recovery based on the specified component name and exception. This is usually called when a flow fails to start and no identifier is present

Specified by:

recover in interface RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>

Parameters:

componentName - the name of the component that threw the exception (usually the consumer)

throwable - the exception

recover

public <T> void recover(FlowInvocationContext flowInvocationContext,
                        Throwable throwable,
                        T event,
                        ID identifier)

Execute recovery based on the specified flowInvocationContext, exception, event and event identifier.

Specified by:

recover in interface RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>

Type Parameters:

T -

Parameters:

flowInvocationContext -

throwable -

event -

identifier -

getFinalAction

protected FinalAction getFinalAction(ExceptionAction exceptionAction)

isUnrecoverable

public boolean isUnrecoverable()

Is the situation unrecoverable.

Specified by:

isUnrecoverable in interface RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>

cancelAll

public void cancelAll()

Cancel an in progress recovery.

Specified by:

cancelAll in interface RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>

cancel

public void cancel(ID identifier)

Specified by:

cancel in interface RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>

initialise

public void initialise()

Specified by:

initialise in interface RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>

newRecoveryTrigger

protected org.quartz.Trigger newRecoveryTrigger(long delay)

Factory method for creating a new recovery trigger.

Parameters:

delay -

Returns:

Trigger

newRecoveryTrigger

protected org.quartz.Trigger newRecoveryTrigger(String cronExpression)

Factory method for creating a new recovery trigger.

Parameters:

cronExpression -

Returns:

Trigger

execute

public void execute(org.quartz.JobExecutionContext context)
             throws org.quartz.JobExecutionException

Callback from the scheduler.

Specified by:

execute in interface org.quartz.Job

Parameters:

context - the jbo execution context

Throws:

org.quartz.JobExecutionException

stopManagedResources

protected void stopManagedResources()

startManagedResources

protected void startManagedResources()

Start the components marked as including Managed Resources. These component are started from right to left in the flow.

setManagedResources

public <L> void setManagedResources(L managedResources)

Specified by:

setManagedResources in interface RecoveryManager<ExceptionResolver,FlowInvocationContext,ID>

setExclusionService

public void setExclusionService(ExclusionService exclusionService)

Specified by:

setExclusionService in interface IsExclusionServiceAware

setErrorReportingService

public void setErrorReportingService(ErrorReportingService errorReportingService)

Specified by:

setErrorReportingService in interface IsErrorReportingServiceAware

setConsumer

public void setConsumer(Consumer consumer)

Specified by:

setConsumer in interface IsConsumerAware