public interface AlarmManager
AlarmEvaluator
s that they use to process
values. Querying and status is performed through here, as well as management of alarm listeners.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
REDUNDANCY_SHELF_SYSID |
static java.lang.String |
REDUNDANCY_SYSID
The system id for alarming in redundancy
|
Modifier and Type | Method and Description |
---|---|
boolean |
acknowledge(java.util.Collection<java.util.UUID> eventIds,
EventData ackData)
Acknowledges the specified events, with the provided data.
|
void |
addListener(QualifiedPath alarmPath,
AlarmListener listener)
Registers a listener for events generated at the specified path location or below.
|
java.util.List<java.lang.String> |
getAvailableJournalProfiles()
Returns the names of the registered alarm journal profiles.
|
java.util.List<AlarmEvent> |
getEvents(java.util.Collection<java.util.UUID> ids)
Retrieves the events specified by the provided ids.
|
java.util.Collection<AlarmProperty<?>> |
getExtendedConfigProperties()
Returns all of the registered exended properties.
|
PropertyResolver |
getPropertyResolver()
Returns a property resolver that will handle all of the known alarming properties, including the registered
extended properties.
|
java.util.List<ShelvedPath> |
getShelvedPaths()
Returns information about all of the alarm paths that are currently shelved.
|
AlarmQueryResult |
queryJournal(java.lang.String profile,
AlarmFilter filter)
Returns historical events that pass the provided filter.
|
AlarmQueryResult |
queryStatus(AlarmFilter filter)
Returns all of the current events that match the provided filter.
|
AlarmEvaluator |
registerAlarm(QualifiedPath sourcePath,
AlarmConfiguration configuration,
ExpressionParseContext expressionContext)
Registers the configuration of an alarm for a specific source, also providing the context for references in bound
alarm properties.
|
void |
registerAlarmProvider(AlarmProvider provider) |
void |
registerExtendedConfigProperties(java.lang.String ownerId,
AlarmProperty<?>... props)
Extended Configuration properties are properties added by modules.
|
void |
removeListener(QualifiedPath alarmPath,
AlarmListener listener)
Removes a previously registered alarm listener.
|
void |
shelve(java.util.Collection<Path> paths,
int timeoutSeconds,
QualifiedPath userId)
Marks the alarms specified provided paths as shelved.
|
void |
unregisterAlarmProvider(AlarmProvider provider) |
void |
unregisterExtendedConfigProperties(java.lang.String ownerId)
Removes all of the registered properties for the given owner.
|
static final java.lang.String REDUNDANCY_SYSID
static final java.lang.String REDUNDANCY_SHELF_SYSID
AlarmEvaluator registerAlarm(QualifiedPath sourcePath, AlarmConfiguration configuration, ExpressionParseContext expressionContext)
void shelve(java.util.Collection<Path> paths, int timeoutSeconds, QualifiedPath userId)
userId
- the path describing the user who performed the shelve operation.java.util.List<ShelvedPath> getShelvedPaths()
boolean acknowledge(java.util.Collection<java.util.UUID> eventIds, EventData ackData)
void addListener(QualifiedPath alarmPath, AlarmListener listener)
void removeListener(QualifiedPath alarmPath, AlarmListener listener)
AlarmQueryResult queryStatus(AlarmFilter filter)
AlarmFilter
class.java.util.List<java.lang.String> getAvailableJournalProfiles()
AlarmQueryResult queryJournal(java.lang.String profile, AlarmFilter filter)
profile
- the alarm journal profile to query.java.util.List<AlarmEvent> getEvents(java.util.Collection<java.util.UUID> ids)
java.util.Collection<AlarmProperty<?>> getExtendedConfigProperties()
void registerExtendedConfigProperties(java.lang.String ownerId, AlarmProperty<?>... props)
ownerId
- the identifier, usually module id, of the entity registering the properties.void unregisterExtendedConfigProperties(java.lang.String ownerId)
PropertyResolver getPropertyResolver()
void registerAlarmProvider(AlarmProvider provider)
void unregisterAlarmProvider(AlarmProvider provider)