org.opennms.netmgt.config.notifd
Class NotifdConfiguration

java.lang.Object
  org.opennms.netmgt.config.notifd.NotifdConfiguration

All Implemented Interfaces:

Serializable

public class NotifdConfiguration
extends Object
implements Serializable

Top-level element for the notifd-configuration.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

NotifdConfiguration()

Method Summary

void	addAutoAcknowledge(AutoAcknowledge vAutoAcknowledge)
void	addAutoAcknowledge(int index, AutoAcknowledge vAutoAcknowledge)
void	addOutageCalendar(int index, String vOutageCalendar)
void	addOutageCalendar(String vOutageCalendar)
void	addQueue(int index, Queue vQueue)
void	addQueue(Queue vQueue)
void	deleteMatchAll()
Enumeration<AutoAcknowledge>	enumerateAutoAcknowledge() Method enumerateAutoAcknowledge.
Enumeration<String>	enumerateOutageCalendar() Method enumerateOutageCalendar.
Enumeration<Queue>	enumerateQueue() Method enumerateQueue.
String	getAcknowledgeIdSql() Returns the value of field 'acknowledgeIdSql'.
String	getAcknowledgeUpdateSql() Returns the value of field 'acknowledgeUpdateSql'.
AutoAcknowledge[]	getAutoAcknowledge() Method getAutoAcknowledge.Returns the contents of the collection in an Array.
AutoAcknowledge	getAutoAcknowledge(int index) Method getAutoAcknowledge.
List<AutoAcknowledge>	getAutoAcknowledgeCollection() Method getAutoAcknowledgeCollection.Returns a reference to '_autoAcknowledgeList'.
int	getAutoAcknowledgeCount() Method getAutoAcknowledgeCount.
String	getEmailAddressCommand() Returns the value of field 'emailAddressCommand'.
boolean	getMatchAll() Returns the value of field 'matchAll'.
String	getNextGroupId() Returns the value of field 'nextGroupId'.
String	getNextNotifId() Returns the value of field 'nextNotifId'.
String	getNextUserNotifId() Returns the value of field 'nextUserNotifId'.
String[]	getOutageCalendar() Method getOutageCalendar.Returns the contents of the collection in an Array.
String	getOutageCalendar(int index) Method getOutageCalendar.
List<String>	getOutageCalendarCollection() Method getOutageCalendarCollection.Returns a reference to '_outageCalendarList'.
int	getOutageCalendarCount() Method getOutageCalendarCount.
String	getOutstandingNoticesSql() Returns the value of field 'outstandingNoticesSql'.
String	getPagesSent() Returns the value of field 'pagesSent'.
Queue[]	getQueue() Method getQueue.Returns the contents of the collection in an Array.
Queue	getQueue(int index) Method getQueue.
List<Queue>	getQueueCollection() Method getQueueCollection.Returns a reference to '_queueList'.
int	getQueueCount() Method getQueueCount.
String	getStatus() Returns the value of field 'status'.
boolean	hasMatchAll() Method hasMatchAll.
boolean	isMatchAll() Returns the value of field 'matchAll'.
boolean	isValid() Method isValid.
Iterator<AutoAcknowledge>	iterateAutoAcknowledge() Method iterateAutoAcknowledge.
Iterator<String>	iterateOutageCalendar() Method iterateOutageCalendar.
Iterator<Queue>	iterateQueue() Method iterateQueue.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllAutoAcknowledge()
void	removeAllOutageCalendar()
void	removeAllQueue()
boolean	removeAutoAcknowledge(AutoAcknowledge vAutoAcknowledge) Method removeAutoAcknowledge.
AutoAcknowledge	removeAutoAcknowledgeAt(int index) Method removeAutoAcknowledgeAt.
boolean	removeOutageCalendar(String vOutageCalendar) Method removeOutageCalendar.
String	removeOutageCalendarAt(int index) Method removeOutageCalendarAt.
boolean	removeQueue(Queue vQueue) Method removeQueue.
Queue	removeQueueAt(int index) Method removeQueueAt.
void	setAcknowledgeIdSql(String acknowledgeIdSql) Sets the value of field 'acknowledgeIdSql'.
void	setAcknowledgeUpdateSql(String acknowledgeUpdateSql) Sets the value of field 'acknowledgeUpdateSql'.
void	setAutoAcknowledge(AutoAcknowledge[] vAutoAcknowledgeArray)
void	setAutoAcknowledge(int index, AutoAcknowledge vAutoAcknowledge)
void	setAutoAcknowledge(List<AutoAcknowledge> vAutoAcknowledgeList) Sets the value of '_autoAcknowledgeList' by copying the given Vector.
void	setAutoAcknowledgeCollection(List<AutoAcknowledge> autoAcknowledgeList) Deprecated.
void	setEmailAddressCommand(String emailAddressCommand) Sets the value of field 'emailAddressCommand'.
void	setMatchAll(boolean matchAll) Sets the value of field 'matchAll'.
void	setNextGroupId(String nextGroupId) Sets the value of field 'nextGroupId'.
void	setNextNotifId(String nextNotifId) Sets the value of field 'nextNotifId'.
void	setNextUserNotifId(String nextUserNotifId) Sets the value of field 'nextUserNotifId'.
void	setOutageCalendar(int index, String vOutageCalendar)
void	setOutageCalendar(List<String> vOutageCalendarList) Sets the value of '_outageCalendarList' by copying the given Vector.
void	setOutageCalendar(String[] vOutageCalendarArray)
void	setOutageCalendarCollection(List<String> outageCalendarList) Deprecated.
void	setOutstandingNoticesSql(String outstandingNoticesSql) Sets the value of field 'outstandingNoticesSql'.
void	setPagesSent(String pagesSent) Sets the value of field 'pagesSent'.
void	setQueue(int index, Queue vQueue)
void	setQueue(List<Queue> vQueueList) Sets the value of '_queueList' by copying the given Vector.
void	setQueue(Queue[] vQueueArray)
void	setQueueCollection(List<Queue> queueList) Deprecated.
void	setStatus(String status) Sets the value of field 'status'.
static NotifdConfiguration	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

