Package de.aristaflow.adept2.core.eventmanager.fileevents

Class FileEventActivityHandler

java.lang.Object
de.aristaflow.adept2.core.eventmanager.common.AbstractEventHandler
de.aristaflow.adept2.core.eventmanager.common.AbstractActivityEventHandler
de.aristaflow.adept2.core.eventmanager.fileevents.FileEventActivityHandler
All Implemented Interfaces:
ActivityEventHandler, EventHandler
@ConfigurationDescription(properties={@Property(name="IsCritical",type=BOOLEAN,defaultValue="true",description="Whether the event handler is critical and problems handling the event should abort all handling of the current event."),}) public class FileEventActivityHandler extends AbstractActivityEventHandler
An event handler for file events, that stores data from an occurred file event as output parameter in the data context of the corresponding activity.
This event handler considers a handled file event as consumed since the corresponding activity has been terminated.

This implementation is robust with respect to invalid parameter configurations and conversions, that is a parameter configuration referring to an unknown field of the file is just logged. The activity will be terminated normally but in case of a mandatory output parameter this will fail the activity.

  • Field Details

    • CONF_IS_CRITICAL

      public static final String CONF_IS_CRITICAL
      Configuration key: Whether the event handler is critical and problems handling the event should abort all handling of the current event.
      See Also:

    • HANDLER_FILE_IO_EXCEPTION_STATE

      public static final String HANDLER_FILE_IO_EXCEPTION_STATE
      State for creating UDT values based on the file fails.
      See Also:

    • HANDLER_FILE_IO_EXCEPTION_CODE

      public static final long HANDLER_FILE_IO_EXCEPTION_CODE
      Code for creating UDT values based on the file fails.
      See Also:

    • PARAM_AC_PREFIX

      public static final String PARAM_AC_PREFIX
      Prefix for our configuration values in the parameter's activity configuration.
      See Also:

    • PARAM_FILENAME

      public static final String PARAM_FILENAME
      Process parameter name for the file name.
      See Also:

    • PARAM_MODIFIED_DATE

      public static final String PARAM_MODIFIED_DATE
      Process parameter name for the file name.
      See Also:

    • PARAM_FILE

      public static final String PARAM_FILE
      Process parameter name for the file.
      See Also:

  • Constructor Details

    • FileEventActivityHandler

      @Deprecated(since="16.2.0", forRemoval=true) public FileEventActivityHandler(Configuration conf, ActivityEventManager eventManager, Registry registry)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use FileEventActivityHandler(Configuration, DefaultEventManager, Registry) instead.
      Creates a new handler for file events that starts or resumes activities and stores data from the file in their output data context.
      Parameters:
      conf - The configuration for this plugin instance.
      eventManager - The event manager for communicating with the runtime service.
      registry - The registry for retrieving the plugin instance name (handler ID).

    • FileEventActivityHandler

      public FileEventActivityHandler(Configuration conf, DefaultEventManager eventManager, Registry registry)
      Creates a new handler for file events that starts or resumes activities and stores data from the file in their output data context.
      Parameters:
      conf - The configuration for this plugin instance.
      eventManager - The event manager for communicating with the runtime service.
      registry - The registry for retrieving the plugin instance name (handler ID).

  • Method Details

    • getHandleImpossibleMessage

      protected String getHandleImpossibleMessage(Event event, boolean consumed)
      Description copied from class: AbstractActivityEventHandler
      Gets the message why a subclass cannot handle the designated event or null to indicate that handling is possible. Implementations should for instance check for the event type as well as whether consumed events can be handled.
      Overrides:
      getHandleImpossibleMessage in class AbstractActivityEventHandler
      Parameters:
      event - The event which is about to be handled.
      consumed - Whether the event has been consumed by a previous event handler.
      Returns:
      The message why a subclass cannot handle the designated event or null in case the designated event can be handled.

    • processEvent

      protected boolean processEvent(Event event, ActivityInstance activity, DataContext dataContext)
      Description copied from class: AbstractActivityEventHandler
      Processes the designated event for the designated activity instance. Usually this requires setting the output parameters in the designated data context appropriately based on the event.
      Specified by:
      processEvent in class AbstractActivityEventHandler
      Parameters:
      event - The event to be processed.
      activity - The activity for which to process event. This also provides the configuration of the activity and also the defined output parameters.
      dataContext - The data context to write the values of the output parameters to.
      Returns:
      Whether the event has been consumed (that is changed) while handling it. If the event has been consumed before the current handing, it will have to remain consumed (implementations must return true).
      Throws:
      ApplicationFailedException - If
      • one of the designated parameter has an inappropriate type with respect to the data context or its user-defined type is not valid for the corresponding field,
      • one of the designated parameter does not exist in the data context,
      • there are problems serialising fields of the message or retrieving content, or
      • there are problems serialising fields of the file
      , an ApplicationFailedException will be thrown.