org.apache.derby.jdbc

Class ResourceAdapterImpl

java.lang.Object

org.apache.derby.jdbc.ResourceAdapterImpl

All Implemented Interfaces:

ResourceAdapter, ModuleControl

public class ResourceAdapterImpl
extends java.lang.Object
implements ResourceAdapter, ModuleControl

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	active
private java.util.Hashtable<XAXactId,XATransactionState>	connectionTable
private XAResourceManager	rm

Constructor Summary

Constructors

Constructor and Description
ResourceAdapterImpl()

Method Summary

Modifier and Type	Method and Description
boolean	addConnection(XAXactId xid, java.lang.Object conn)
void	boot(boolean create, java.util.Properties properties) Boot this module with the given properties.
void	cancelXATransaction(XAXactId xid, java.lang.String messageId) Cancel the XA transaction identified by the specified xid.
java.lang.Object	findConnection(XAXactId xid)
XAResourceManager	getXAResourceManager() Return the XA Resource manager to the XA Connection
boolean	isActive() Is the Resource Manager active
java.lang.Object	removeConnection(XAXactId xid)
void	stop() Stop the module.

Methods inherited from class java.lang.Object

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

Field Detail

active

private boolean active

rm

private XAResourceManager rm

connectionTable

private java.util.Hashtable<XAXactId,XATransactionState> connectionTable

Constructor Detail

ResourceAdapterImpl

public ResourceAdapterImpl()

Method Detail

boot

public void boot(boolean create,
                 java.util.Properties properties)
          throws StandardException

Description copied from interface: ModuleControl

Boot this module with the given properties. Creates a module instance that can be found using the findModule() methods of Monitor. The module can only be found using one of these findModule() methods once this method has returned.

An implementation's boot method can throw StandardException. If it is thrown the module is not registered by the monitor and therefore cannot be found through a findModule(). In this case the module's stop() method is not called, thus throwing this exception must free up any resources.

When create is true the contents of the properties object will be written to the service.properties of the persistent service. Thus any code that requires an entry in service.properties must explicitly place the value in this properties set using the put method.
Typically the properties object contains one or more default properties sets, which are not written out to service.properties. These default sets are how callers modify the create process. In a JDBC connection database create the first set of defaults is a properties object that contains the attributes that were set on the jdbc:derby: URL. This attributes properties set has the second default properties set as its default. This set (which could be null) contains the properties that the user set on their DriverManager.getConnection() call, and are thus not owned by Derby code, and thus must not be modified by Derby code.

When create is false the properties object contains all the properties set in the service.properties file plus a limited number of attributes from the JDBC URL attributes or connection properties set. This avoids properties set by the user compromising the boot process. An example of a property passed in from the JDBC world is the bootPassword for encrypted databases.

Code should not hold onto the passed in properties reference after boot time as its contents may change underneath it. At least after the complete boot is completed, the links to all the default sets will be removed.

Specified by:

boot in interface ModuleControl

Throws:

StandardException - Module cannot be started.

See Also:

Monitor, ModuleFactory

stop

public void stop()

Description copied from interface: ModuleControl

Stop the module. The module may be found via a findModule() method until some time after this method returns. Therefore the factory must be prepared to reject requests to it once it has been stopped. In addition other modules may cache a reference to the module and make requests of it after it has been stopped, these requests should be rejected as well.

Specified by:

stop in interface ModuleControl

See Also:

Monitor, ModuleFactory

isActive

public boolean isActive()

Description copied from interface: ResourceAdapter

Is the Resource Manager active

Specified by:

isActive in interface ResourceAdapter

findConnection

public java.lang.Object findConnection(XAXactId xid)

Specified by:

findConnection in interface ResourceAdapter

addConnection

public boolean addConnection(XAXactId xid,
                             java.lang.Object conn)

Specified by:

addConnection in interface ResourceAdapter

removeConnection

public java.lang.Object removeConnection(XAXactId xid)

Specified by:

removeConnection in interface ResourceAdapter

cancelXATransaction

public void cancelXATransaction(XAXactId xid,
                                java.lang.String messageId)
                         throws javax.transaction.xa.XAException

Description copied from interface: ResourceAdapter

Cancel the XA transaction identified by the specified xid. The method will atomically cancel any running statement on behalf of the transaction, end the transaction association with the XAResource instance, and rollback of the global transaction.

Specified by:

cancelXATransaction in interface ResourceAdapter

Parameters:

xid - tranaction id to cancel

messageId - error to report when canceling

Throws:

javax.transaction.xa.XAException

See Also:

ResourceAdapter.cancelXATransaction(XAXactId, String)

getXAResourceManager

public XAResourceManager getXAResourceManager()

Return the XA Resource manager to the XA Connection

Specified by:

getXAResourceManager in interface ResourceAdapter