org.ow2.jasmine.monitoring.eventswitch.beans
Interface JasmineEventNotificationSLBRemote

public interface JasmineEventNotificationSLBRemote

Interface for the JasmineEventNotification stateless bean.

Author:

HAN Tianyi

Method Summary

java.util.List<org.ow2.jasmine.event.beans.JasmineEventNotification>	getAllNotifications() Gets all the notification events from the DataBase.
org.ow2.jasmine.event.beans.JasmineEventNotification	getEventNotification(java.util.List<org.ow2.jasmine.event.component.SearchFilter> filters) Looks for the given bean in the data base, knowing the specified SearchFilters.
org.ow2.jasmine.event.beans.JasmineEventNotification	getEventNotification(java.lang.String id) Looks for the given bean in the data base.
java.util.List<org.ow2.jasmine.event.beans.JasmineEventNotification>	getEventNotifications(java.util.Date dateFrom, java.util.Date dateTo) Gets the event notification between two dates.
java.util.List<org.ow2.jasmine.event.beans.JasmineEventNotification>	getEventNotifications(int keepDisplayed, java.lang.String acknowledgeButtonName, java.lang.String... rules) Gets the event notifications for a given rule, a "synchronized" flag and a keepDisplayed value. IMPORTANT: the details and actions will not be retrieved.
org.ow2.jasmine.event.beans.JasmineEventNotification[]	getEventNotifications(java.lang.String id, java.util.Date date, java.lang.String level, java.lang.String message, java.lang.Boolean status, java.lang.String rule, java.lang.String orderBy, java.lang.Integer limit) looks for the beans searched for, converts the search into an array of JasmineEventNotificationEB objects and returns.
void	saveEvent(org.ow2.jasmine.event.beans.JasmineEventNotification n) creates the JasmineEventNotification entity bean corresponding to given datum and saves an event on the database.
void	saveExecutedAction(java.lang.String id, org.ow2.jasmine.event.beans.JasmineEventNotificationExecutedAction action) Saves the action executed by a user in the DataBase.
org.ow2.jasmine.event.beans.JasmineEventNotification	updateEventNotification(org.ow2.jasmine.event.beans.JasmineEventNotificationUpdate updateNotification) Looks for the given bean in the data base, knowing the specified SearchFilters, and adds a JasmineEventNotificationDetail.
void	updateNotificationStatus(java.lang.String id, boolean status) Updates the status of the notification : acknowledge or not.

Method Detail

saveExecutedAction

void saveExecutedAction(java.lang.String id,
                        org.ow2.jasmine.event.beans.JasmineEventNotificationExecutedAction action)

Saves the action executed by a user in the DataBase.

Parameters:

id - the Id of the notification to update.

action - the action to save.

updateNotificationStatus

void updateNotificationStatus(java.lang.String id,
                              boolean status)

Updates the status of the notification : acknowledge or not.

Parameters:

id - the id of the notification to update.

status - the new status to save.

saveEvent

void saveEvent(org.ow2.jasmine.event.beans.JasmineEventNotification n)

creates the JasmineEventNotification entity bean corresponding to given datum and saves an event on the database.

Parameters:

n - Notification to save.

See Also:

JasmineEventNotificationSLBRemote#saveEvent(JasmineEventNotificationEB)

getAllNotifications

java.util.List<org.ow2.jasmine.event.beans.JasmineEventNotification> getAllNotifications()

Gets all the notification events from the DataBase.

Returns:

A list that contains all the JasmineEventNotification stored in the DataBase.

getEventNotifications

org.ow2.jasmine.event.beans.JasmineEventNotification[] getEventNotifications(java.lang.String id,
                                                                             java.util.Date date,
                                                                             java.lang.String level,
                                                                             java.lang.String message,
                                                                             java.lang.Boolean status,
                                                                             java.lang.String rule,
                                                                             java.lang.String orderBy,
                                                                             java.lang.Integer limit)

looks for the beans searched for, converts the search into an array of JasmineEventNotificationEB objects and returns.

Parameters:

id - Notification id, ignored if null.

date - Notification date, ignored if null.

level - Notification level, ignored if null.

message - Associated message, ignored if null.

status - Notification status, ignored if null.

rule - The rule id that caused the notification, ignored if null.

orderBy - Order using column, ignored if null..

limit - Maximal number of results to get, ignored if null.

Returns:

EventNotifications corresponding to the given search, null if none found.

getEventNotifications

java.util.List<org.ow2.jasmine.event.beans.JasmineEventNotification> getEventNotifications(java.util.Date dateFrom,
                                                                                           java.util.Date dateTo)

Gets the event notification between two dates.

Parameters:

dateFrom - the date from

dateTo - the date to

Returns:

a list of JasmineEventNotification

getEventNotifications

java.util.List<org.ow2.jasmine.event.beans.JasmineEventNotification> getEventNotifications(int keepDisplayed,
                                                                                           java.lang.String acknowledgeButtonName,
                                                                                           java.lang.String... rules)

Gets the event notifications for a given rule, a "synchronized" flag and a keepDisplayed value.

IMPORTANT: the details and actions will not be retrieved. Call

Parameters:

keepDisplayed - the keepDisplayed option, expressed in hours:

• If "synchronized" is false, only notifications with a date inferior to now minus keepDisplayed hours will be returned.
• If "synchronized" is true, a merge of two types of notifications is returned:
  1. Notifications with status false (i.e., not acknowledged yet)
  2. Notifications with status true AND at least one action of type ACKNOWLEDGE with a date to now minus keepDisplayed hours

acknowledgeButtonName - the name of the ACKNOWLEDGE button. if null, "synchronized" is considered to be false; otherwise it is considered to be true.

rules - rule names. might contain an * character at the end, meaning "rule starts with".

Returns:

a list of JasmineEventNotification

getEventNotification

org.ow2.jasmine.event.beans.JasmineEventNotification getEventNotification(java.lang.String id)

Looks for the given bean in the data base. It returns the associated JasmineEventNotification.

Parameters:

id - Id of the notification to retrieve.

Returns:

the retrieved notification.

getEventNotification

org.ow2.jasmine.event.beans.JasmineEventNotification getEventNotification(java.util.List<org.ow2.jasmine.event.component.SearchFilter> filters)

Looks for the given bean in the data base, knowing the specified SearchFilters.

Parameters:

filters - a list of SearchFilter to get the right bean to update in the database.

Returns:

the JasmineEventNotification looked for.

updateEventNotification

org.ow2.jasmine.event.beans.JasmineEventNotification updateEventNotification(org.ow2.jasmine.event.beans.JasmineEventNotificationUpdate updateNotification)
                                                                             throws java.lang.IllegalStateException

Looks for the given bean in the data base, knowing the specified SearchFilters, and adds a JasmineEventNotificationDetail. It returns the updated JasmineEventNotification.

Parameters:

updateNotification - the JasmineEventNotificationUpdate that contains the datas to update the stored JasmineEventNotification.

Returns:

the updated notification.

Throws:

java.lang.IllegalStateException - if no filters are defined in the update object.