org.apache.derby.impl.store.raw.xact
Class XactFactory

java.lang.Object
  extended byorg.apache.derby.impl.store.raw.xact.XactFactory
All Implemented Interfaces:
Corruptable, ModuleControl, ModuleSupportable, TransactionFactory

public class XactFactory
extends java.lang.Object
implements TransactionFactory, ModuleControl, ModuleSupportable


Field Summary
protected  ContextService contextFactory
           
protected  DataFactory dataFactory
           
private  boolean inCreateNoLog
           
protected static java.lang.String INTERNAL_CONTEXT_ID
           
protected  LockFactory lockFactory
           
private  LockingPolicy[][] lockingPolicies
           
protected  LogFactory logFactory
           
protected static java.lang.String NESTED_READONLY_USER_CONTEXT_ID
           
protected static java.lang.String NESTED_UPDATE_USER_CONTEXT_ID
           
protected static java.lang.String NTT_CONTEXT_ID
           
protected  DaemonService rawStoreDaemon
           
protected  RawStoreFactory rawStoreFactory
           
private  long tranId
           
 TransactionTable ttab
           
protected static java.lang.String USER_CONTEXT_ID
           
private  UUIDFactory uuidFactory
           
private  XAResourceManager xa_resource
           
 
Fields inherited from interface org.apache.derby.iapi.store.raw.xact.TransactionFactory
MODULE
 
Constructor Summary
XactFactory()
           
 
Method Summary
protected  void add(Xact xact, boolean excludeMe)
           
protected  void addUpdateTransaction(TransactionId id, RawTransaction t, int transactionStatus)
          Add a transaction to the list of transactions that has updated the raw store.
 void boot(boolean create, java.util.Properties properties)
          Boot this module with the given properties.
 boolean canSupport(java.util.Properties startParams)
          See if this implementation can support any attributes that are listed in properties.
 void createFinished()
          Database creation finished
 boolean findTransaction(TransactionId id, RawTransaction tran)
          Find the TransactionTableEntry with the given ID and make the passed in transaction assume the identity and properties of that TransactionTableEntry.
 RawTransaction findUserTransaction(RawStoreFactory rsf, ContextManager contextMgr, java.lang.String transName)
          Find a user transaction within the given raw store and the given contextMgr.
 LogInstant firstUpdateInstant()
          Get the earliest log instant that is still active, ie, the first log record logged by the earliest transaction that is still active.
 boolean flushLogOnCommit(java.lang.String contextName)
          Decide if a transaction of this contextId needs to flush the log when it commits
 LockFactory getLockFactory()
          Get the LockFactory to use with this store.
(package private)  LockingPolicy getLockingPolicy(int mode, int isolation, boolean stricterOk)
          Get a locking policy for a transaction.
 TransactionInfo[] getTransactionInfo()
           
 Formatable getTransactionTable()
          Return the transaction table so it can get logged with the checkpoint log record.
 java.lang.Object getXAResourceManager()
           
 void handlePreparedXacts(RawStoreFactory rsf)
          Run through all prepared transactions known to this factory and restore their state such that they remain after recovery, and can be found and handled by a XA transaction manager.
 boolean inDatabaseCreation()
           
 UUID makeNewUUID()
          Make a new UUID for whomever that wants it
 StandardException markCorrupt(StandardException originalError)
          Really this is just a convience routine for callers that might not have access to a log factory.
 boolean noActiveUpdateTransaction()
          Returns true if there is no in flight updating tranasaction.
protected  void prepareTransaction(TransactionId id)
          Change state of transaction to prepared.
protected  void pushTransactionContext(ContextManager cm, java.lang.String contextName, Xact xact, boolean abortAll, RawStoreFactory rsf, boolean excludeMe)
          Create a new RawTransaction, a context for it and push the context onto the current context manager.
protected  boolean remove(TransactionId xactId)
           
