FileEventHandler

java.lang.Object
- com.highqsoft.moma.jvmservice.FileEventHandler

All Implemented Interfaces:

EventHandlerIF
```
public class FileEventHandler
extends java.lang.Object
implements EventHandlerIF
```
\page MoMaService \section rules_com_highqsoft_moma_rules_jvmservice_FileEventHandler \addindex MoMaService FileEventHandler Package \b com.highqsoft.moma.jvmservice The FileEventHandler class implements the MoMaLauncher Interface "EventHandlerIF" and is used to create MoMaLauncherTriggerEvents from files in the filesystem. The FileEventHandler expects three fields on the first line in the trigger file: \li The name of the application element \li The id of an instance of this application element \li The type of the event. This is a constant that decides which MoMa control file is used to process the event. The position within the line is configurable. Other fields or further lines are ignored. The files are processed in the order of their last modification date. The file that is currently processed is renamed to filename.PROCESSED. If the file was successfully processed it is deleted, otherwie the Suffix is changed to .FAILED and the file remains in the directory. The details for processing are configured with properties in the MoMaLauncher properties file: \li \b FileEventHandler.Directory
The directory where the files are stored in. \li \b FileEventHandler.FileNameFilter
A regular expression to filter the files to process. \li \b FileEventHandler.AeNameIndex
The index on the application element name on the line (Index starts with 0) \li \b FileEventHandler.IeIdIndex
The index on the instance id on the line (Index starts with 0) \li \b FileEventHandler.EventTypeIndex
The index on the event type on the line (Index starts with 0) \li \b FileEventHandler.SplitChar
The character used to split the line into fields

Constructor Summary

Constructors
Constructor and Description

FileEventHandler()

Constructors
Constructor and Description
`FileEventHandler()`

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`	`removeTriggerFile(MoMaLauncherTriggerEvent event)`
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileEventHandler
```
public FileEventHandler()
```
- Method Detail
  - getNextEvent
```
public MoMaLauncherTriggerEvent getNextEvent()
```
    Description copied from interface: EventHandlerIF
    
    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.
    
    Specified by:
    
    getNextEvent in interface EventHandlerIF
    
    Returns:
    the next MoMaLauncherTriggerEvent
  - getEventCount
```
public int getEventCount()
```
    Description copied from interface: EventHandlerIF
    
    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).
    
    Specified by:
    
    getEventCount in interface EventHandlerIF
    
    Returns:
    The number of events that are ready to be processed.
  - removeTriggerFile
```
public void removeTriggerFile(MoMaLauncherTriggerEvent event)
```
  - setEventState
```
public void setEventState(MoMaLauncherTriggerEvent event,
                 MoMaLauncherTriggerEvent.EventState state)
```
    Description copied from interface: EventHandlerIF
    
    Set the state of an event
    
    Specified by:
    
    setEventState in interface EventHandlerIF
    
    Parameters:
    event - The event to modify
    state - The new state
  - init
```
public boolean init(java.util.Properties p)
```
    Description copied from interface: EventHandlerIF
    
    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.
    
    Specified by:
    
    init in interface EventHandlerIF
    
    Parameters:
    p - The properties. All Properties defined for the MoMaLauncher are passed to the EventHandler
    
    Returns:
    true if the initialization was successful, otherwise false.
  - setLogger
```
public void setLogger(java.util.logging.Logger logger)
```
    Description copied from interface: EventHandlerIF
    
    Pass the logger to the event handler to enable logging to the same file as the MoMaLauncher
    
    Specified by:
    
    setLogger in interface EventHandlerIF
    
    Parameters:
    logger - The logger defined for the MoMaLauncher
  - setContext
```
public void setContext(XSDContextIF ctx)
```
    Description copied from interface: EventHandlerIF
    
    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.
    
    Specified by:
    
    setContext in interface EventHandlerIF
    
    Parameters:
    ctx - The context used by the MoMaLauncher
  - getEventCountToRetry
```
public int getEventCountToRetry()
```
    Description copied from interface: EventHandlerIF
    
    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.
    
    Specified by:
    
    getEventCountToRetry in interface EventHandlerIF
    
    Returns:
    The number of failed events that are ready to be retried.
  - getNextEventToRetry
```
public MoMaLauncherTriggerEvent getNextEventToRetry()
```
    Description copied from interface: EventHandlerIF
    
    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.
    
    Specified by:
    
    getNextEventToRetry in interface EventHandlerIF
    
    Returns:
    The event to retry
  - setMinEventAgeSeconds
```
public void setMinEventAgeSeconds(int minEventAgeSeconds)
```
    Description copied from interface: EventHandlerIF
    
    Set the number of seconds to wait before an event is processed.
    
    Specified by:
    
    setMinEventAgeSeconds in interface EventHandlerIF
  - setMaxRetryCount
```
public void setMaxRetryCount(int maxRetryCount)
```
    Description copied from interface: EventHandlerIF
    
    Set the maximum number of attempts to retry a failed event
    
    Specified by:
    
    setMaxRetryCount in interface EventHandlerIF
  - setRetryIntervalSeconds
```
public void setRetryIntervalSeconds(int retryIntervalSeconds)
```
    Description copied from interface: EventHandlerIF
    
    Set the number of seconds to wait before a failed event is retried.
    
    Specified by:
    
    setRetryIntervalSeconds in interface EventHandlerIF
    
    Parameters:
    retryIntervalSeconds - The number of seconds to wait
  - getPermanentErrorCount
```
public int getPermanentErrorCount()
```
    Description copied from interface: EventHandlerIF
    
    Get the number of failed events in the queue that have reached the maximum retry count.
    
    Specified by:
    
    getPermanentErrorCount in interface EventHandlerIF
    
    Returns:
    The number of failed events that have reached the maximum retry count.
  - setNotConnectedSleepTime
```
public void setNotConnectedSleepTime(int notConnectedSleepTime)
```
    Description copied from interface: EventHandlerIF
    
    Set the number of seconds to wait before connection to the trigger source is retried after a disconnect.
    
    Specified by:
    
    setNotConnectedSleepTime in interface EventHandlerIF

Class FileEventHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileEventHandler

Method Detail

getNextEvent

getEventCount

removeTriggerFile

setEventState

init

setLogger

setContext

getEventCountToRetry

getNextEventToRetry

setMinEventAgeSeconds

setMaxRetryCount

setRetryIntervalSeconds

getPermanentErrorCount

setNotConnectedSleepTime