org.ikasan.spec.history

Interface MessageHistoryService<EVENT,FLOW_EVENT,RESULT,HISTORY_EVENT>

public interface MessageHistoryService<EVENT,FLOW_EVENT,RESULT,HISTORY_EVENT>

This Service allows MessageHistoryEvents to be saved out at runtime for later retrieval and inspection Paged search is also catered for

Author:

Ikasan Development Team

Method Summary

Modifier and Type	Method and Description
RESULT	findMessageHistoryEvents(int pageNo, int pageSize, String orderBy, boolean orderAscending, Set<String> moduleNames, String flowName, String componentName, String eventId, String relatedEventId, Date fromDate, Date toDate) Search for saved MessageHistoryEvents
RESULT	getMessageHistoryEvent(int pageNo, int pageSize, String orderBy, boolean orderAscending, String eventId, boolean lookupRelatedEventId) Retrieve a MessageHistoryEvent via its eventId or relatedEventId This could return an event that spans multiple modules and flows, hence the paging aspect
void	save(EVENT event, String moduleName, String flowName) Save an event
void	snapMetricEvent(FLOW_EVENT event, String componentName, String moduleName, String flowName, Long timeToLive) Wiretap an FlowEvent

Method Detail

save

void save(EVENT event,
          String moduleName,
          String flowName)

Save an event

Parameters:

event - the event

moduleName - the module name

flowName - the flow name

snapMetricEvent

void snapMetricEvent(FLOW_EVENT event,
                     String componentName,
                     String moduleName,
                     String flowName,
                     Long timeToLive)

Wiretap an FlowEvent

Parameters:

event - - FlowEvent to be wiretapped

componentName - - The component this FlowEvent is currently in

moduleName - - The module this FlowEvent is currently in

flowName - - The Flow this FlowEvent is currently in

timeToLive - - Time to live for the wiretap

findMessageHistoryEvents

RESULT findMessageHistoryEvents(int pageNo,
                                int pageSize,
                                String orderBy,
                                boolean orderAscending,
                                Set<String> moduleNames,
                                String flowName,
                                String componentName,
                                String eventId,
                                String relatedEventId,
                                Date fromDate,
                                Date toDate)

Search for saved MessageHistoryEvents

Parameters:

pageNo - the current page number

pageSize - the page size

orderBy - columns to order by

orderAscending - order ascending?

moduleNames - a set of module names to search for

flowName - a flow name to search for

componentName - a component name to search for

eventId - an eventId to search for

relatedEventId - a relatedEventId to search for

fromDate - the from datetime

toDate - the to datetime

Returns:

a result set

getMessageHistoryEvent

RESULT getMessageHistoryEvent(int pageNo,
                              int pageSize,
                              String orderBy,
                              boolean orderAscending,
                              String eventId,
                              boolean lookupRelatedEventId)

Retrieve a MessageHistoryEvent via its eventId or relatedEventId This could return an event that spans multiple modules and flows, hence the paging aspect

Parameters:

pageNo - the current page number

pageSize - the page size

orderBy - columns to order by

orderAscending - order ascending?

eventId - an eventId to search for

lookupRelatedEventId - whether to look for a relatedId of the given eventId

Returns:

a result set