protected  void removeUpdateTransaction(TransactionId id)
          Remove a transaction from the list of transactions that has updated the raw store.
 void resetTranId()
          Reset any resettable transaction Id
 void rollbackAllTransactions(RawTransaction recoveryTransaction, RawStoreFactory rsf)
          Rollback all active transactions that has updated the raw store.
 void setNewTransactionId(TransactionId oldxid, Xact t)
           
 void setRawStoreFactory(RawStoreFactory rsf)
          make Transaction factory aware of which raw store factory it belongs to
private  RawTransaction startCommonTransaction(RawStoreFactory rsf, ContextManager cm, boolean readOnly, java.lang.Object compatibilitySpace, java.lang.String xact_context_id, java.lang.String transName, boolean excludeMe)
          Common work done to create local or global transactions.
 RawTransaction startGlobalTransaction(RawStoreFactory rsf, ContextManager cm, int format_id, byte[] global_id, byte[] branch_id)
          Start a new transaction within the given raw store.
 RawTransaction startInternalTransaction(RawStoreFactory rsf, ContextManager cm)
          Start a new internal transaction within the given raw store.
 RawTransaction startNestedReadOnlyUserTransaction(RawStoreFactory rsf, java.lang.Object compatibilitySpace, ContextManager cm, java.lang.String transName)
          Start a new read only transaction within the given raw store.
 RawTransaction startNestedTopTransaction(RawStoreFactory rsf, ContextManager cm)
          Start a new nested top transaction within the given raw store.
 RawTransaction startNestedUpdateUserTransaction(RawStoreFactory rsf, ContextManager cm, java.lang.String transName)
          Start a new update transaction within the given raw store.
 RawTransaction startTransaction(RawStoreFactory rsf, ContextManager cm, java.lang.String transName)
          Start a new transaction within the given raw store.
 void stop()
          Stop the module.
 boolean submitPostCommitWork(Serviceable work)
          Submit this post commit work to the post commit daemon
 void useTransactionTable(Formatable transactionTable)
          Use this transaction table, which is gotten from a checkpoint operation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

USER_CONTEXT_ID

protected static final java.lang.String USER_CONTEXT_ID
See Also:
Constant Field Values

NESTED_READONLY_USER_CONTEXT_ID

protected static final java.lang.String NESTED_READONLY_USER_CONTEXT_ID
See Also:
Constant Field Values

NESTED_UPDATE_USER_CONTEXT_ID

protected static final java.lang.String NESTED_UPDATE_USER_CONTEXT_ID
See Also:
Constant Field Values

INTERNAL_CONTEXT_ID

protected static final java.lang.String INTERNAL_CONTEXT_ID
See Also:
Constant Field Values

NTT_CONTEXT_ID

protected static final java.lang.String NTT_CONTEXT_ID
See Also:
Constant Field Values

rawStoreDaemon

protected DaemonService rawStoreDaemon

uuidFactory

private UUIDFactory uuidFactory

contextFactory

protected ContextService contextFactory

lockFactory

protected LockFactory lockFactory

logFactory

protected LogFactory logFactory

dataFactory

protected DataFactory dataFactory

rawStoreFactory

protected RawStoreFactory rawStoreFactory

ttab

public TransactionTable ttab

tranId

private long tranId

lockingPolicies

private LockingPolicy[][] lockingPolicies

inCreateNoLog

private boolean inCreateNoLog

xa_resource

private XAResourceManager xa_resource
Constructor Detail

XactFactory

public XactFactory()
Method Detail

canSupport

public boolean canSupport(java.util.Properties startParams)
Description copied from interface: ModuleSupportable
See if this implementation can support any attributes that are listed in properties. This call may be made on a newly created instance before the boot() method has been called, or after the boot method has been called for a running module.

The module can check for attributes in the properties to see if it can fulfill the required behaviour. E.g. the raw store may define an attribute called RawStore.Recoverable. If a temporary raw store is required the property RawStore.recoverable=false would be added to the properties before calling bootServiceModule. If a raw store cannot support this attribute its canSupport method would return null. Also see the Monitor class's prologue to see how the identifier is used in looking up properties.
Actually a better way maybe to have properties of the form RawStore.Attributes.mandatory=recoverable,smallfootprint and RawStore.Attributes.requested=oltp,fast

