org.opennms.netmgt.config.xmlrpcd

Class XmlrpcdConfiguration

java.lang.Object

org.opennms.netmgt.config.xmlrpcd.XmlrpcdConfiguration

All Implemented Interfaces:

Serializable

public class XmlrpcdConfiguration
extends Object
implements Serializable

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XmlrpcdConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExternalServers(ExternalServers vExternalServers)
void	addExternalServers(int index, ExternalServers vExternalServers)
void	addSubscription(int index, Subscription vSubscription)
void	addSubscription(Subscription vSubscription)
void	deleteGenericMsgs()
void	deleteMaxEventQueueSize()
Enumeration<ExternalServers>	enumerateExternalServers() Method enumerateExternalServers.
Enumeration<Subscription>	enumerateSubscription() Method enumerateSubscription.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
ExternalServers[]	getExternalServers() Method getExternalServers.Returns the contents of the collection in an Array.
ExternalServers	getExternalServers(int index) Method getExternalServers.
List<ExternalServers>	getExternalServersCollection() Method getExternalServersCollection.Returns a reference to '_externalServersList'.
int	getExternalServersCount() Method getExternalServersCount.
boolean	getGenericMsgs() Returns the value of field 'genericMsgs'.
int	getMaxEventQueueSize() Returns the value of field 'maxEventQueueSize'.
Subscription[]	getSubscription() Method getSubscription.Returns the contents of the collection in an Array.
Subscription	getSubscription(int index) Method getSubscription.
List<Subscription>	getSubscriptionCollection() Method getSubscriptionCollection.Returns a reference to '_subscriptionList'.
int	getSubscriptionCount() Method getSubscriptionCount.
boolean	hasGenericMsgs() Method hasGenericMsgs.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasMaxEventQueueSize() Method hasMaxEventQueueSize.
boolean	isGenericMsgs() Returns the value of field 'genericMsgs'.
boolean	isValid() Method isValid.
Iterator<ExternalServers>	iterateExternalServers() Method iterateExternalServers.
Iterator<Subscription>	iterateSubscription() Method iterateSubscription.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllExternalServers()
void	removeAllSubscription()
boolean	removeExternalServers(ExternalServers vExternalServers) Method removeExternalServers.
ExternalServers	removeExternalServersAt(int index) Method removeExternalServersAt.
boolean	removeSubscription(Subscription vSubscription) Method removeSubscription.
Subscription	removeSubscriptionAt(int index) Method removeSubscriptionAt.
void	setExternalServers(ExternalServers[] vExternalServersArray)
void	setExternalServers(int index, ExternalServers vExternalServers)
void	setExternalServers(List<ExternalServers> vExternalServersList) Sets the value of '_externalServersList' by copying the given Vector.
void	setExternalServersCollection(List<ExternalServers> externalServersList) Deprecated.
void	setGenericMsgs(boolean genericMsgs) Sets the value of field 'genericMsgs'.
void	setMaxEventQueueSize(int maxEventQueueSize) Sets the value of field 'maxEventQueueSize'.
void	setSubscription(int index, Subscription vSubscription)
void	setSubscription(List<Subscription> vSubscriptionList) Sets the value of '_subscriptionList' by copying the given Vector.
void	setSubscription(Subscription[] vSubscriptionArray)
void	setSubscriptionCollection(List<Subscription> subscriptionList) Deprecated.
static XmlrpcdConfiguration	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlrpcdConfiguration

public XmlrpcdConfiguration()

Method Detail

addExternalServers

public void addExternalServers(ExternalServers vExternalServers)
                        throws IndexOutOfBoundsException

Parameters:

vExternalServers -

Throws:

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

addExternalServers

public void addExternalServers(int index,
                      ExternalServers vExternalServers)
                        throws IndexOutOfBoundsException

Parameters:

index -

vExternalServers -

Throws:

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

addSubscription

public void addSubscription(Subscription vSubscription)
                     throws IndexOutOfBoundsException

Parameters:

vSubscription -

Throws:

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

addSubscription

public void addSubscription(int index,
                   Subscription vSubscription)
                     throws IndexOutOfBoundsException

Parameters:

index -

vSubscription -

Throws:

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

deleteGenericMsgs

public void deleteGenericMsgs()

deleteMaxEventQueueSize

public void deleteMaxEventQueueSize()

enumerateExternalServers

public Enumeration<ExternalServers> enumerateExternalServers()

Method enumerateExternalServers.

Returns:

an Enumeration over all possible elements of this collection

enumerateSubscription

public Enumeration<Subscription> enumerateSubscription()

Method enumerateSubscription.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getExternalServers

public ExternalServers getExternalServers(int index)
                                   throws IndexOutOfBoundsException

Method getExternalServers.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.xmlrpcd.ExternalServers at the given index

Throws:

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

getExternalServers

public ExternalServers[] getExternalServers()

Method getExternalServers.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

