org.opennms.web.alarm

Interface WebAlarmRepository

All Known Implementing Classes:

DaoWebAlarmRepository, JdbcWebAlarmRepository

public interface WebAlarmRepository

WebAlarmRepository interface.

Since:

1.8.1

Version:

$Id: $

Author:

ranger

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeAlarms(int[] alarmIds, String user, Date timestamp) Acknowledge Alarms.
void	acknowledgeAll(String user, Date timestamp) Acknowledge all the alarms.
void	acknowledgeMatchingAlarms(String user, Date timestamp, AlarmCriteria criteria) Acknowledge alarms matching a specific criteria.
void	clearAlarms(int[] alarmIds, String user, Date timestamp) Clear Alarms
int	countMatchingAlarms(AlarmCriteria criteria) Count alarms matching a criteria.
int[]	countMatchingAlarmsBySeverity(AlarmCriteria criteria) Count alarms by severity matching a specific criteria.
void	escalateAlarms(int[] alarmIds, String user, Date timestamp) Escalate Alarms.
List<OnmsAcknowledgment>	getAcknowledgments(int alarmId) Gets the acknowledgments.
Alarm	getAlarm(int alarmId) Gets and alarm.
List<AlarmSummary>	getCurrentNodeAlarmSummaries() Gets the current node alarm summaries.
Alarm[]	getMatchingAlarms(AlarmCriteria criteria) Gets alarms matching a specific criteria.
void	removeReductionKeyMemo(int alarmId) Removes the reduction key memo.
void	removeStickyMemo(Integer alarmId) Removes the sticky memo.
void	unacknowledgeAlarms(int[] alarmIds, String user) Unacknowledge Alarms
void	unacknowledgeAll(String user) Unacknowledge all the alarms.
void	unacknowledgeMatchingAlarms(AlarmCriteria criteria, String user) Unacknowledge Matching Alarms
void	updateReductionKeyMemo(Integer alarmId, String body, String user) Updates the ReductionKeyMemo of the alarm to persistence.
void	updateStickyMemo(Integer alarmId, String body, String user) Updates the StickyMemo of the alarm to persistence.

Method Detail

countMatchingAlarms

int countMatchingAlarms(AlarmCriteria criteria)

Count alarms matching a criteria.

Parameters:

criteria - the criteria

Returns:

the amount of alarms

countMatchingAlarmsBySeverity

int[] countMatchingAlarmsBySeverity(AlarmCriteria criteria)

Count alarms by severity matching a specific criteria.

Parameters:

criteria - the criteria

Returns:

an array with the amount of alarms per severity.

getAlarm

Alarm getAlarm(int alarmId)

Gets and alarm.

Parameters:

alarmId - the alarm id

Returns:

the alarm object

getMatchingAlarms

Alarm[] getMatchingAlarms(AlarmCriteria criteria)

Gets alarms matching a specific criteria.

Parameters:

criteria - the criteria

Returns:

a array with matching alarms

acknowledgeMatchingAlarms

void acknowledgeMatchingAlarms(String user,
                             Date timestamp,
                             AlarmCriteria criteria)

Acknowledge alarms matching a specific criteria.

Parameters:

user - the user

timestamp - the timestamp

criteria - the criteria

acknowledgeAlarms

void acknowledgeAlarms(int[] alarmIds,
                     String user,
                     Date timestamp)

Acknowledge Alarms.

Parameters:

alarmIds - an array of alarms ID

user - the user

timestamp - the timestamp

acknowledgeAll

void acknowledgeAll(String user,
                  Date timestamp)

Acknowledge all the alarms.

Parameters:

user - the user

timestamp - the timestamp

unacknowledgeMatchingAlarms

void unacknowledgeMatchingAlarms(AlarmCriteria criteria,
                               String user)

Unacknowledge Matching Alarms

.

Parameters:

criteria - the criteria

user - the user

unacknowledgeAlarms

void unacknowledgeAlarms(int[] alarmIds,
                       String user)

Unacknowledge Alarms

Parameters:

alarmIds - an array of alarms ID

user - the user

unacknowledgeAll

void unacknowledgeAll(String user)

Unacknowledge all the alarms.

Parameters:

user - the user

escalateAlarms

void escalateAlarms(int[] alarmIds,
                  String user,
                  Date timestamp)

Escalate Alarms.

Parameters:

alarmIds - an array of alarms ID

user - the user

timestamp - the timestamp

clearAlarms

void clearAlarms(int[] alarmIds,
               String user,
               Date timestamp)

Clear Alarms

Parameters:

alarmIds - an array of alarms ID

user - the user

timestamp - the timestamp

updateStickyMemo

void updateStickyMemo(Integer alarmId,
                    String body,
                    String user)

Updates the StickyMemo of the alarm to persistence.

Parameters:

alarmId - the alarmId of the alarm where the StickyMemo has to be persisted.

updateReductionKeyMemo

void updateReductionKeyMemo(Integer alarmId,
                          String body,
                          String user)

Updates the ReductionKeyMemo of the alarm to persistence. ReductionKeyMemo aka JournalMemo.

Parameters:

alarmId - the alarm id

body - the body

user - the user

removeStickyMemo

void removeStickyMemo(Integer alarmId)

Removes the sticky memo.

Parameters:

alarmId - the alarm id

removeReductionKeyMemo

void removeReductionKeyMemo(int alarmId)

Removes the reduction key memo.

Parameters:

alarmId - the alarm id

getAcknowledgments

List<OnmsAcknowledgment> getAcknowledgments(int alarmId)

Gets the acknowledgments.

Parameters:

alarmId - the alarm id

Returns:

the acknowledgments

getCurrentNodeAlarmSummaries

List<AlarmSummary> getCurrentNodeAlarmSummaries()

Gets the current node alarm summaries.

Returns:

the current node alarm summaries