Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.jdbc.ResourceAdapterImpl

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

Access	Constructor and Description
public	ResourceAdapterImpl()

Method Summary

Modifier and Type	Method and Description
public synchronized boolean	addConnection(XAXactId xid, Object conn) Implements org.apache.derby.iapi.jdbc.ResourceAdapter.addConnection.
public void	boot(boolean True if the database should be created create, Properties Configuration properties properties) Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot. Boot this module with the given properties.
public void	cancelXATransaction(XAXactId tranaction id to cancel xid, String error to report when canceling messageId) Implements org.apache.derby.iapi.jdbc.ResourceAdapter.cancelXATransaction. Cancel the XA transaction identified by the specified xid.
public synchronized Object	findConnection(XAXactId xid) Implements org.apache.derby.iapi.jdbc.ResourceAdapter.findConnection.
private static Object	findServiceModule(final Object serviceModule, final String factoryInterface) Must be private so that user code can't call this entry point.
public XAResourceManager	getXAResourceManager() Implements org.apache.derby.iapi.jdbc.ResourceAdapter.getXAResourceManager. Return the XA Resource manager to the XA Connection
public boolean	isActive() Implements org.apache.derby.iapi.jdbc.ResourceAdapter.isActive. Is the Resource Manager active
public synchronized Object	removeConnection(XAXactId xid) Implements org.apache.derby.iapi.jdbc.ResourceAdapter.removeConnection.
public void	stop() Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop. Stop the module.

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

active	back to summary
private boolean active

connectionTable	back to summary
private Hashtable<XAXactId, XATransactionState> connectionTable

rm	back to summary
private XAResourceManager rm

ResourceAdapterImpl	back to summary
public ResourceAdapterImpl()

Method Detail

addConnection	back to summary
public synchronized boolean addConnection(XAXactId xid, Object conn) Implements org.apache.derby.iapi.jdbc.ResourceAdapter.addConnection.

boot	back to summary
public void boot(boolean create, Properties properties) throws StandardException Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot. Doc from org.apache.derby.iapi.services.monitor.ModuleControl.boot. 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. Parameters create:boolean True if the database should be created properties:Properties Configuration properties Exceptions StandardException: Module cannot be started.

boot

back to summary

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

Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot.

Doc from org.apache.derby.iapi.services.monitor.ModuleControl.boot.

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.

Parameters

create:boolean: True if the database should be created
properties:Properties: Configuration properties

Exceptions

StandardException:: Module cannot be started.

cancelXATransaction back to summary

cancelXATransaction	back to summary
public void cancelXATransaction(XAXactId xid, String messageId) throws XAException Implements org.apache.derby.iapi.jdbc.ResourceAdapter.cancelXATransaction. Doc from org.apache.derby.iapi.jdbc.ResourceAdapter.cancelXATransaction. 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. Parameters xid:XAXactId tranaction id to cancel messageId:String error to report when canceling Exceptions XAException: on error See Also `org.apache.derby.iapi.jdbc.ResourceAdapter#cancelXATransaction(XAXactId, String)`

public void cancelXATransaction(XAXactId xid, String messageId) throws XAException

Implements org.apache.derby.iapi.jdbc.ResourceAdapter.cancelXATransaction.

Doc from org.apache.derby.iapi.jdbc.ResourceAdapter.cancelXATransaction.

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.

Parameters

xid:XAXactId: tranaction id to cancel
messageId:String: error to report when canceling

Exceptions

XAException:: on error

findConnection	back to summary
public synchronized Object findConnection(XAXactId xid) Implements org.apache.derby.iapi.jdbc.ResourceAdapter.findConnection.

findServiceModule	back to summary
private static Object findServiceModule(final Object serviceModule, final String factoryInterface) throws StandardException Must be private so that user code can't call this entry point.

getXAResourceManager	back to summary
public XAResourceManager getXAResourceManager() Implements org.apache.derby.iapi.jdbc.ResourceAdapter.getXAResourceManager. Return the XA Resource manager to the XA Connection Returns:XAResourceManager Doc from org.apache.derby.iapi.jdbc.ResourceAdapter.getXAResourceManager. the XA resource manager

getXAResourceManager

back to summary

public XAResourceManager getXAResourceManager()

Implements org.apache.derby.iapi.jdbc.ResourceAdapter.getXAResourceManager.

Return the XA Resource manager to the XA Connection

Returns:XAResourceManager

Doc from org.apache.derby.iapi.jdbc.ResourceAdapter.getXAResourceManager.

the XA resource manager

isActive	back to summary
public boolean isActive() Implements org.apache.derby.iapi.jdbc.ResourceAdapter.isActive. Doc from org.apache.derby.iapi.jdbc.ResourceAdapter.isActive. Is the Resource Manager active Returns:boolean true if the resource manager is active

isActive

back to summary

public boolean isActive()

Implements org.apache.derby.iapi.jdbc.ResourceAdapter.isActive.

Doc from org.apache.derby.iapi.jdbc.ResourceAdapter.isActive.

Is the Resource Manager active

Returns:boolean: true if the resource manager is active

removeConnection	back to summary
public synchronized Object removeConnection(XAXactId xid) Implements org.apache.derby.iapi.jdbc.ResourceAdapter.removeConnection.

stop	back to summary
public void stop() Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop. Doc from org.apache.derby.iapi.services.monitor.ModuleControl.stop. 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.

stop

back to summary

public void stop()

Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop.

Doc from org.apache.derby.iapi.services.monitor.ModuleControl.stop.

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.

public Class ResourceAdapterImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail