Package org.ikasan.spec.wiretap

Interface WiretapService<RUNTIMEEVENT,PAGEDRESULT,IDENTIFIER>

public interface WiretapService<RUNTIMEEVENT,PAGEDRESULT,IDENTIFIER>

This Service allows FlowEvents to be dumped out at runtime for later retrieval and inspection

Author:

Ikasan Development Team

Method Summary

Modifier and Type	Method	Description
PAGEDRESULT	findWiretapEvents(int pageNo, int pageSize, java.lang.String orderBy, boolean orderAscending, java.util.Set<java.lang.String> moduleNames, java.lang.String moduleFlow, java.lang.String componentName, java.lang.String eventId, java.lang.String payloadId, java.util.Date fromDate, java.util.Date untilDate, java.lang.String payloadContent)	Allows previously stored FlowEvents to be searched for.
PAGEDRESULT	findWiretapEvents(int pageNo, int pageSize, java.lang.String orderBy, boolean orderAscending, java.util.Set<java.lang.String> moduleNames, java.util.Set<java.lang.String> moduleFlow, java.util.Set<java.lang.String> componentName, java.lang.String eventId, java.lang.String payloadId, java.util.Date fromDate, java.util.Date untilDate, java.lang.String payloadContent)	Allows previously stored FlowEvents to be searched for.
WiretapEvent	getWiretapEvent(IDENTIFIER wiretapEventId)	Retrieve a specific WiretapFlowEvent by Id
void	housekeep()	Causes all WiretapFlowEvents that are past their expiry to be deleted
boolean	housekeepablesExist()	Method to state that there are housekeepable records available.
void	save(WiretapEvent event)	Save the wiretap event.
void	tapEvent(RUNTIMEEVENT event, java.lang.String componentName, java.lang.String moduleName, java.lang.String flowName, java.lang.Long timeToLive)	dumps a snapshot of an FlowEvent at runtime in the form of one or more WiretapFlowEvents - one for every Payload contained

Method Detail

findWiretapEvents

PAGEDRESULT findWiretapEvents(int pageNo,
                              int pageSize,
                              java.lang.String orderBy,
                              boolean orderAscending,
                              java.util.Set<java.lang.String> moduleNames,
                              java.lang.String moduleFlow,
                              java.lang.String componentName,
                              java.lang.String eventId,
                              java.lang.String payloadId,
                              java.util.Date fromDate,
                              java.util.Date untilDate,
                              java.lang.String payloadContent)

Allows previously stored FlowEvents to be searched for.

Parameters:

pageNo - - page index into the greater result set

pageSize - - how many results to return in the result

orderBy - - The field to order by

orderAscending - - Ascending flag

moduleNames - - Set of names of modules to include in search - must contain at least one moduleName

moduleFlow - - The name of Flow internal to the Module

componentName - - The name of the component

eventId - - The FlowEvent Id

payloadId - - The Payload Id

fromDate - - Include only events after fromDate

untilDate - - Include only events before untilDate

payloadContent - - The Payload content

Returns:

List of WiretapFlowEventHeader representing the result of the search

Throws:

java.lang.IllegalArgumentException - - if moduleNames is null or empty

findWiretapEvents

PAGEDRESULT findWiretapEvents(int pageNo,
                              int pageSize,
                              java.lang.String orderBy,
                              boolean orderAscending,
                              java.util.Set<java.lang.String> moduleNames,
                              java.util.Set<java.lang.String> moduleFlow,
                              java.util.Set<java.lang.String> componentName,
                              java.lang.String eventId,
                              java.lang.String payloadId,
                              java.util.Date fromDate,
                              java.util.Date untilDate,
                              java.lang.String payloadContent)

Allows previously stored FlowEvents to be searched for.

Parameters:

pageNo - - page index into the greater result set

pageSize - - how many results to return in the result

orderBy - - The field to order by

orderAscending - - Ascending flag

moduleNames - - Set of names of modules to include in search - must contain at least one moduleName

moduleFlow - - The name of Flow internal to the Module

componentName - - The name of the component

eventId - - The FlowEvent Id

payloadId - - The Payload Id

fromDate - - Include only events after fromDate

untilDate - - Include only events before untilDate

payloadContent - - The Payload content

Returns:

List of WiretapFlowEventHeader representing the result of the search

Throws:

java.lang.IllegalArgumentException - - if moduleNames is null or empty

getWiretapEvent

WiretapEvent getWiretapEvent(IDENTIFIER wiretapEventId)

Retrieve a specific WiretapFlowEvent by Id

Parameters:

wiretapEventId - - The id of the wiretap event to retrieve

Returns:

WiretapFlowEvent

tapEvent

void tapEvent(RUNTIMEEVENT event,
              java.lang.String componentName,
              java.lang.String moduleName,
              java.lang.String flowName,
              java.lang.Long timeToLive)

dumps a snapshot of an FlowEvent at runtime in the form of one or more WiretapFlowEvents - one for every Payload contained

Parameters:

event - - FlowEvent to snapshot

componentName - - name of the component

moduleName - - name of the Module

flowName - - name of the Flow

timeToLive - - no of minutes from now until WiretapFlowEvents should expire

housekeep

void housekeep()

Causes all WiretapFlowEvents that are past their expiry to be deleted

housekeepablesExist

boolean housekeepablesExist()

Method to state that there are housekeepable records available.

Returns:

save

void save(WiretapEvent event)

Save the wiretap event.

Parameters:

event -