NotifdConfiguration

public NotifdConfiguration()

Method Detail

addAutoAcknowledge

public void addAutoAcknowledge(AutoAcknowledge vAutoAcknowledge)
                        throws IndexOutOfBoundsException

Parameters:

vAutoAcknowledge -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addAutoAcknowledge

public void addAutoAcknowledge(int index,
                               AutoAcknowledge vAutoAcknowledge)
                        throws IndexOutOfBoundsException

Parameters:

index -

vAutoAcknowledge -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addOutageCalendar

public void addOutageCalendar(String vOutageCalendar)
                       throws IndexOutOfBoundsException

Parameters:

vOutageCalendar -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addOutageCalendar

public void addOutageCalendar(int index,
                              String vOutageCalendar)
                       throws IndexOutOfBoundsException

Parameters:

index -

vOutageCalendar -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addQueue

public void addQueue(Queue vQueue)
              throws IndexOutOfBoundsException

Parameters:

vQueue -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addQueue

public void addQueue(int index,
                     Queue vQueue)
              throws IndexOutOfBoundsException

Parameters:

index -

vQueue -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

deleteMatchAll

public void deleteMatchAll()

enumerateAutoAcknowledge

public Enumeration<AutoAcknowledge> enumerateAutoAcknowledge()

Method enumerateAutoAcknowledge.

Returns:

an Enumeration over all possible elements of this collection

enumerateOutageCalendar

public Enumeration<String> enumerateOutageCalendar()

Method enumerateOutageCalendar.

Returns:

an Enumeration over all possible elements of this collection

enumerateQueue

public Enumeration<Queue> enumerateQueue()

Method enumerateQueue.

Returns:

an Enumeration over all possible elements of this collection

getAcknowledgeIdSql

public String getAcknowledgeIdSql()

Returns the value of field 'acknowledgeIdSql'.

Returns:

the value of field 'AcknowledgeIdSql'.

getAcknowledgeUpdateSql

public String getAcknowledgeUpdateSql()

Returns the value of field 'acknowledgeUpdateSql'.

Returns:

the value of field 'AcknowledgeUpdateSql'.

getAutoAcknowledge

public AutoAcknowledge getAutoAcknowledge(int index)
                                   throws IndexOutOfBoundsException

Method getAutoAcknowledge.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.notifd.AutoAcknowledge at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getAutoAcknowledge

public AutoAcknowledge[] getAutoAcknowledge()

Method getAutoAcknowledge.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getAutoAcknowledgeCollection

public List<AutoAcknowledge> getAutoAcknowledgeCollection()

Method getAutoAcknowledgeCollection.Returns a reference to '_autoAcknowledgeList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getAutoAcknowledgeCount