Specified by:
canSupport in interface ModuleSupportable
Returns:
true if this instance can be used, false otherwise.

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 cloudscape code, and thus must not be modified by cloudscape 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

getLockFactory

public LockFactory getLockFactory()
Get the LockFactory to use with this store.

Specified by:
getLockFactory in interface TransactionFactory

createFinished

public void createFinished()
                    throws StandardException
Database creation finished

Specified by:
createFinished in interface TransactionFactory
Throws:
StandardException - standard cloudscape error policy

startCommonTransaction

private RawTransaction startCommonTransaction(RawStoreFactory rsf,
                                              ContextManager cm,
                                              boolean readOnly,
                                              java.lang.Object compatibilitySpace,
                                              java.lang.String xact_context_id,
                                              java.lang.String transName,
                                              boolean excludeMe)
                                       throws StandardException
Common work done to create local or global transactions.

Parameters:
rsf - the raw store factory creating this xact.
cm - the current context manager to associate the xact with.
compatibilitySpace - if null, use the transaction being created, else if non-null use this compatibilitySpace.
Throws:
StandardException - Standard exception policy.

startTransaction

public RawTransaction startTransaction(RawStoreFactory rsf,
                                       ContextManager cm,
                                       java.lang.String transName)
                                throws StandardException
Description copied from interface: TransactionFactory
Start a new transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startTransaction

Specified by:
startTransaction in interface TransactionFactory
Parameters:
cm - is the context manager to use. It must be the current context manager.
transName - is the transaction name. It will be displayed in the transactiontable VTI.
Throws:
StandardException - Standard Cloudscape error policy.
See Also:
RawStoreFactory.startTransaction(org.apache.derby.iapi.services.context.ContextManager, java.lang.String)

startNestedReadOnlyUserTransaction

public RawTransaction startNestedReadOnlyUserTransaction(RawStoreFactory rsf,
                                                         java.lang.Object compatibilitySpace,
                                                         ContextManager cm,
                                                         java.lang.String transName)
                                                  throws StandardException
Description copied from interface: TransactionFactory
Start a new read only transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startNestedTransaction

Specified by:
startNestedReadOnlyUserTransaction in interface TransactionFactory
Parameters:
compatibilitySpace - compatibility space to use for locks.
cm - is the context manager to use. It must be the current context manager.
transName - is the transaction name. It will be displayed in the transactiontable VTI.
Throws:
StandardException - Standard Cloudscape error policy.
See Also:
RawStoreFactory.startNestedReadOnlyUserTransaction(java.lang.Object, org.apache.derby.iapi.services.context.ContextManager, java.lang.String)

startNestedUpdateUserTransaction

public RawTransaction startNestedUpdateUserTransaction(RawStoreFactory rsf,
                                                       ContextManager cm,
                                                       java.lang.String transName)
                                                throws StandardException
Description copied from interface: TransactionFactory
Start a new update transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startNestedTransaction

Specified by:
startNestedUpdateUserTransaction in interface TransactionFactory
Parameters:
cm - is the context manager to use. It must be the current context manager.
transName - is the transaction name. It will be displayed in the transactiontable VTI.
Throws:
StandardException - Standard Cloudscape error policy.
See Also:
RawStoreFactory.startNestedUpdateUserTransaction(org.apache.derby.iapi.services.context.ContextManager, java.lang.String)

startGlobalTransaction

public RawTransaction startGlobalTransaction(RawStoreFactory rsf,
                                             ContextManager cm,
                                             int format_id,
                                             byte[] global_id,
                                             byte[] branch_id)
                                      throws StandardException
Description copied from interface: TransactionFactory
Start a new transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startTransaction

Specified by:
startGlobalTransaction in interface TransactionFactory
Parameters:
format_id - the format id part of the Xid - ie. Xid.getFormatId().
global_id - the global transaction identifier part of XID - ie. Xid.getGlobalTransactionId().
branch_id - The branch qualifier of the Xid - ie. Xid.getBranchQaulifier()
cm - is the context manager to use. It must be the current context manager.
Throws:
StandardException - Standard Cloudscape error policy.
See Also:
RawStoreFactory.startGlobalTransaction(org.apache.derby.iapi.services.context.ContextManager, int, byte[], byte[])

