Apache Derby Client JDBC Driver 10.17.1.0 · org.apache.derby.client.ClientDataSourceFactory

The data source factory for Derby client driver data sources.

This factory reconstructs a Derby data source object when it is retrieved from JNDI. References are needed since many naming services don't have the ability to store Java objects in their serialized form. When a data source object is bound in this type of naming service the javax.naming.Reference for that object is actually stored by the JNDI implementation, not the data source object itself.

A JNDI administrator is responsible for making sure that both the object factory and data source implementation classes provided by a JDBC driver vendor are accessible to the JNDI service provider at runtime.

An object factory implements the javax.naming.spi.ObjectFactory interface. This interface contains a single method, getObjectInstance which is called by a JNDI service provider to reconstruct an object when that object is retrieved from JNDI. A JDBC driver vendor should provide an object factory as part of their JDBC 2.0 product. See org.apache.derby.jdbc.ClientDataSource See org.apache.derby.jdbc.ClientConnectionPoolDataSource See org.apache.derby.jdbc.ClientXADataSource

Field Summary

Modifier and Type	Field and Description
private static final Class<T>[]	BOOLEAN_ARG Reflect lookup for Java bean method taking a single boolean arg
private static final Class<T>[]	INT_ARG Reflect lookup for Java bean method taking a single int arg
private static final Class<T>[]	SHORT_ARG Reflect lookup for Java bean method taking a single short arg
private static final Class<T>[]	STRING_ARG Reflect lookup for Java bean method taking a single String arg

Constructor Summary

Access	Constructor and Description
public	ClientDataSourceFactory()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public Object	Returns: Object created, or `null` if no attempt to create the object is made. getObjectInstance(Object the possibly `null` object containing location or reference information that can be used in creating an object refObj, Name the name of this object relative to `nameContext`, or `null` if no name is specified name, Context context relative to which the name parameter is specified, or `null` if name is relative to the default initial context. nameContext, Hashtable<K, V> possibly `null` environment that is used in creating the object. environment) Implements javax.naming.spi.ObjectFactory.getObjectInstance. Reconstructs a Derby client-driver data source object from a JNDI data source reference.
private static void	setBeanProperties(Object ds, Reference ref) Set the Java bean properties for an object from its Reference.

public Object

Returns:

Object created, or null if no attempt to create the object is made.

getObjectInstance(Object

the possibly null object containing location or reference information that can be used in creating an object

refObj, Name

the name of this object relative to nameContext, or null if no name is specified

name, Context

context relative to which the name parameter is specified, or null if name is relative to the default initial context.

nameContext, Hashtable<K, V>

possibly null environment that is used in creating the object.

environment)

Implements javax.naming.spi.ObjectFactory.getObjectInstance.

Reconstructs a Derby client-driver data source object from a JNDI data source reference.

private static void

setBeanProperties(Object ds, Reference ref)

Set the Java bean properties for an object from its Reference.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BOOLEAN_ARG	back to summary
private static final Class<T>[] BOOLEAN_ARG Reflect lookup for Java bean method taking a single boolean arg

INT_ARG	back to summary
private static final Class<T>[] INT_ARG Reflect lookup for Java bean method taking a single int arg

SHORT_ARG	back to summary
private static final Class<T>[] SHORT_ARG Reflect lookup for Java bean method taking a single short arg

STRING_ARG	back to summary
private static final Class<T>[] STRING_ARG Reflect lookup for Java bean method taking a single String arg

Constructor Detail

ClientDataSourceFactory	back to summary
public ClientDataSourceFactory()

Method Detail

getObjectInstance back to summary

getObjectInstance	back to summary
public Object getObjectInstance(Object refObj, Name name, Context nameContext, Hashtable<K, V> environment) throws Exception Implements javax.naming.spi.ObjectFactory.getObjectInstance. Reconstructs a Derby client-driver data source object from a JNDI data source reference. The `getObjectInstance` method is passed a reference that corresponds to the object being retrieved as its first parameter. The other parameters are optional in the case of JDBC data source objects. The object factory should use the information contained in the reference to reconstruct the data source. If for some reason, a data source object cannot be reconstructed from the reference, a value of `null` may be returned. This allows other object factories that may be registered in JNDI to be tried. If an exception is thrown then no other object factories are tried. Parameters refObj:Object the possibly `null` object containing location or reference information that can be used in creating an object name:Name the name of this object relative to `nameContext`, or `null` if no name is specified nameContext:Context context relative to which the name parameter is specified, or `null` if name is relative to the default initial context. environment:Hashtable<K, V> possibly `null` environment that is used in creating the object. Returns:Object Object created, or `null` if no attempt to create the object is made. Exceptions Exception: if recreating the object fails

public Object getObjectInstance(Object refObj, Name name, Context nameContext, Hashtable<K, V> environment) throws Exception

Implements javax.naming.spi.ObjectFactory.getObjectInstance.

Reconstructs a Derby client-driver data source object from a JNDI data source reference.

The getObjectInstance method is passed a reference that corresponds to the object being retrieved as its first parameter. The other parameters are optional in the case of JDBC data source objects. The object factory should use the information contained in the reference to reconstruct the data source. If for some reason, a data source object cannot be reconstructed from the reference, a value of null may be returned. This allows other object factories that may be registered in JNDI to be tried. If an exception is thrown then no other object factories are tried.

Parameters

refObj:Object: the possibly null object containing location or reference information that can be used in creating an object
name:Name: the name of this object relative to nameContext, or null if no name is specified
nameContext:Context: context relative to which the name parameter is specified, or null if name is relative to the default initial context.
environment:Hashtable<K, V>: possibly null environment that is used in creating the object.

Returns:Object

Object created, or null if no attempt to create the object is made.

Exceptions

Exception:: if recreating the object fails

setBeanProperties	back to summary
private static void setBeanProperties(Object ds, Reference ref) throws Exception Set the Java bean properties for an object from its Reference. The Reference contains a set of StringRefAddr values with the key being the bean name and the value a String representation of the bean's value. This code looks for setXXX() method where the set method corresponds to the standard bean naming scheme and has a single parameter of type String, int, boolean or short.

setBeanProperties

back to summary

private static void setBeanProperties(Object ds, Reference ref) throws Exception