org.ikasan.framework.error.service
Interface ErrorLoggingService

All Known Implementing Classes:

DefaultErrorLoggingServiceImpl

public interface ErrorLoggingService

This class represents a platform level service for the heavyweight logging of Errors

Author:

Ikasan Development Team

Method Summary

void	addErrorOccurrenceListener(ErrorOccurrenceListener errorOccurrenceListener) Registers an ErrorOccurrenceListener as a listener for new ErrorOccurrence
ErrorOccurrence	getErrorOccurrence(long errorOccurrenceId) Retrieve an ErrorOccurrence specified by its Id
List<ErrorOccurrence>	getErrorOccurrences(String eventId) Returns all ErrorOccurrences for the event specified by its id
PagedSearchResult<ErrorOccurrence>	getErrors(int pageNo, int pageSize, String orderBy, boolean orderAscending, String moduleName, String flowName) Returns a paged listing of errors
void	housekeep() Causes all ErrorOccurrences that are deemed to be too old to be deleted
void	logError(Throwable throwable, String moduleName, String initiatorName, String actionTaken) Logs an Error caused before there was an Event
void	logError(Throwable throwable, String moduleName, String flowName, String flowElementName, Event currentEvent, String actionTaken) Logs an Error where there is an inflight Event involved in a Flow
void	removeErrorOccurrenceListener(ErrorOccurrenceListener errorOccurrenceListener) Deregisters an ErrorOccurrenceListener as a listener for new ErrorOccurrence

Method Detail

logError

void logError(Throwable throwable,
              String moduleName,
              String flowName,
              String flowElementName,
              Event currentEvent,
              String actionTaken)

Logs an Error where there is an inflight Event involved in a Flow

Parameters:

throwable -

moduleName -

flowName -

flowElementName -

currentEvent -

actionTaken -

getErrors

PagedSearchResult<ErrorOccurrence> getErrors(int pageNo,
                                             int pageSize,
                                             String orderBy,
                                             boolean orderAscending,
                                             String moduleName,
                                             String flowName)

Returns a paged listing of errors

Parameters:

pageNo - - 0 or greater, index into the list of all possible results

pageSize - - 0 or greater, no of errors to return on a page

flowName -

moduleName -

Returns:

PagedSearchResult

logError

void logError(Throwable throwable,
              String moduleName,
              String initiatorName,
              String actionTaken)

Logs an Error caused before there was an Event

Parameters:

throwable -

moduleName -

initiatorName -

actionTaken -

getErrorOccurrence

ErrorOccurrence getErrorOccurrence(long errorOccurrenceId)

Retrieve an ErrorOccurrence specified by its Id

Parameters:

errorOccurrenceId -

Returns:

ErrorOccurrence

housekeep

void housekeep()

Causes all ErrorOccurrences that are deemed to be too old to be deleted

getErrorOccurrences

List<ErrorOccurrence> getErrorOccurrences(String eventId)

Returns all ErrorOccurrences for the event specified by its id

Parameters:

eventId -

Returns:

List of ErrorOccurrences for the specified event

addErrorOccurrenceListener

void addErrorOccurrenceListener(ErrorOccurrenceListener errorOccurrenceListener)

Registers an ErrorOccurrenceListener as a listener for new ErrorOccurrence

Parameters:

errorOccurrenceListener -

removeErrorOccurrenceListener

void removeErrorOccurrenceListener(ErrorOccurrenceListener errorOccurrenceListener)

Deregisters an ErrorOccurrenceListener as a listener for new ErrorOccurrence

Parameters:

errorOccurrenceListener -