com.highqsoft.moma.jvmservice

Interface EventHandlerIF

All Known Implementing Classes:

FileEventHandler, JdbcEventHandler

public interface EventHandlerIF

The EventHandlerIF interface defines the methods for a MoMaLauncher event handler. The event handler is responisble to process a specific type of queue, for example files in a directory or entries in a database table.

Author:

markus

Method Summary

Methods

Modifier and Type	Method and Description
int	getEventCount() Get the number of events in the queue that are ready to be processed.
int	getEventCountToRetry() Get the number of failed events in the queue that are ready to be retried.
MoMaLauncherTriggerEvent	getNextEvent() Get the next event in the queue.
MoMaLauncherTriggerEvent	getNextEventToRetry() Get the next event to retry The implementation should only return events with a retry count < MoMaLauncher.maxRetryCount and an event time older than now() - MoMaLauncher.RetryIntervalSeconds.
int	getPermanentErrorCount() Get the number of failed events in the queue that have reached the maximum retry count.
boolean	init(java.util.Properties p) Does the initialization.
void	setContext(XSDContextIF ctx) Set the context for the event handler.
void	setEventState(MoMaLauncherTriggerEvent event, MoMaLauncherTriggerEvent.EventState state) Set the state of an event
void	setLogger(java.util.logging.Logger logger) Pass the logger to the event handler to enable logging to the same file as the MoMaLauncher
void	setMaxRetryCount(int maxRetryCount) Set the maximum number of attempts to retry a failed event
void	setMinEventAgeSeconds(int minEventAgeSeconds) Set the number of seconds to wait before an event is processed.
void	setNotConnectedSleepTime(int notConnectedSleepTime) Set the number of seconds to wait before connection to the trigger source is retried after a disconnect.
void	setRetryIntervalSeconds(int retryIntervalSeconds) Set the number of seconds to wait before a failed event is retried.

Method Detail

setLogger

void setLogger(java.util.logging.Logger logger)

Pass the logger to the event handler to enable logging to the same file as the MoMaLauncher

Parameters:

logger - The logger defined for the MoMaLauncher

setContext

void setContext(XSDContextIF ctx)

Set the context for the event handler. The context is only used to get the message texts from the property files. This is the same context that is used by the MoMaLauncher.

Parameters:

ctx - The context used by the MoMaLauncher

init

boolean init(java.util.Properties p)

Does the initialization. During initialization all event handler specific properties must be checked. In case of missing properties or other errors that prevent the event handler from proper working the method must return false and the MoMaLauncher will exit.

Parameters:

p - The properties. All Properties defined for the MoMaLauncher are passed to the EventHandler

Returns:

true if the initialization was successful, otherwise false.

getNextEvent

MoMaLauncherTriggerEvent getNextEvent()

Get the next event in the queue. The order of events is an implementation detail. The implementation should only return events with an event time before (now() - MoMaLauncher.MinEventAgeSeconds) and state = WAITING.

Returns:

the next MoMaLauncherTriggerEvent

getEventCount

int getEventCount()

Get the number of events in the queue that are ready to be processed. That means the event state must be WAITING and the event time must be before (now() - MoMaLauncher.MinEventAgeSeconds).

Returns:

The number of events that are ready to be processed.

getEventCountToRetry

int getEventCountToRetry()

Get the number of failed events in the queue that are ready to be retried. That means the event state must be FAILED, the event time must be before (now() - MoMaLauncher.RetryIntervalSeconds) and the retry count must be lower than MoMaLauncher.MaxRetryCount.

Returns:

The number of failed events that are ready to be retried.

getPermanentErrorCount

int getPermanentErrorCount()

Get the number of failed events in the queue that have reached the maximum retry count.

Returns:

The number of failed events that have reached the maximum retry count.

setEventState

void setEventState(MoMaLauncherTriggerEvent event,
                 MoMaLauncherTriggerEvent.EventState state)

Set the state of an event

Parameters:

event - The event to modify

state - The new state

getNextEventToRetry

MoMaLauncherTriggerEvent getNextEventToRetry()

Get the next event to retry The implementation should only return events with a retry count < MoMaLauncher.maxRetryCount and an event time older than now() - MoMaLauncher.RetryIntervalSeconds.

Returns:

The event to retry

setMinEventAgeSeconds

void setMinEventAgeSeconds(int minEventAgeSeconds)

Set the number of seconds to wait before an event is processed.

Parameters:

minEventAgeSeconds -

setMaxRetryCount

void setMaxRetryCount(int maxRetryCount)

Set the maximum number of attempts to retry a failed event

Parameters:

maxRetryCount -

setRetryIntervalSeconds

void setRetryIntervalSeconds(int retryIntervalSeconds)

Set the number of seconds to wait before a failed event is retried.

Parameters:

retryIntervalSeconds - The number of seconds to wait

setNotConnectedSleepTime

void setNotConnectedSleepTime(int notConnectedSleepTime)

Set the number of seconds to wait before connection to the trigger source is retried after a disconnect.

Parameters:

retryIntervalSeconds - The number of seconds to wait