org.ikasan.framework.event.wiretap.service
Interface WiretapService

All Known Implementing Classes:

WiretapServiceImpl

public interface WiretapService

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

Author:

Ikasan Development Team

Method Summary

PagedSearchResult<WiretapEvent>	findWiretapEvents(int pageNo, int pageSize, String orderBy, boolean orderAscending, Set<String> moduleNames, String moduleFlow, String componentName, String eventId, String payloadId, Date fromDate, Date untilDate, String payloadContent) Allows previously stored Events to be searched for.
PagedWiretapSearchResult	findWiretapEvents(Set<String> moduleNames, String moduleFlow, String componentName, String eventId, String payloadId, Date fromDate, Date untilDate, String payloadContent, int pageSize, int pageNo) Deprecated. - Use other findWiretapEvents instead Allows previously stored Events to be searched for. By default the search has no restrictions. Specifying any of the arguments as anything other than null will cause the search to be restricted by an exact match on that field
WiretapEvent	getWiretapEvent(Long wiretapEventId) Retrieve a specific WiretapEvent by Id
void	housekeep() Causes all WiretapEvents that are past their expiry to be deleted
void	tapEvent(Event event, String componentName, String moduleName, String flowName, Long timeToLive) dumps a snapshot of an Event at runtime in the form of one or more WiretapEvents - one for every Payload contained

Method Detail

findWiretapEvents

PagedWiretapSearchResult findWiretapEvents(Set<String> moduleNames,
                                           String moduleFlow,
                                           String componentName,
                                           String eventId,
                                           String payloadId,
                                           Date fromDate,
                                           Date untilDate,
                                           String payloadContent,
                                           int pageSize,
                                           int pageNo)

Deprecated. - Use other findWiretapEvents instead Allows previously stored Events to be searched for. By default the search has no restrictions. Specifying any of the arguments as anything other than null will cause the search to be restricted by an exact match on that field

Parameters:

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 Event Id

payloadId - - The Payload Id

fromDate - - Include only events after fromDate

untilDate - - Include only events before untilDate

payloadContent - - The Payload content

pageSize - - how many results to return in the result

pageNo - - page index into the greater result set

Returns:

List of WiretapEventHeader representing the result of the search

Throws:

IllegalArgumentException - - if moduleNames is null or empty

findWiretapEvents

PagedSearchResult<WiretapEvent> findWiretapEvents(int pageNo,
                                                  int pageSize,
                                                  String orderBy,
                                                  boolean orderAscending,
                                                  Set<String> moduleNames,
                                                  String moduleFlow,
                                                  String componentName,
                                                  String eventId,
                                                  String payloadId,
                                                  Date fromDate,
                                                  Date untilDate,
                                                  String payloadContent)

Allows previously stored Events 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 Event Id

payloadId - - The Payload Id

fromDate - - Include only events after fromDate

untilDate - - Include only events before untilDate

payloadContent - - The Payload content

Returns:

List of WiretapEventHeader representing the result of the search

Throws:

IllegalArgumentException - - if moduleNames is null or empty

getWiretapEvent

WiretapEvent getWiretapEvent(Long wiretapEventId)

Retrieve a specific WiretapEvent by Id

Parameters:

wiretapEventId - - The id of the wiretap event to retrieve

Returns:

WiretapEvent

tapEvent

void tapEvent(Event event,
              String componentName,
              String moduleName,
              String flowName,
              Long timeToLive)

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

Parameters:

event - - Event to snapshot

componentName - - name of the component

moduleName - - name of the Module

flowName - - name of the Flow

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

housekeep

void housekeep()

Causes all WiretapEvents that are past their expiry to be deleted