com.neeve.sma.spi.executor

Interface LifecycleAwareExecutorBusProcessor

All Superinterfaces:

ExecutorBusProcessor

public interface LifecycleAwareExecutorBusProcessor
extends ExecutorBusProcessor

Defines an ExecutorBusProcessor that hooks into the Executor Bus's lifecycle.

Executor bus processors that open or close resources (such as one or more connections to an external system) can implement this interface to hook into the executor bus's lifecycle.

Nested Class Summary

Nested classes/interfaces inherited from interface com.neeve.sma.spi.executor.ExecutorBusProcessor

ExecutorBusProcessor.Acknowledger

Method Summary

Methods

Modifier and Type	Method and Description
void	onExecutorBusClose(MessageBusBinding busBinding) Called by the executor bus when it is closed.
void	onExecutorBusOpen(MessageBusBinding busBinding) Called by the executor bus when it is opened.
void	onExecutorBusStart(MessageBusBinding busBinding) Called by the executor bus when it is started.

Methods inherited from interface com.neeve.sma.spi.executor.ExecutorBusProcessor

process

Method Detail

onExecutorBusOpen

void onExecutorBusOpen(MessageBusBinding busBinding)
                       throws Exception,
                              SmaPermanentException

Called by the executor bus when it is opened.

This call allows the processor to create or open any resources it needs to perform processing.

Parameters:

busBinding - The executor bus binding that is being opened.

Throws:

Exception - If there is an error opening the processor.

SmaPermanentException - May be thrown by the processor to indicate that this is not a temporary error and the the bus binding should not attempt to retry the open operation.

onExecutorBusStart

void onExecutorBusStart(MessageBusBinding busBinding)
                        throws Exception,
                               SmaPermanentException

Called by the executor bus when it is started.

This processor must be prepared to begin processing messages upon return from this call.

Parameters:

busBinding - The executor bus binding that is being started.

Throws:

Exception - If there is an error opening the processor.

SmaPermanentException - May be thrown by the processor to indicate that this is not a temporary error and the the bus binding should not attempt to retry the start operation.

onExecutorBusClose

void onExecutorBusClose(MessageBusBinding busBinding)
                        throws Exception

Called by the executor bus when it is closed.

This call allows the processor to close any resources it has opened to do its processing.

Parameters:

busBinding - The executor bus binding that is being closed.

Throws:

Exception - If there is an error cllsing the processor.