org.opennms.netmgt.config

Class NotifdConfigManager

java.lang.Object

org.opennms.netmgt.config.NotifdConfigManager

Direct Known Subclasses:

MockNotifdConfigManager, NotifdConfigFactory

public abstract class NotifdConfigManager
extends Object

Abstract NotifdConfigManager class.

Version:

$Id: $

Author:

david TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Field Summary

Fields

Modifier and Type	Field and Description
protected NotifdConfiguration	configuration

Constructor Summary

Constructors

Constructor and Description
NotifdConfigManager()

Method Summary

Modifier and Type	Method and Description
Collection<AutoAcknowledge>	getAutoAcknowledges() getAutoAcknowledges
NotifdConfiguration	getConfiguration() Getter for the field configuration.
String	getNextNotifIdSql() getNextNotifIdSql
String	getNextUserNotifIdSql() getNextUserNotifIdSql
boolean	getNotificationMatch() getNotificationMatch
String	getNotificationStatus() getNotificationStatus
Collection<String>	getOutageCalendarNames() getOutageCalendarNames
boolean	matchNotificationParameters(Event event, Notification notification) matchNotificationParameters
void	parseXml(InputStream stream) parseXml
void	saveCurrent() saveCurrent
protected abstract void	saveXml(String xml) saveXml
void	turnNotifdOff() Turns the notifd service off
void	turnNotifdOn() Turns the notifd service on
protected abstract void	update() update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configuration

protected NotifdConfiguration configuration

Constructor Detail

NotifdConfigManager

public NotifdConfigManager()

Method Detail

parseXml

public void parseXml(InputStream stream)
              throws org.exolab.castor.xml.MarshalException,
                     org.exolab.castor.xml.ValidationException,
                     IOException

parseXml

Parameters:

stream - a InputStream object.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

IOException - if any.

getConfiguration

public NotifdConfiguration getConfiguration()
                                     throws IOException,
                                            org.exolab.castor.xml.MarshalException,
                                            org.exolab.castor.xml.ValidationException

Getter for the field configuration.

Returns:

a NotifdConfiguration object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

update

protected abstract void update()
                        throws IOException,
                               org.exolab.castor.xml.MarshalException,
                               org.exolab.castor.xml.ValidationException

update

Throws:

org.exolab.castor.xml.ValidationException - if any.

org.exolab.castor.xml.MarshalException - if any.

IOException - if any.

getNotificationStatus

public String getNotificationStatus()
                             throws IOException,
                                    org.exolab.castor.xml.MarshalException,
                                    org.exolab.castor.xml.ValidationException

getNotificationStatus

Returns:

a String object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

turnNotifdOn

public final void turnNotifdOn()
                        throws org.exolab.castor.xml.MarshalException,
                               org.exolab.castor.xml.ValidationException,
                               IOException

Turns the notifd service on

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

IOException - if any.

turnNotifdOff

public final void turnNotifdOff()
                         throws org.exolab.castor.xml.MarshalException,
                                org.exolab.castor.xml.ValidationException,
                                IOException

Turns the notifd service off

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

IOException - if any.

getNotificationMatch

public boolean getNotificationMatch()
                             throws IOException,
                                    org.exolab.castor.xml.MarshalException,
                                    org.exolab.castor.xml.ValidationException

getNotificationMatch

Returns:

a boolean.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

saveCurrent

public void saveCurrent()
                 throws org.exolab.castor.xml.MarshalException,
                        org.exolab.castor.xml.ValidationException,
                        IOException

saveCurrent

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

IOException - if any.

saveXml

protected abstract void saveXml(String xml)
                         throws IOException

saveXml

Parameters:

xml - a String object.

Throws:

IOException - if any.

getNextNotifIdSql

public String getNextNotifIdSql()
                         throws IOException,
                                org.exolab.castor.xml.MarshalException,
                                org.exolab.castor.xml.ValidationException

getNextNotifIdSql

Returns:

a String object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

matchNotificationParameters

public boolean matchNotificationParameters(Event event,
                                           Notification notification)

matchNotificationParameters

Parameters:

event - a Event object.

notification - a Notification object.

Returns:

a boolean.

getNextUserNotifIdSql

public String getNextUserNotifIdSql()
                             throws IOException,
                                    org.exolab.castor.xml.MarshalException,
                                    org.exolab.castor.xml.ValidationException

getNextUserNotifIdSql

Returns:

a String object.

Throws:

IOException - if any.

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

getAutoAcknowledges

public Collection<AutoAcknowledge> getAutoAcknowledges()
                                                throws org.exolab.castor.xml.MarshalException,
                                                       org.exolab.castor.xml.ValidationException,
                                                       IOException

getAutoAcknowledges

Returns:

a Collection object.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

IOException - if any.

getOutageCalendarNames

public Collection<String> getOutageCalendarNames()
                                          throws org.exolab.castor.xml.MarshalException,
                                                 org.exolab.castor.xml.ValidationException,
                                                 IOException

getOutageCalendarNames

Returns:

a Collection object.

Throws:

org.exolab.castor.xml.MarshalException - if any.

org.exolab.castor.xml.ValidationException - if any.

IOException - if any.