org.rhq.enterprise.server.event
Interface EventManagerLocal

All Known Implementing Classes:

EventManagerBean

public interface EventManagerLocal

Interface for the Event Manager

Author:

Heiko W. Rupp, Joseph Marques

Method Summary

void	addEventData(java.util.Map<EventSource,java.util.Set<Event>> events) Add the passed events to the database
int	deleteAllEventsForCompatibleGroup(Subject subject, int groupId)
int	deleteAllEventsForResource(Subject subject, int resourceId)
int	deleteEvents(Subject subject, java.util.List<java.lang.Integer> eventIds)
void	deleteEventSourcesForDefinition(EventDefinition def)
PageList<EventComposite>	findEvents(Subject subject, int[] resourceIds, long begin, long end, EventSeverity[] severities, java.lang.String source, java.lang.String searchString, PageControl pc) Return a PageList of Event objects, that match the input
PageList<Event>	findEventsByCriteria(Subject subject, EventCriteria criteria)
PageList<EventComposite>	findEventsForAutoGroup(Subject subject, int parent, int type, long begin, long endDate, EventSeverity[] severities, PageControl pc)
PageList<EventComposite>	findEventsForAutoGroup(Subject subject, int parent, int type, long begin, long endDate, EventSeverity[] severities, java.lang.String source, java.lang.String searchString, PageControl pc)
PageList<EventComposite>	findEventsForAutoGroup(Subject subject, int parentResourceId, int resourceTypeId, long begin, long end, EventSeverity severity, java.lang.String source, java.lang.String detail, PageControl pc)
PageList<EventComposite>	findEventsForCompGroup(Subject subject, int groupId, long begin, long endDate, EventSeverity[] severities, PageControl pc)
PageList<EventComposite>	findEventsForCompGroup(Subject subject, int groupId, long begin, long endDate, EventSeverity[] severities, java.lang.String source, java.lang.String searchString, PageControl pc)
PageList<EventComposite>	findEventsForCompGroup(Subject subject, int groupId, long begin, long endDate, EventSeverity severity, java.lang.String source, java.lang.String searchString, PageControl pc)
PageList<EventComposite>	findEventsForResource(Subject subject, int resourceId, long startDate, long endDate, EventSeverity[] severities, PageControl pc) Retrieve the events for the given resource that happened in the given time frame.
PageList<EventComposite>	findEventsForResource(Subject subject, int resourceId, long startDate, long endDate, EventSeverity severity, java.lang.String source, java.lang.String detail, PageControl pc)
java.util.List<Event>	findEventsForResources(Subject subject, java.util.List<Resource> resources, long startDate, long endDate) Retrieve the events for the given resources that happened in the given time frame.
int[]	getEventCounts(Subject subject, int resourceId, long begin, long end, int numBuckets) Retrieve the count of events for the given resource in the time between begin and end, nicely separated in numBuckets.
java.util.Map<EventSeverity,java.lang.Integer>	getEventCountsBySeverity(Subject subject, int resourceId, long startDate, long endDate)
int	getEventDefinitionCountForResourceType(int resourceTypeId)
EventComposite	getEventDetailForEventId(Subject subject, int eventId) Obtain detail information about the passed event
EventSeverity[]	getSeverityBuckets(Subject subject, int resourceId, long begin, long end, int numBuckets) Provide the buckets for a timeline with the (most severe) severity for each bucket.
EventSeverity[]	getSeverityBucketsForAutoGroup(Subject subject, int parentId, int type, long begin, long end, int numBuckets) Provide the buckets for a timeline with the (most severe) severity for each bucket.
EventSeverity[]	getSeverityBucketsForCompGroup(Subject subject, int groupId, long begin, long end, int numBuckets) Provide the buckets for a timeline with the (most severe) severity for each bucket.
int	purgeEventData(java.util.Date deleteUpToTime) Deletes event data older than the specified time.

Method Detail

addEventData

void addEventData(java.util.Map<EventSource,java.util.Set<Event>> events)

Add the passed events to the database

Parameters:

events - a set of events.

purgeEventData

int purgeEventData(java.util.Date deleteUpToTime)
                   throws java.sql.SQLException

Deletes event data older than the specified time.

Parameters:

deleteUpToTime - event data older than this time will be deleted

Returns:

number of deleted Events

Throws:

java.sql.SQLException

findEventsForResources

java.util.List<Event> findEventsForResources(Subject subject,
                                             java.util.List<Resource> resources,
                                             long startDate,
                                             long endDate)

Retrieve the events for the given resources that happened in the given time frame.

Parameters:

subject -

resources - Resources we are interested in

startDate - Start time of interest

endDate - End time of interest

Returns:

List of Events for that time frame.

findEventsForResource

PageList<EventComposite> findEventsForResource(Subject subject,
                                               int resourceId,
                                               long startDate,
                                               long endDate,
                                               EventSeverity[] severities,
                                               PageControl pc)

Retrieve the events for the given resource that happened in the given time frame.

Parameters:

subject -

resourceId -

startDate -

endDate -

severity - Severity of events we are interested in. Pass 'null' for all events.

pc - TODO

Returns:

findEventsForCompGroup

PageList<EventComposite> findEventsForCompGroup(Subject subject,
                                                int groupId,
                                                long begin,
                                                long endDate,
                                                EventSeverity[] severities,
                                                PageControl pc)

findEventsForCompGroup

