org.opennms.netmgt.config.api

Interface EventConfDao

All Known Implementing Classes:

DefaultEventConfDao, MockEventConfDao, MockEventIpcManager.EmptyEventConfDao

public interface EventConfDao

EventConfDao interface.

Version:

$Id: $

Author:

ranger

Method Summary

Methods

Modifier and Type	Method and Description
void	addEvent(Event event) Adds the event to the root level event config storage (file).
void	addEventToProgrammaticStore(Event event) Adds the given event to the programmatic event store.
Event	findByEvent(Event matchingEvent) findByEvent
Event	findByUei(String uei) findByUei
String	getEventLabel(String uei) getEventLabel
Map<String,String>	getEventLabels() getEventLabels
List<Event>	getEvents(String uei) getEvents
List<Event>	getEventsByLabel() getEventsByLabel
List<String>	getEventUEIs() getEventUEIs
Events	getRootEvents() getRootEvents
boolean	isSecureTag(String tag) isSecureTag
void	reload() reload
boolean	removeEventFromProgrammaticStore(Event event) Removes the given event from the programmatic event store.
void	saveCurrent() saveCurrent

Method Detail

reload

void reload()
            throws org.springframework.dao.DataAccessException

reload

Throws:

org.springframework.dao.DataAccessException - if any.

getEvents

List<Event> getEvents(String uei)

getEvents

Parameters:

uei - a String object.

Returns:

a List object.

getEventUEIs

List<String> getEventUEIs()

getEventUEIs

Returns:

a List object.

getEventLabels

Map<String,String> getEventLabels()

getEventLabels

Returns:

a Map object.

getEventLabel

String getEventLabel(String uei)

getEventLabel

Parameters:

uei - a String object.

Returns:

a String object.

saveCurrent

void saveCurrent()

saveCurrent

getEventsByLabel

List<Event> getEventsByLabel()

getEventsByLabel

Returns:

a List object.

addEvent

void addEvent(Event event)

Adds the event to the root level event config storage (file). Does not save (you must save independently with saveCurrent)

Parameters:

event - The fully configured Event object to add.

addEventToProgrammaticStore

void addEventToProgrammaticStore(Event event)

Adds the given event to the programmatic event store. This store currently implemented as a file (referenced from eventconf.xml) The programmatic store is a separate storage area, so that incidental programmatic editing of events (e.g. custom UEIs for thresholds, edited through the Web-UI) does not clutter up the otherwise carefully maintained event files. This method does not save (persist) the changes

Parameters:

event - The fully configured Event object to add.

removeEventFromProgrammaticStore

boolean removeEventFromProgrammaticStore(Event event)

Removes the given event from the programmatic event store. This store currently implemented as a file (referenced from eventconf.xml) The programmatic store is a separate storage area, so that incidental programmatic editing of events (e.g. custom UEIs for thresholds, edited through the Web-UI) does not clutter up the otherwise carefully maintained event files. This method does not save (persist) the changes

Parameters:

event - The fully configured Event object to remove.

Returns:

a boolean.

isSecureTag

boolean isSecureTag(String tag)

isSecureTag

Parameters:

tag - a String object.

Returns:

a boolean.

findByUei

Event findByUei(String uei)

findByUei

Parameters:

uei - a String object.

Returns:

a Event object.

findByEvent

Event findByEvent(Event matchingEvent)

findByEvent

Parameters:

matchingEvent - a Event object.

Returns:

a Event object.

getRootEvents

Events getRootEvents()

getRootEvents

Returns:

a Events object.