findUserTransaction

public RawTransaction findUserTransaction(RawStoreFactory rsf,
                                          ContextManager contextMgr,
                                          java.lang.String transName)
                                   throws StandardException
Description copied from interface: TransactionFactory
Find a user transaction within the given raw store and the given contextMgr. If no user transaction exist, then start one with name transName. This method will push a transaction context as described in RawStoreFactory.startTransaction

Specified by:
findUserTransaction in interface TransactionFactory
Throws:
StandardException - Standard Cloudscape error policy.
See Also:
RawStoreFactory.findUserTransaction(org.apache.derby.iapi.services.context.ContextManager, java.lang.String), RawStoreFactory.startTransaction(org.apache.derby.iapi.services.context.ContextManager, java.lang.String)

startNestedTopTransaction

public RawTransaction startNestedTopTransaction(RawStoreFactory rsf,
                                                ContextManager cm)
                                         throws StandardException
Description copied from interface: TransactionFactory
Start a new nested top transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startNestedTopTransaction

Specified by:
startNestedTopTransaction in interface TransactionFactory
Throws:
StandardException - Standard Cloudscape error policy.
See Also:
RawStoreFactory.startTransaction(ContextManager, String)

startInternalTransaction

public RawTransaction startInternalTransaction(RawStoreFactory rsf,
                                               ContextManager cm)
                                        throws StandardException
Description copied from interface: TransactionFactory
Start a new internal transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startInternalTransaction

Specified by:
startInternalTransaction in interface TransactionFactory
Throws:
StandardException - Standard Cloudscape error policy.
See Also:
RawStoreFactory.startTransaction(org.apache.derby.iapi.services.context.ContextManager, java.lang.String)

findTransaction

public boolean findTransaction(TransactionId id,
                               RawTransaction tran)
Find the TransactionTableEntry with the given ID and make the passed in transaction assume the identity and properties of that TransactionTableEntry. Used in recovery only.

Specified by:
findTransaction in interface TransactionFactory

rollbackAllTransactions

public void rollbackAllTransactions(RawTransaction recoveryTransaction,
                                    RawStoreFactory rsf)
                             throws StandardException
Rollback all active transactions that has updated the raw store. Use the recovery Transaction that is passed in to do all the work. Used in recovery only.

Transactions are rolled back in the following order:

  1. internal transactions in reversed beginXact chronological order,
  2. all other transactions in reversed beginXact chronological order,

    Specified by:
    rollbackAllTransactions in interface TransactionFactory
    Parameters:
    recoveryTransaction - use this transaction to do all the user transaction work
    Throws:
    StandardException - any exception thrown during rollback

handlePreparedXacts

public void handlePreparedXacts(RawStoreFactory rsf)
                         throws StandardException
Run through all prepared transactions known to this factory and restore their state such that they remain after recovery, and can be found and handled by a XA transaction manager. This includes creating a context manager for each, pushing a xact context, and reclaiming update locks on all data changed by the transaction. Expected to be called just after the redo and undo recovery loops, where the transaction table should be empty except for prepared xacts. Used only in recovery.

Specified by:
handlePreparedXacts in interface TransactionFactory
Throws:
StandardException - Cloudscape Standard Error policy

firstUpdateInstant

public LogInstant firstUpdateInstant()
Get the earliest log instant that is still active, ie, the first log record logged by the earliest transaction that is still active.
The logging system must guarentee that the transaction table is populated in the order transactions are started. Used in recovery only.

Specified by:
firstUpdateInstant in interface TransactionFactory

markCorrupt

public StandardException markCorrupt(StandardException originalError)
Really this is just a convience routine for callers that might not have access to a log factory.

Specified by:
markCorrupt in interface Corruptable
Returns:
Must always return its parameter.

setNewTransactionId

public void setNewTransactionId(TransactionId oldxid,
                                Xact t)

resetTranId

public void resetTranId()
Description copied from interface: TransactionFactory
Reset any resettable transaction Id

