org.ikasan.framework.flow.event.service
Class WiretapEventJob

java.lang.Object
  org.ikasan.framework.flow.event.service.WiretapEventJob

All Implemented Interfaces:

FlowEventJob

public class WiretapEventJob
extends Object
implements FlowEventJob

FlowEventJob for invoking the WiretapService requires the parameter 'timeToLive' to be passed on execution

Author:

Ikasan Development Team

Field Summary

static String

TIME_TO_LIVE_PARAM Time To Live parameter specifies length of time in minutes for Wiretapped Events to be kept

Constructor Summary

WiretapEventJob(WiretapService wiretapService)
Constructor

Method Summary

void	execute(String location, String moduleName, String flowName, Event event, Map<String,String> params) Execute the Flow Event Job
List<String>	getParameters() Returns a List of all specifiable parameters that will be respected when passed in on execute
Map<String,String>	validateParameters(Map<String,String> params) Validates a map of parameters that may be later used as arguments to the the execute method

Methods inherited from class java.lang.Object

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

Field Detail

TIME_TO_LIVE_PARAM

public static final String TIME_TO_LIVE_PARAM

Time To Live parameter specifies length of time in minutes for Wiretapped Events to be kept

See Also:

Constant Field Values

Constructor Detail

WiretapEventJob

public WiretapEventJob(WiretapService wiretapService)

Constructor

Parameters:

wiretapService - The wiretap service to use

Method Detail

execute

public void execute(String location,
                    String moduleName,
                    String flowName,
                    Event event,
                    Map<String,String> params)

Description copied from interface: FlowEventJob

Execute the Flow Event Job

Specified by:

execute in interface FlowEventJob

Parameters:

location - - The location of the FlowEvent

moduleName - - The name of the module

flowName - - The name of the flow

event - - The Event

params - - The parameters for the Job

getParameters

public List<String> getParameters()

Description copied from interface: FlowEventJob

Returns a List of all specifiable parameters that will be respected when passed in on execute

Specified by:

getParameters in interface FlowEventJob

Returns:

List of parameter names

validateParameters

public Map<String,String> validateParameters(Map<String,String> params)

Description copied from interface: FlowEventJob

Validates a map of parameters that may be later used as arguments to the the execute method

Specified by:

validateParameters in interface FlowEventJob

Parameters:

params - - The parameters to validate

Returns:

Map of validation errors, error messages mapped by parameterNames may be null or empty if validation passes