getExternalServersCollection

public List<ExternalServers> getExternalServersCollection()

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

Returns:

a reference to the Vector backing this class

getExternalServersCount

public int getExternalServersCount()

Method getExternalServersCount.

Returns:

the size of this collection

getGenericMsgs

public boolean getGenericMsgs()

Returns the value of field 'genericMsgs'. The field 'genericMsgs' has the following description: True if using the generic message RPC instead of the original 6 RPCs

Returns:

the value of field 'GenericMsgs'.

getMaxEventQueueSize

public int getMaxEventQueueSize()

Returns the value of field 'maxEventQueueSize'. The field 'maxEventQueueSize' has the following description: Maximum size of the event queue

Returns:

the value of field 'MaxEventQueueSize'.

getSubscription

public Subscription getSubscription(int index)
                             throws IndexOutOfBoundsException

Method getSubscription.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.xmlrpcd.Subscription at the given index

Throws:

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

getSubscription

public Subscription[] getSubscription()

Method getSubscription.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

getSubscriptionCollection

public List<Subscription> getSubscriptionCollection()

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

Returns:

a reference to the Vector backing this class

getSubscriptionCount

public int getSubscriptionCount()

Method getSubscriptionCount.

Returns:

the size of this collection

hasGenericMsgs

public boolean hasGenericMsgs()

Method hasGenericMsgs.

Returns:

true if at least one GenericMsgs has been added

hasMaxEventQueueSize

public boolean hasMaxEventQueueSize()

Method hasMaxEventQueueSize.

Returns:

true if at least one MaxEventQueueSize has been added

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isGenericMsgs

public boolean isGenericMsgs()

Returns the value of field 'genericMsgs'. The field 'genericMsgs' has the following description: True if using the generic message RPC instead of the original 6 RPCs

Returns:

the value of field 'GenericMsgs'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateExternalServers

public Iterator<ExternalServers> iterateExternalServers()

Method iterateExternalServers.

Returns:

an Iterator over all possible elements in this collection

iterateSubscription

public Iterator<Subscription> iterateSubscription()

Method iterateSubscription.

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

removeAllExternalServers

public void removeAllExternalServers()

removeAllSubscription

public void removeAllSubscription()

removeExternalServers

public boolean removeExternalServers(ExternalServers vExternalServers)

Method removeExternalServers.

Parameters:

vExternalServers -

Returns:

true if the object was removed from the collection.

removeExternalServersAt

public ExternalServers removeExternalServersAt(int index)

Method removeExternalServersAt.

Parameters:

index -

Returns:

the element removed from the collection

removeSubscription

public boolean removeSubscription(Subscription vSubscription)

Method removeSubscription.

Parameters:

vSubscription -

Returns:

true if the object was removed from the collection.

removeSubscriptionAt

public Subscription removeSubscriptionAt(int index)

Method removeSubscriptionAt.

Parameters:

index -

Returns:

the element removed from the collection

setExternalServers

public void setExternalServers(int index,
                      ExternalServers vExternalServers)
                        throws IndexOutOfBoundsException

Parameters:

index -

vExternalServers -

Throws:

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

setExternalServers

public void setExternalServers(ExternalServers[] vExternalServersArray)

Parameters:

vExternalServersArray -

setExternalServers

public void setExternalServers(List<ExternalServers> vExternalServersList)

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

Parameters:

vExternalServersList - the Vector to copy.

setExternalServersCollection

public void setExternalServersCollection(List<ExternalServers> externalServersList)

Deprecated.

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

Parameters:

externalServersList - the Vector to set.

setGenericMsgs

public void setGenericMsgs(boolean genericMsgs)

Sets the value of field 'genericMsgs'. The field 'genericMsgs' has the following description: True if using the generic message RPC instead of the original 6 RPCs

Parameters:

genericMsgs - the value of field 'genericMsgs'.

setMaxEventQueueSize

public void setMaxEventQueueSize(int maxEventQueueSize)

Sets the value of field 'maxEventQueueSize'. The field 'maxEventQueueSize' has the following description: Maximum size of the event queue

Parameters:

maxEventQueueSize - the value of field 'maxEventQueueSize'.

setSubscription

public void setSubscription(int index,
                   Subscription vSubscription)
                     throws IndexOutOfBoundsException

Parameters:

index -

vSubscription -

Throws:

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

setSubscription

public void setSubscription(Subscription[] vSubscriptionArray)

Parameters:

vSubscriptionArray -

setSubscription

public void setSubscription(List<Subscription> vSubscriptionList)

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

Parameters:

vSubscriptionList - the Vector to copy.

setSubscriptionCollection

public void setSubscriptionCollection(List<Subscription> subscriptionList)

Deprecated.

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

Parameters:

subscriptionList - the Vector to set.

unmarshal

public static XmlrpcdConfiguration 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.xmlrpcd.XmlrpcdConfiguration

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