public int getAutoAcknowledgeCount()

Method getAutoAcknowledgeCount.

Returns:

the size of this collection

getEmailAddressCommand

public String getEmailAddressCommand()

Returns the value of field 'emailAddressCommand'.

Returns:

the value of field 'EmailAddressCommand'.

getMatchAll

public boolean getMatchAll()

Returns the value of field 'matchAll'.

Returns:

the value of field 'MatchAll'.

getNextGroupId

public String getNextGroupId()

Returns the value of field 'nextGroupId'.

Returns:

the value of field 'NextGroupId'.

getNextNotifId

public String getNextNotifId()

Returns the value of field 'nextNotifId'.

Returns:

the value of field 'NextNotifId'.

getNextUserNotifId

public String getNextUserNotifId()

Returns the value of field 'nextUserNotifId'.

Returns:

the value of field 'NextUserNotifId'.

getOutageCalendar

public String getOutageCalendar(int index)
                         throws IndexOutOfBoundsException

Method getOutageCalendar.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getOutageCalendar

public String[] getOutageCalendar()

Method getOutageCalendar.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getOutageCalendarCollection

public List<String> getOutageCalendarCollection()

Method getOutageCalendarCollection.Returns a reference to '_outageCalendarList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getOutageCalendarCount

public int getOutageCalendarCount()

Method getOutageCalendarCount.

Returns:

the size of this collection

getOutstandingNoticesSql

public String getOutstandingNoticesSql()

Returns the value of field 'outstandingNoticesSql'.

Returns:

the value of field 'OutstandingNoticesSql'.

getPagesSent

public String getPagesSent()

Returns the value of field 'pagesSent'.

Returns:

the value of field 'PagesSent'.

getQueue

public Queue getQueue(int index)
               throws IndexOutOfBoundsException

Method getQueue.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.notifd.Queue at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getQueue

public Queue[] getQueue()

Method getQueue.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getQueueCollection

public List<Queue> getQueueCollection()

Method getQueueCollection.Returns a reference to '_queueList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getQueueCount

public int getQueueCount()

Method getQueueCount.

Returns:

the size of this collection

getStatus

public String getStatus()

Returns the value of field 'status'.

Returns:

the value of field 'Status'.

hasMatchAll

public boolean hasMatchAll()

Method hasMatchAll.

Returns:

true if at least one MatchAll has been added

isMatchAll

public boolean isMatchAll()

Returns the value of field 'matchAll'.

Returns:

the value of field 'MatchAll'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateAutoAcknowledge

public Iterator<AutoAcknowledge> iterateAutoAcknowledge()

Method iterateAutoAcknowledge.

Returns:

an Iterator over all possible elements in this collection

iterateOutageCalendar

public Iterator<String> iterateOutageCalendar()

Method iterateOutageCalendar.

Returns:

an Iterator over all possible elements in this collection

iterateQueue

public Iterator<Queue> iterateQueue()

Method iterateQueue.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllAutoAcknowledge

public void removeAllAutoAcknowledge()

removeAllOutageCalendar

public void removeAllOutageCalendar()

removeAllQueue

public void removeAllQueue()

removeAutoAcknowledge

public boolean removeAutoAcknowledge(AutoAcknowledge vAutoAcknowledge)

Method removeAutoAcknowledge.

Parameters:

vAutoAcknowledge -

Returns:

true if the object was removed from the collection.

removeAutoAcknowledgeAt

public AutoAcknowledge removeAutoAcknowledgeAt(int index)

Method removeAutoAcknowledgeAt.

Parameters:

index -

Returns:

the element removed from the collection

removeOutageCalendar

public boolean removeOutageCalendar(String vOutageCalendar)

Method removeOutageCalendar.

Parameters:

vOutageCalendar -

Returns:

true if the object was removed from the collection.

removeOutageCalendarAt

public String removeOutageCalendarAt(int index)

Method removeOutageCalendarAt.

Parameters:

index -

Returns:

the element removed from the collection

removeQueue

public boolean removeQueue(Queue vQueue)

Method removeQueue.

Parameters:

vQueue -

Returns:

true if the object was removed from the collection.

removeQueueAt

public Queue removeQueueAt(int index)

Method removeQueueAt.

Parameters:

index -

Returns:

the element removed from the collection

setAcknowledgeIdSql

public void setAcknowledgeIdSql(String acknowledgeIdSql)

