Package org.geotools.data.jdbc.datasource

Class JNDIDataSourceFactory

Object

AbstractDataSourceFactorySpi

JNDIDataSourceFactory

All Implemented Interfaces:

DataSourceFactorySpi, Factory

public class JNDIDataSourceFactory
extends AbstractDataSourceFactorySpi

A datasource factory SPI doing JDNI lookups

Author:

Administrator

Field Summary

Fields

Modifier and Type	Field	Description
static DataAccessFactory.Param	DSTYPE
static DataAccessFactory.Param	JNDI_REFNAME

Constructor Summary

Constructors

Constructor	Description
JNDIDataSourceFactory()

Method Summary

Modifier and Type	Method	Description
boolean	canProcess(Map<String,?> params)	Test to see if this factory is suitable for processing the data pointed to by the params map.
DataSource	createDataSource(Map<String,?> params)	Construct a live data source using the params specifed.
DataSource	createNewDataSource(Map<String,?> params)	Same as DataSourceFactorySpi.createDataSource(Map), but forces the creation of a new DataSource
String	getDescription()	Describe the nature of the data source constructed by this factory.
DataAccessFactory.Param[]	getParametersInfo()	MetaData about the required Parameters (for DataSourceFactorySpi.createDataSource(Map)).
boolean	isAvailable()	Make sure a JNDI context is available

Methods inherited from class AbstractDataSourceFactorySpi

getDisplayName, getImplementationHints

Methods inherited from class Object

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

Field Detail

DSTYPE

public static final DataAccessFactory.Param DSTYPE

JNDI_REFNAME

public static final DataAccessFactory.Param JNDI_REFNAME

Constructor Detail

JNDIDataSourceFactory

public JNDIDataSourceFactory()

Method Detail

createDataSource

public DataSource createDataSource(Map<String,?> params)
                            throws IOException

Description copied from interface: DataSourceFactorySpi

Construct a live data source using the params specifed. The returned DataSource may be pooled.

Parameters:

params - The full set of information needed to construct a live DataSource.

Returns:

The created DataSource, this may be null if the required resource was not found or if insufficent parameters were given. Note that canProcess() should have returned false if the problem is to do with insuficent parameters.

Throws:

IOException - if there were any problems setting up (creating or connecting) the datasource.

canProcess

public boolean canProcess(Map<String,?> params)

Description copied from interface: DataSourceFactorySpi

Test to see if this factory is suitable for processing the data pointed to by the params map.

If this data source requires a number of parameters then this mehtod should check that they are all present and that they are all valid.

Specified by:

canProcess in interface DataSourceFactorySpi

Overrides:

canProcess in class AbstractDataSourceFactorySpi

Parameters:

params - The full set of information needed to construct a live data source.

Returns:

booean true if and only if this factory can process the resource indicated by the param set and all the required params are pressent.

createNewDataSource

public DataSource createNewDataSource(Map<String,?> params)
                               throws IOException

Description copied from interface: DataSourceFactorySpi

Same as DataSourceFactorySpi.createDataSource(Map), but forces the creation of a new DataSource

Throws:

IOException

getDescription

public String getDescription()

Description copied from interface: DataSourceFactorySpi

Describe the nature of the data source constructed by this factory.

A non localized description of this data store type.

Returns:

A human readable description that is suitable for inclusion in a list of available datasources.

getParametersInfo

public DataAccessFactory.Param[] getParametersInfo()

Description copied from interface: DataSourceFactorySpi

MetaData about the required Parameters (for DataSourceFactorySpi.createDataSource(Map)).

Returns:

Param array describing the Map for createDataStore

isAvailable

public boolean isAvailable()

Make sure a JNDI context is available

Returns:

true if and only if this factory has all the appropriate jars on the classpath to create DataSource.