org.opennms.netmgt.config.opennmsDataSources

Class DataSourceConfiguration

java.lang.Object

org.opennms.netmgt.config.opennmsDataSources.DataSourceConfiguration

All Implemented Interfaces:

Serializable

public class DataSourceConfiguration
extends Object
implements Serializable

Top Level element for opennms-datasources.xml... a list of data sources to be used within OpenNMS.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataSourceConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
void	addJdbcDataSource(int index, JdbcDataSource vJdbcDataSource)
void	addJdbcDataSource(JdbcDataSource vJdbcDataSource)
Enumeration<JdbcDataSource>	enumerateJdbcDataSource() Method enumerateJdbcDataSource.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
ConnectionPool	getConnectionPool() Returns the value of field 'connectionPool'.
JdbcDataSource[]	getJdbcDataSource() Method getJdbcDataSource.Returns the contents of the collection in an Array.
JdbcDataSource	getJdbcDataSource(int index) Method getJdbcDataSource.
List<JdbcDataSource>	getJdbcDataSourceCollection() Method getJdbcDataSourceCollection.Returns a reference to '_jdbcDataSourceList'.
int	getJdbcDataSourceCount() Method getJdbcDataSourceCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<JdbcDataSource>	iterateJdbcDataSource() Method iterateJdbcDataSource.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllJdbcDataSource()
boolean	removeJdbcDataSource(JdbcDataSource vJdbcDataSource) Method removeJdbcDataSource.
JdbcDataSource	removeJdbcDataSourceAt(int index) Method removeJdbcDataSourceAt.
void	setConnectionPool(ConnectionPool connectionPool) Sets the value of field 'connectionPool'.
void	setJdbcDataSource(int index, JdbcDataSource vJdbcDataSource)
void	setJdbcDataSource(JdbcDataSource[] vJdbcDataSourceArray)
void	setJdbcDataSource(List<JdbcDataSource> vJdbcDataSourceList) Sets the value of '_jdbcDataSourceList' by copying the given Vector.
void	setJdbcDataSourceCollection(List<JdbcDataSource> jdbcDataSourceList) Deprecated.
static DataSourceConfiguration	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

DataSourceConfiguration

public DataSourceConfiguration()

Method Detail

addJdbcDataSource

public void addJdbcDataSource(JdbcDataSource vJdbcDataSource)
                       throws IndexOutOfBoundsException

Parameters:

vJdbcDataSource -

Throws:

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

addJdbcDataSource

public void addJdbcDataSource(int index,
                     JdbcDataSource vJdbcDataSource)
                       throws IndexOutOfBoundsException

Parameters:

index -

vJdbcDataSource -

Throws:

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

enumerateJdbcDataSource

public Enumeration<JdbcDataSource> enumerateJdbcDataSource()

Method enumerateJdbcDataSource.

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.

getConnectionPool

public ConnectionPool getConnectionPool()

Returns the value of field 'connectionPool'. The field 'connectionPool' has the following description: Database connection pool configuration.

Returns:

the value of field 'ConnectionPool'.

getJdbcDataSource

public JdbcDataSource getJdbcDataSource(int index)
                                 throws IndexOutOfBoundsException

Method getJdbcDataSource.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.opennmsDataSources.JdbcDataSource at the given index

Throws:

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

getJdbcDataSource

public JdbcDataSource[] getJdbcDataSource()

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

getJdbcDataSourceCollection

public List<JdbcDataSource> getJdbcDataSourceCollection()

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

Returns:

a reference to the Vector backing this class

getJdbcDataSourceCount

public int getJdbcDataSourceCount()

Method getJdbcDataSourceCount.

Returns:

the size of this collection

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.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateJdbcDataSource

public Iterator<JdbcDataSource> iterateJdbcDataSource()

Method iterateJdbcDataSource.

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

removeAllJdbcDataSource

public void removeAllJdbcDataSource()

removeJdbcDataSource

public boolean removeJdbcDataSource(JdbcDataSource vJdbcDataSource)

Method removeJdbcDataSource.

Parameters:

vJdbcDataSource -

Returns:

true if the object was removed from the collection.

removeJdbcDataSourceAt

public JdbcDataSource removeJdbcDataSourceAt(int index)

Method removeJdbcDataSourceAt.

Parameters:

index -

Returns:

the element removed from the collection

setConnectionPool

public void setConnectionPool(ConnectionPool connectionPool)

Sets the value of field 'connectionPool'. The field 'connectionPool' has the following description: Database connection pool configuration.

Parameters:

connectionPool - the value of field 'connectionPool'.

setJdbcDataSource

public void setJdbcDataSource(int index,
                     JdbcDataSource vJdbcDataSource)
                       throws IndexOutOfBoundsException

Parameters:

index -

vJdbcDataSource -

Throws:

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

setJdbcDataSource

public void setJdbcDataSource(JdbcDataSource[] vJdbcDataSourceArray)

Parameters:

vJdbcDataSourceArray -

setJdbcDataSource

public void setJdbcDataSource(List<JdbcDataSource> vJdbcDataSourceList)

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

Parameters:

vJdbcDataSourceList - the Vector to copy.

setJdbcDataSourceCollection

public void setJdbcDataSourceCollection(List<JdbcDataSource> jdbcDataSourceList)

Deprecated.

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

Parameters:

jdbcDataSourceList - the Vector to set.

unmarshal

public static DataSourceConfiguration 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.opennmsDataSources.DataSourceConfiguration

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