org.opennms.netmgt.config.rws

Class RwsConfiguration

java.lang.Object

org.opennms.netmgt.config.rws.RwsConfiguration

All Implemented Interfaces:

Serializable

public class RwsConfiguration
extends Object
implements Serializable

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RwsConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addStandbyUrl(int index, StandbyUrl vStandbyUrl)
void	addStandbyUrl(StandbyUrl vStandbyUrl)
Enumeration<StandbyUrl>	enumerateStandbyUrl() Method enumerateStandbyUrl.
boolean	equals(Object other)
BaseUrl	getBaseUrl() Returns the value of field 'baseUrl'.
StandbyUrl[]	getStandbyUrl() Method getStandbyUrl.Returns the contents of the collection in an Array.
StandbyUrl	getStandbyUrl(int index) Method getStandbyUrl.
List<StandbyUrl>	getStandbyUrlCollection() Method getStandbyUrlCollection.Returns a reference to 'standbyUrlList'.
int	getStandbyUrlCount() Method getStandbyUrlCount.
int	hashCode()
Iterator<StandbyUrl>	iterateStandbyUrl() Method iterateStandbyUrl.
void	removeAllStandbyUrl()
boolean	removeStandbyUrl(StandbyUrl vStandbyUrl) Method removeStandbyUrl.
StandbyUrl	removeStandbyUrlAt(int index) Method removeStandbyUrlAt.
void	setBaseUrl(BaseUrl baseUrl) Sets the value of field 'baseUrl'.
void	setStandbyUrl(int index, StandbyUrl vStandbyUrl)
void	setStandbyUrl(List<StandbyUrl> vStandbyUrlList) Sets the value of 'standbyUrlList' by copying the given Vector.
void	setStandbyUrl(StandbyUrl[] vStandbyUrlArray)
void	setStandbyUrlCollection(List<StandbyUrl> standbyUrlList) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

RwsConfiguration

public RwsConfiguration()

Method Detail

addStandbyUrl

public void addStandbyUrl(StandbyUrl vStandbyUrl)
                   throws IndexOutOfBoundsException

Parameters:

vStandbyUrl -

Throws:

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

addStandbyUrl

public void addStandbyUrl(int index,
                          StandbyUrl vStandbyUrl)
                   throws IndexOutOfBoundsException

Parameters:

index -

vStandbyUrl -

Throws:

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

enumerateStandbyUrl

public Enumeration<StandbyUrl> enumerateStandbyUrl()

Method enumerateStandbyUrl.

Returns:

an Enumeration over all possible elements of this collection

getBaseUrl

public BaseUrl getBaseUrl()

Returns the value of field 'baseUrl'. The field 'baseUrl' has the following description: Base Url(s) for Rancid Server.

Returns:

the value of field 'BaseUrl'.

getStandbyUrl

public StandbyUrl getStandbyUrl(int index)
                         throws IndexOutOfBoundsException

Method getStandbyUrl.

Parameters:

index -

Returns:

the value of the StandbyUrl at the given index

Throws:

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

getStandbyUrl

public StandbyUrl[] getStandbyUrl()

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

getStandbyUrlCollection

public List<StandbyUrl> getStandbyUrlCollection()

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

Returns:

a reference to the Vector backing this class

getStandbyUrlCount

public int getStandbyUrlCount()

Method getStandbyUrlCount.

Returns:

the size of this collection

iterateStandbyUrl

public Iterator<StandbyUrl> iterateStandbyUrl()

Method iterateStandbyUrl.

Returns:

an Iterator over all possible elements in this collection

removeAllStandbyUrl

public void removeAllStandbyUrl()

removeStandbyUrl

public boolean removeStandbyUrl(StandbyUrl vStandbyUrl)

Method removeStandbyUrl.

Parameters:

vStandbyUrl -

Returns:

true if the object was removed from the collection.

removeStandbyUrlAt

public StandbyUrl removeStandbyUrlAt(int index)

Method removeStandbyUrlAt.

Parameters:

index -

Returns:

the element removed from the collection

setBaseUrl

public void setBaseUrl(BaseUrl baseUrl)

Sets the value of field 'baseUrl'. The field 'baseUrl' has the following description: Base Url(s) for Rancid Server.

Parameters:

baseUrl - the value of field 'baseUrl'.

setStandbyUrl

public void setStandbyUrl(int index,
                          StandbyUrl vStandbyUrl)
                   throws IndexOutOfBoundsException

Parameters:

index -

vStandbyUrl -

Throws:

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

setStandbyUrl

public void setStandbyUrl(StandbyUrl[] vStandbyUrlArray)

Parameters:

vStandbyUrlArray -

setStandbyUrl

public void setStandbyUrl(List<StandbyUrl> vStandbyUrlList)

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

Parameters:

vStandbyUrlList - the Vector to copy.

setStandbyUrlCollection

public void setStandbyUrlCollection(List<StandbyUrl> standbyUrlList)

Deprecated.

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

Parameters:

standbyUrlList - the Vector to set.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object