Specified by:
resetTranId in interface TransactionFactory

pushTransactionContext

protected void pushTransactionContext(ContextManager cm,
                                      java.lang.String contextName,
                                      Xact xact,
                                      boolean abortAll,
                                      RawStoreFactory rsf,
                                      boolean excludeMe)
                               throws StandardException
Create a new RawTransaction, a context for it and push the context onto the current context manager. Then add the transacion to the transaction table.

Parameters:
contextName - the name of the transaction context
xact - the Transaction object
abortAll - if true, then any error will abort the whole transaction. Otherwise, let XactContext.cleanupOnError decide what to do
rsf - the raw store factory
excludeMe - during systeme quiesce, i.e., this transaction should not be allowed to be active during a quiesce state.
Throws:
StandardException - Standard Cloudscape error policy

addUpdateTransaction

protected void addUpdateTransaction(TransactionId id,
                                    RawTransaction t,
                                    int transactionStatus)
Add a transaction to the list of transactions that has updated the raw store.

This is called underneath the BeginXact log operation's doMe method. The logging system must guarentee that transactions are added in the true order they are started, as defined by the order of beginXact log record in the log.


removeUpdateTransaction

protected void removeUpdateTransaction(TransactionId id)
Remove a transaction from the list of transactions that has updated the raw store.


prepareTransaction

protected void prepareTransaction(TransactionId id)
Change state of transaction to prepared. Used by recovery to update the transaction table entry to prepared state.


submitPostCommitWork

public boolean submitPostCommitWork(Serviceable work)
Submit this post commit work to the post commit daemon

Specified by:
submitPostCommitWork in interface TransactionFactory
Returns:
true if the daemon indicates it is being overloaded, false it's happy. must be MT-safe

setRawStoreFactory

public void setRawStoreFactory(RawStoreFactory rsf)
                        throws StandardException
Description copied from interface: TransactionFactory
make Transaction factory aware of which raw store factory it belongs to

Specified by:
setRawStoreFactory in interface TransactionFactory
Throws:
StandardException

noActiveUpdateTransaction

public boolean noActiveUpdateTransaction()
Returns true if there is no in flight updating tranasaction. Caller must be aware that if there is no other mechanism to stop transactions from starting and ending, then this information is outdated as soon as it is reported. Only call this function in special times - e.g, during recovery

Specified by:
noActiveUpdateTransaction in interface TransactionFactory

remove

protected boolean remove(TransactionId xactId)

add

protected void add(Xact xact,
                   boolean excludeMe)

makeNewUUID

public UUID makeNewUUID()
Make a new UUID for whomever that wants it


flushLogOnCommit

public boolean flushLogOnCommit(java.lang.String contextName)
Decide if a transaction of this contextId needs to flush the log when it commits


getLockingPolicy

final LockingPolicy getLockingPolicy(int mode,
                                     int isolation,
                                     boolean stricterOk)
Get a locking policy for a transaction.


getTransactionTable

public Formatable getTransactionTable()
Description copied from interface: TransactionFactory
Return the transaction table so it can get logged with the checkpoint log record.

Specified by:
getTransactionTable in interface TransactionFactory

useTransactionTable

public void useTransactionTable(Formatable transactionTable)
                         throws StandardException
Description copied from interface: TransactionFactory
Use this transaction table, which is gotten from a checkpoint operation. Use ONLY during recovery.

Specified by:
useTransactionTable in interface TransactionFactory
Throws:
StandardException - Standard cloudscape exception policy.

getTransactionInfo

public TransactionInfo[] getTransactionInfo()
Specified by:
getTransactionInfo in interface TransactionFactory
See Also:
AccessFactory.getTransactionInfo()

inDatabaseCreation

public boolean inDatabaseCreation()

getXAResourceManager

public java.lang.Object getXAResourceManager()
                                      throws StandardException
Specified by:
getXAResourceManager in interface TransactionFactory
Throws:
StandardException


Apache Derby V10.0 Engine Documentation - Copyright © 1997,2004 The Apache Software Foundation or its licensors, as applicable.