Sets the value of field 'acknowledgeIdSql'.

Parameters:

acknowledgeIdSql - the value of field 'acknowledgeIdSql'

setAcknowledgeUpdateSql

public void setAcknowledgeUpdateSql(String acknowledgeUpdateSql)

Sets the value of field 'acknowledgeUpdateSql'.

Parameters:

acknowledgeUpdateSql - the value of field 'acknowledgeUpdateSql'.

setAutoAcknowledge

public void setAutoAcknowledge(int index,
                               AutoAcknowledge vAutoAcknowledge)
                        throws IndexOutOfBoundsException

Parameters:

index -

vAutoAcknowledge -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setAutoAcknowledge

public void setAutoAcknowledge(AutoAcknowledge[] vAutoAcknowledgeArray)

Parameters:

vAutoAcknowledgeArray -

setAutoAcknowledge

public void setAutoAcknowledge(List<AutoAcknowledge> vAutoAcknowledgeList)

Sets the value of '_autoAcknowledgeList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vAutoAcknowledgeList - the Vector to copy.

setAutoAcknowledgeCollection

public void setAutoAcknowledgeCollection(List<AutoAcknowledge> autoAcknowledgeList)

Deprecated.

Sets the value of '_autoAcknowledgeList' by setting it to the given Vector. No type checking is performed.

Parameters:

autoAcknowledgeList - the Vector to set.

setEmailAddressCommand

public void setEmailAddressCommand(String emailAddressCommand)

Sets the value of field 'emailAddressCommand'.

Parameters:

emailAddressCommand - the value of field 'emailAddressCommand'.

setMatchAll

public void setMatchAll(boolean matchAll)

Sets the value of field 'matchAll'.

Parameters:

matchAll - the value of field 'matchAll'.

setNextGroupId

public void setNextGroupId(String nextGroupId)

Sets the value of field 'nextGroupId'.

Parameters:

nextGroupId - the value of field 'nextGroupId'.

setNextNotifId

public void setNextNotifId(String nextNotifId)

Sets the value of field 'nextNotifId'.

Parameters:

nextNotifId - the value of field 'nextNotifId'.

setNextUserNotifId

public void setNextUserNotifId(String nextUserNotifId)

Sets the value of field 'nextUserNotifId'.

Parameters:

nextUserNotifId - the value of field 'nextUserNotifId'.

setOutageCalendar

public void setOutageCalendar(int index,
                              String vOutageCalendar)
                       throws IndexOutOfBoundsException

Parameters:

index -

vOutageCalendar -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setOutageCalendar

public void setOutageCalendar(String[] vOutageCalendarArray)

Parameters:

vOutageCalendarArray -

setOutageCalendar

public void setOutageCalendar(List<String> vOutageCalendarList)

Sets the value of '_outageCalendarList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vOutageCalendarList - the Vector to copy.

setOutageCalendarCollection

public void setOutageCalendarCollection(List<String> outageCalendarList)

Deprecated.

Sets the value of '_outageCalendarList' by setting it to the given Vector. No type checking is performed.

Parameters:

outageCalendarList - the Vector to set.

setOutstandingNoticesSql

public void setOutstandingNoticesSql(String outstandingNoticesSql)

Sets the value of field 'outstandingNoticesSql'.

Parameters:

outstandingNoticesSql - the value of field 'outstandingNoticesSql'.

setPagesSent

public void setPagesSent(String pagesSent)

Sets the value of field 'pagesSent'.

Parameters:

pagesSent - the value of field 'pagesSent'.

setQueue

public void setQueue(int index,
                     Queue vQueue)
              throws IndexOutOfBoundsException

Parameters:

index -

vQueue -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setQueue

public void setQueue(Queue[] vQueueArray)

Parameters:

vQueueArray -

setQueue

public void setQueue(List<Queue> vQueueList)

Sets the value of '_queueList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vQueueList - the Vector to copy.

setQueueCollection

public void setQueueCollection(List<Queue> queueList)

Deprecated.

Sets the value of '_queueList' by setting it to the given Vector. No type checking is performed.

Parameters:

queueList - the Vector to set.

setStatus

public void setStatus(String status)

Sets the value of field 'status'.

Parameters:

status - the value of field 'status'.

unmarshal

public static NotifdConfiguration unmarshal(Reader reader)
                                     throws org.exolab.castor.xml.MarshalException,
                                            org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.notifd.NotifdConfiguration

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema