org.rhq.enterprise.server.alert

Interface AlertDefinitionManagerRemote

All Known Subinterfaces:

AlertDefinitionManagerLocal

All Known Implementing Classes:

AlertDefinitionManagerBean

public interface AlertDefinitionManagerRemote

Public API for Alert Definitions.

Method Summary

Methods

Modifier and Type	Method and Description
int	disableAlertDefinitions(org.rhq.core.domain.auth.Subject subject, int[] alertDefinitionIds) Disable the specified alert definitions.
int	enableAlertDefinitions(org.rhq.core.domain.auth.Subject subject, int[] alertDefinitionIds) Enable the specified alert definitions.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.alert.AlertDefinition>	findAlertDefinitionsByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.AlertDefinitionCriteria criteria) Get the alert definitions specified by the given criteria.
org.rhq.core.domain.alert.AlertDefinition	getAlertDefinition(org.rhq.core.domain.auth.Subject subject, int alertDefinitionId) Get the alert definition with the given id.
String[]	getAlertNotificationConfigurationPreview(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.alert.notification.AlertNotification[] notifications)
int	removeAlertDefinitions(org.rhq.core.domain.auth.Subject subject, int[] alertDefinitionIds) Remove the specified alert definitions.

Method Detail

getAlertDefinition

org.rhq.core.domain.alert.AlertDefinition getAlertDefinition(org.rhq.core.domain.auth.Subject subject,
                                                           int alertDefinitionId)

Get the alert definition with the given id. It may be a template, group or resource level alert definition.

Requires VIEW permission for the group or resource on which the alert definition is defined. Templates are viewable by any user.

Parameters:

subject -

alertDefinitionId -

Returns:

the alert definition or null

findAlertDefinitionsByCriteria

org.rhq.core.domain.util.PageList<org.rhq.core.domain.alert.AlertDefinition> findAlertDefinitionsByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                          org.rhq.core.domain.criteria.AlertDefinitionCriteria criteria)

Get the alert definitions specified by the given criteria. The returned list may contain any combination of template, group or resource level alert definitions. definition.

Requires VIEW permission for the group or resource on which the alert definition is defined. Templates are viewable by any user.

Parameters:

subject -

criteria -

Returns:

not null

enableAlertDefinitions

int enableAlertDefinitions(org.rhq.core.domain.auth.Subject subject,
                         int[] alertDefinitionIds)

Enable the specified alert definitions. Currently enabled alert definitions are ignored, as are definitions for which the proper permission is not held.

Requires MANAGE_ALERTS permission for the group or resource on which the alert definition is defined. REQUIRES MANAGE_SETTINGS for Templates.

Parameters:

subject -

alertDefinitionIds -

Returns:

number of modified definitions

disableAlertDefinitions

int disableAlertDefinitions(org.rhq.core.domain.auth.Subject subject,
                          int[] alertDefinitionIds)

Disable the specified alert definitions. Currently disabled alert definitions are ignored, as are definitions for which the proper permission is not held.

Requires MANAGE_ALERTS permission for the group or resource on which the alert definition is defined. REQUIRES MANAGE_SETTINGS for Templates.

Parameters:

subject -

alertDefinitionIds -

Returns:

number of modified definitions

removeAlertDefinitions

int removeAlertDefinitions(org.rhq.core.domain.auth.Subject subject,
                         int[] alertDefinitionIds)

Remove the specified alert definitions. Currently deleted alert definitions are ignored, as are definitions for which the proper permission is not held.

Requires MANAGE_ALERTS permission for the group or resource on which the alert definition is defined. REQUIRES MANAGE_SETTINGS for Templates.

Parameters:

subject -

alertDefinitionIds -

Returns:

number of removed definitions

getAlertNotificationConfigurationPreview

String[] getAlertNotificationConfigurationPreview(org.rhq.core.domain.auth.Subject subject,
                                                org.rhq.core.domain.alert.notification.AlertNotification[] notifications)

Parameters:

subject -

notifications -

Returns:

not null