PageList<EventComposite> findEventsForCompGroup(Subject subject,
                                                int groupId,
                                                long begin,
                                                long endDate,
                                                EventSeverity[] severities,
                                                java.lang.String source,
                                                java.lang.String searchString,
                                                PageControl pc)

findEventsForAutoGroup

PageList<EventComposite> findEventsForAutoGroup(Subject subject,
                                                int parent,
                                                int type,
                                                long begin,
                                                long endDate,
                                                EventSeverity[] severities,
                                                PageControl pc)

findEventsForAutoGroup

PageList<EventComposite> findEventsForAutoGroup(Subject subject,
                                                int parent,
                                                int type,
                                                long begin,
                                                long endDate,
                                                EventSeverity[] severities,
                                                java.lang.String source,
                                                java.lang.String searchString,
                                                PageControl pc)

getEventCountsBySeverity

java.util.Map<EventSeverity,java.lang.Integer> getEventCountsBySeverity(Subject subject,
                                                                        int resourceId,
                                                                        long startDate,
                                                                        long endDate)

getEventCounts

int[] getEventCounts(Subject subject,
                     int resourceId,
                     long begin,
                     long end,
                     int numBuckets)

Retrieve the count of events for the given resource in the time between begin and end, nicely separated in numBuckets.

Parameters:

subject - Subject of the caller

resourceId - Id of the resource we want to know the data

begin - Begin date

end - End date

numBuckets - Number of buckets to distribute into.

Returns:

getSeverityBucketsForAutoGroup

EventSeverity[] getSeverityBucketsForAutoGroup(Subject subject,
                                               int parentId,
                                               int type,
                                               long begin,
                                               long end,
                                               int numBuckets)

Provide the buckets for a timeline with the (most severe) severity for each bucket.

Parameters:

subject - Subject of the caller

parentId - Id of the parent of the autogroup for which we want to know the data

type - Id of the children type of the autogroup

begin - Begin date

end - End date

numBuckets - Number of buckets to distribute into.

Returns:

findEvents

PageList<EventComposite> findEvents(Subject subject,
                                    int[] resourceIds,
                                    long begin,
                                    long end,
                                    EventSeverity[] severities,
                                    java.lang.String source,
                                    java.lang.String searchString,
                                    PageControl pc)

Return a PageList of Event objects, that match the input

Parameters:

subject -

resourceIds - We want events for those resources

begin - Begin time for the events display

end - End time for the events display

severity - Severity we are interested in. Null for all

source - TODO

searchString - TODO

pc - PageControl to specify the list size

Returns:

List of Events

getEventDetailForEventId

EventComposite getEventDetailForEventId(Subject subject,
                                        int eventId)
                                        throws EventException

Obtain detail information about the passed event

Parameters:

subject - Subject of the caller

eventId - ID of the desired event.

Returns:

Throws:

EventException

deleteEventSourcesForDefinition

void deleteEventSourcesForDefinition(EventDefinition def)

deleteEvents

int deleteEvents(Subject subject,
                 java.util.List<java.lang.Integer> eventIds)

deleteAllEventsForResource

int deleteAllEventsForResource(Subject subject,
                               int resourceId)

deleteAllEventsForCompatibleGroup

int deleteAllEventsForCompatibleGroup(Subject subject,
                                      int groupId)

getEventDefinitionCountForResourceType

int getEventDefinitionCountForResourceType(int resourceTypeId)

findEventsForResource

PageList<EventComposite> findEventsForResource(Subject subject,
                                               int resourceId,
                                               long startDate,
                                               long endDate,
                                               EventSeverity severity,
                                               java.lang.String source,
                                               java.lang.String detail,
                                               PageControl pc)

findEventsForAutoGroup

PageList<EventComposite> findEventsForAutoGroup(Subject subject,
                                                int parentResourceId,
                                                int resourceTypeId,
                                                long begin,
                                                long end,
                                                EventSeverity severity,
                                                java.lang.String source,
                                                java.lang.String detail,
                                                PageControl pc)

findEventsForCompGroup

PageList<EventComposite> findEventsForCompGroup(Subject subject,
                                                int groupId,
                                                long begin,
                                                long endDate,
                                                EventSeverity severity,
                                                java.lang.String source,
                                                java.lang.String searchString,
                                                PageControl pc)

getSeverityBuckets

EventSeverity[] getSeverityBuckets(Subject subject,
                                   int resourceId,
                                   long begin,
                                   long end,
                                   int numBuckets)

Provide the buckets for a timeline with the (most severe) severity for each bucket.

Parameters:

subject - Subject of the caller

resourceId - Id of the resource for which we want to know the data

begin - Begin date

end - End date

numBuckets - Number of buckets to distribute into.

Returns:

Throws:

FetchException - TODO

getSeverityBucketsForCompGroup

EventSeverity[] getSeverityBucketsForCompGroup(Subject subject,
                                               int groupId,
                                               long begin,
                                               long end,
                                               int numBuckets)

Provide the buckets for a timeline with the (most severe) severity for each bucket.

Parameters:

subject - Subject of the caller

groupId - Id of the compatible group for which we want to know the data

begin - Begin date

end - End date

numBuckets - Number of buckets to distribute into.

Returns:

Throws:

FetchException - TODO

findEventsByCriteria

PageList<Event> findEventsByCriteria(Subject subject,
                                     EventCriteria criteria)