From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../amazon/carbonado/txn/TransactionManager.html | 573 +++++++++++++++++++++ .../amazon/carbonado/txn/TransactionMonitor.html | 239 +++++++++ .../com/amazon/carbonado/txn/TransactionPair.html | 502 ++++++++++++++++++ .../com/amazon/carbonado/txn/TransactionScope.html | 392 ++++++++++++++ .../txn/class-use/TransactionManager.html | 161 ++++++ .../txn/class-use/TransactionMonitor.html | 157 ++++++ .../carbonado/txn/class-use/TransactionPair.html | 117 +++++ .../carbonado/txn/class-use/TransactionScope.html | 193 +++++++ .../com/amazon/carbonado/txn/package-frame.html | 26 + .../com/amazon/carbonado/txn/package-summary.html | 175 +++++++ apidocs/com/amazon/carbonado/txn/package-tree.html | 136 +++++ apidocs/com/amazon/carbonado/txn/package-use.html | 187 +++++++ 12 files changed, 2858 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/txn/TransactionManager.html create mode 100644 apidocs/com/amazon/carbonado/txn/TransactionMonitor.html create mode 100644 apidocs/com/amazon/carbonado/txn/TransactionPair.html create mode 100644 apidocs/com/amazon/carbonado/txn/TransactionScope.html create mode 100644 apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html create mode 100644 apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html create mode 100644 apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html create mode 100644 apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html create mode 100644 apidocs/com/amazon/carbonado/txn/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/txn/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/txn/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/txn/package-use.html (limited to 'apidocs/com/amazon/carbonado/txn') diff --git a/apidocs/com/amazon/carbonado/txn/TransactionManager.html b/apidocs/com/amazon/carbonado/txn/TransactionManager.html new file mode 100644 index 0000000..eae85dc --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionManager.html @@ -0,0 +1,573 @@ + + + + + + +TransactionManager (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.txn
+

Class TransactionManager<Txn>

+
+
+ +
+
    +
  • +
    Type Parameters:
    Txn - Transaction implementation
    +
    +
    +
    public abstract class TransactionManager<Txn>
+extends java.lang.Object
    +
    Generic transaction manager for repositories.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected abstract voidabortTxn(Txn txn) +
      Aborts and closes the given internal transaction.
      +
      protected voidattachNotification(Txn txn) +
      Called to notify internal method that transaction is attached.
      +
      voidclose(boolean suspend) +
      Closes all transaction scopes.
      +
      protected abstract booleancommitTxn(Txn txn) +
      Commits and closes the given internal transaction.
      +
      protected abstract TxncreateTxn(Txn parent, + IsolationLevel level) +
      Creates an internal transaction representation, with the optional parent + transaction.
      +
      protected TxncreateTxn(Txn parent, + IsolationLevel level, + int timeout, + java.util.concurrent.TimeUnit unit) +
      Creates an internal transaction representation, with the optional parent + transaction.
      +
      TransactionScope<Txn>detachLocalScope() +
      Detaches the thread-local TransactionScope from the current thread.
      +
      protected voiddetachNotification(Txn txn) +
      Called to notify internal method that transaction is detached.
      +
      booleanisClosed() 
      TransactionScope<Txn>localScope() +
      Returns the thread-local TransactionScope, creating it if needed.
      +
      protected voidreuseTxn(Txn txn) +
      Called when a transaction is about to be reused.
      +
      protected abstract IsolationLevelselectIsolationLevel(Transaction parent, + IsolationLevel level) +
      Returns supported isolation level, which may be higher.
      +
      protected voidsetForUpdate(Txn txn, + boolean forUpdate) +
      Called when the Transaction.setForUpdate method is called.
      +
      protected abstract booleansupportsForUpdate() +
      Return true if transactions support "for update" mode.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TransactionManager

        +
        public TransactionManager()
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        localScope

        +
        public TransactionScope<Txn> localScope()
        +
        Returns the thread-local TransactionScope, creating it if needed.
        +
        • +
      + + + +
        +
      • +

        detachLocalScope

        +
        public TransactionScope<Txn> detachLocalScope()
        +
        Detaches the thread-local TransactionScope from the current thread. It + can be attached later, and to any thread + which does not currently have a TransactionScope.
        +
        Returns:
        detached thread-local TransactionScope or null if none
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close(boolean suspend)
+           throws RepositoryException
        +
        Closes all transaction scopes. Should be called only when repository is + closed.
        +
        Parameters:
        suspend - when true, indefinitely suspend all threads interacting + with transactions
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        isClosed

        +
        public boolean isClosed()
        +
        • +
      + + + +
        +
      • +

        selectIsolationLevel

        +
        protected abstract IsolationLevel selectIsolationLevel(Transaction parent,
+                                  IsolationLevel level)
        +
        Returns supported isolation level, which may be higher. If isolation + level cannot go higher (or lower than parent) then return null.
        +
        Parameters:
        parent - optional parent transaction
        level - desired isolation level (may be null)
        +
        • +
      + + + +
        +
      • +

        supportsForUpdate

        +
        protected abstract boolean supportsForUpdate()
        +
        Return true if transactions support "for update" mode.
        +
        Since:
        +
        1.2
        +
        • +
      + + + + + +
        +
      • +

        createTxn

        +
        protected abstract Txn createTxn(Txn parent,
+            IsolationLevel level)
+                          throws java.lang.Exception
        +
        Creates an internal transaction representation, with the optional parent + transaction. If parent is not null and real nested transactions are not + supported, simply return parent transaction for supporting fake nested + transactions.
        +
        Parameters:
        parent - optional parent transaction
        level - required isolation level
        +
        Returns:
        new transaction, parent transaction, or possibly null if required + isolation level is none
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + +
        +
      • +

        createTxn

        +
        protected Txn createTxn(Txn parent,
+            IsolationLevel level,
+            int timeout,
+            java.util.concurrent.TimeUnit unit)
+                 throws java.lang.Exception
        +
        Creates an internal transaction representation, with the optional parent + transaction. If parent is not null and real nested transactions are not + supported, simply return parent transaction for supporting fake nested + transactions. + +

        The default implementation of this method just calls the regular + createTxn method, ignoring the timeout parameter.

        +
        Parameters:
        parent - optional parent transaction
        level - required isolation level
        timeout - desired timeout for lock acquisition, never negative
        unit - timeout unit, never null
        +
        Returns:
        new transaction, parent transaction, or possibly null if required + isolation level is none
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + +
        +
      • +

        reuseTxn

        +
        protected void reuseTxn(Txn txn)
+                 throws java.lang.Exception
        +
        Called when a transaction is about to be reused. The default + implementation of this method does nothing. Override if any preparation + is required to ready a transaction for reuse.
        +
        Parameters:
        txn - transaction to reuse, never null
        +
        Throws:
        +
        java.lang.Exception
        Since:
        +
        1.1.3
        +
        • +
      + + + + + +
        +
      • +

        setForUpdate

        +
        protected void setForUpdate(Txn txn,
+                boolean forUpdate)
        +
        Called when the Transaction.setForUpdate method is called. The default + implementation of this method does nothing. Override if internal + transaction needs to switch modes.
        +
        Since:
        +
        1.2.1
        +
        • +
      + + + + + +
        +
      • +

        attachNotification

        +
        protected void attachNotification(Txn txn)
        +
        Called to notify internal method that transaction is attached. + The default implementation of this method does nothing. Override if + using remote transactions.
        +
        Parameters:
        txn - transaction that is attached, could be null if none exists
        Since:
        +
        1.2.2
        +
        • +
      + + + + + +
        +
      • +

        detachNotification

        +
        protected void detachNotification(Txn txn)
        +
        Called to notify internal method that transaction is detached. + The default implementation of this method does nothing. Override if + using remote transactions.
        +
        Parameters:
        txn - transaction that is dettached, could be null if none exists
        Since:
        +
        1.2.2
        +
        • +
      + + + + + +
        +
      • +

        commitTxn

        +
        protected abstract boolean commitTxn(Txn txn)
+                              throws PersistException
        +
        Commits and closes the given internal transaction.
        +
        Returns:
        true if transaction object is still valid
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/TransactionMonitor.html b/apidocs/com/amazon/carbonado/txn/TransactionMonitor.html new file mode 100644 index 0000000..95d017e --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionMonitor.html @@ -0,0 +1,239 @@ + + + + + + +TransactionMonitor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.txn
+

Interface TransactionMonitor

+
+
+
+
    +
  • +
    +
    +
    public interface TransactionMonitor
    +
    Is notified as transactions enter and exit. Implementation must be thread-safe.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    TransactionManager
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidentered(Transaction entered, + Transaction parent) +
      Called by a thread which has just entered a transaction.
      +
      voidexited(Transaction exited, + Transaction active) +
      Called by a thread which has just exited a transaction.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        entered

        +
        void entered(Transaction entered,
+           Transaction parent)
        +
        Called by a thread which has just entered a transaction.
        +
        Parameters:
        entered - transaction just entered
        parent - optional parent of transaction; is null for top level transactions
        +
        • +
      + + + +
        +
      • +

        exited

        +
        void exited(Transaction exited,
+          Transaction active)
        +
        Called by a thread which has just exited a transaction. Only the first + invocation of the exit method is passed to this monitor.
        +
        Parameters:
        exited - transaction just exited
        active - optional transaction which is now active; is null if the + outermost transaction scope exited
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/TransactionPair.html b/apidocs/com/amazon/carbonado/txn/TransactionPair.html new file mode 100644 index 0000000..37080e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionPair.html @@ -0,0 +1,502 @@ + + + + + + +TransactionPair (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.txn
+

Class TransactionPair

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Transaction
    +
    +
    +
    +
    public class TransactionPair
+extends java.lang.Object
+implements Transaction
    +
    Pairs two transaction together into one. The transaction cannot be atomic, + however. Inconsistencies can result if the primary transaction succeeds in + committing, but the secondary fails. Therefore, the designated primary + transaction should be the one that is more likely to fail. For example, the + primary transaction might rely on the network, but the secondary operates + locally.
    +
    Author:
    +
    Don Schneider, Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidattach() +
      Attaches this transaction to the current thread, if it has been + detached.
      +
      voidcommit() +
      If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.
      +
      voiddetach() +
      Detaches this transaction from the current thread.
      +
      voidexit() +
      Closes the current transaction, aborting all changes since the last + commit.
      +
      IsolationLevelgetIsolationLevel() +
      Returns the isolation level of this transaction.
      +
      booleanisForUpdate() +
      Returns true if this transaction is in update mode, which is adjusted by + calling Transaction.setForUpdate(boolean).
      +
      booleanpreCommit() +
      Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads.
      +
      voidsetDesiredLockTimeout(int timeout, + java.util.concurrent.TimeUnit unit) +
      Specify a desired timeout for aquiring locks within this + transaction.
      +
      voidsetForUpdate(boolean forUpdate) +
      Set to true to force all read operations within this transaction to + acquire upgradable or write locks.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TransactionPair

        +
        public TransactionPair(Transaction primaryTransaction,
+               Transaction secondaryTransaction)
        +
        Parameters:
        primaryTransaction - is committed first, exited last
        secondaryTransaction - is exited first, commited last
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        commit

        +
        public void commit()
+            throws PersistException
        +
        Description copied from interface: Transaction
        +
        If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.
        +
        +
        Specified by:
        +
        commit in interface Transaction
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        exit

        +
        public void exit()
+          throws PersistException
        +
        Description copied from interface: Transaction
        +
        Closes the current transaction, aborting all changes since the last + commit.
        +
        +
        Specified by:
        +
        exit in interface Transaction
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        setForUpdate

        +
        public void setForUpdate(boolean forUpdate)
        +
        Description copied from interface: Transaction
        +
        Set to true to force all read operations within this transaction to + acquire upgradable or write locks. This option eliminates deadlocks that + may occur when updating records, except it may increase contention.
        +
        +
        Specified by:
        +
        setForUpdate in interface Transaction
        +
        +
        • +
      + + + + + + + +
        +
      • +

        setDesiredLockTimeout

        +
        public void setDesiredLockTimeout(int timeout,
+                         java.util.concurrent.TimeUnit unit)
        +
        Description copied from interface: Transaction
        +
        Specify a desired timeout for aquiring locks within this + transaction. Calling this method may have have no effect at all, if the + repository does not support this feature. In addition, the lock timeout + might not be alterable if the transaction contains uncommitted data. + +

        Also, the range of lock timeout values supported might be small. For + example, only a timeout value of zero might be supported. In that case, + the transaction is configured to not wait at all when trying to acquire + locks. Expect immediate timeout exceptions when locks cannot be + granted. + +

        Nested transactions inherit the desired lock timeout of their + parent. Top transactions always begin with the default lock timeout.

        +
        +
        Specified by:
        +
        setDesiredLockTimeout in interface Transaction
        +
        Parameters:
        timeout - Desired lock timeout. If negative, revert lock timeout to + default value.
        unit - Time unit for timeout. If null, revert lock timeout to + default value.
        +
        • +
      + + + + + + + +
        +
      • +

        detach

        +
        public void detach()
        +
        Description copied from interface: Transaction
        +
        Detaches this transaction from the current thread. It can be attached + later, and to any thread which currently has no thread-local + transaction. + +

        Detaching a transaction also detaches any parent and nested child + transactions. Attaching any of them achieves the same result as + attaching this transaction.

        +
        +
        Specified by:
        +
        detach in interface Transaction
        +
        +
        • +
      + + + +
        +
      • +

        attach

        +
        public void attach()
        +
        Description copied from interface: Transaction
        +
        Attaches this transaction to the current thread, if it has been + detached. Attaching a transaction also attaches any parent and nested + child transactions.
        +
        +
        Specified by:
        +
        attach in interface Transaction
        +
        +
        • +
      + + + +
        +
      • +

        preCommit

        +
        public boolean preCommit()
+                  throws PersistException
        +
        Description copied from interface: Transaction
        +
        Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads. The + commit method must still be called to finish the commit. Most applications + have no use for pre-commit and should only ever call commit. + +

        The intent of this method is to complete as many operations as + possible leading up to the actual commit. If pre-commit succeeds, then + commit will most likely succeed as well. While in a pre-commit state, the + transaction can still be used by the current thread. Calling pre-commit + again ensures that child transactions and cursors are closed.

        +
        +
        Specified by:
        +
        preCommit in interface Transaction
        +
        Returns:
        false if transaction has exited
        +
        Throws:
        +
        PersistException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/TransactionScope.html b/apidocs/com/amazon/carbonado/txn/TransactionScope.html new file mode 100644 index 0000000..20f215b --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionScope.html @@ -0,0 +1,392 @@ + + + + + + +TransactionScope (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.txn
+

Class TransactionScope<Txn>

+
+
+ +
+
    +
  • +
    Type Parameters:
    Txn - Transaction implementation
    +
    +
    +
    public class TransactionScope<Txn>
+extends java.lang.Object
    +
    Container of thread local, scoped transactions.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    TransactionManager
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidattach() +
      Attach this scope to the current thread, if it has been detached.
      +
      Transactionenter(IsolationLevel level) +
      Enters a new transaction scope which becomes the active transaction.
      +
      TransactionenterTop(IsolationLevel level) +
      Enters a new top-level transaction scope which becomes the active + transaction.
      +
      IsolationLevelgetIsolationLevel() +
      Returns the isolation level of the active transaction, or null if there + is no active transaction.
      +
      java.util.concurrent.locks.LockgetLock() +
      Returns lock used by TransactionScope.
      +
      TxngetTxn() +
      Returns the implementation for the active transaction, or null if there + is no active transaction.
      +
      booleanisForUpdate() +
      Returns true if an active transaction exists and it is for update.
      +
      <S extends Storable> 
      void      		register(java.lang.Class<S> type, + Cursor<S> cursor) +
      Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close.
      +
      <S extends Storable> 
      void      		unregister(java.lang.Class<S> type, + Cursor<S> cursor) +
      Unregisters a previously registered cursor.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        enter

        +
        public Transaction enter(IsolationLevel level)
        +
        Enters a new transaction scope which becomes the active transaction.
        +
        Parameters:
        level - desired isolation level (may be null)
        +
        Throws:
        +
        java.lang.UnsupportedOperationException - if isolation level higher than + supported by repository
        +
        • +
      + + + +
        +
      • +

        enterTop

        +
        public Transaction enterTop(IsolationLevel level)
        +
        Enters a new top-level transaction scope which becomes the active + transaction.
        +
        Parameters:
        level - desired isolation level (may be null)
        +
        Throws:
        +
        java.lang.UnsupportedOperationException - if isolation level higher than + supported by repository
        +
        • +
      + + + +
        +
      • +

        register

        +
        public <S extends Storable> void register(java.lang.Class<S> type,
+                                 Cursor<S> cursor)
        +
        Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close. If there + is no active transaction in scope, the cursor is registered as not part + of a transaction. Cursors should register when created.
        +
        • +
      + + + +
        +
      • +

        unregister

        +
        public <S extends Storable> void unregister(java.lang.Class<S> type,
+                                   Cursor<S> cursor)
        +
        Unregisters a previously registered cursor. Cursors should unregister + when closed.
        +
        • +
      + + + +
        +
      • +

        getLock

        +
        public java.util.concurrent.locks.Lock getLock()
        +
        Returns lock used by TransactionScope. While holding lock, operations + are suspended.
        +
        • +
      + + + +
        +
      • +

        getTxn

        +
        public Txn getTxn()
+           throws java.lang.Exception
        +
        Returns the implementation for the active transaction, or null if there + is no active transaction.
        +
        Throws:
        +
        java.lang.Exception - thrown by createTxn or reuseTxn
        +
        • +
      + + + +
        +
      • +

        isForUpdate

        +
        public boolean isForUpdate()
        +
        Returns true if an active transaction exists and it is for update.
        +
        • +
      + + + +
        +
      • +

        getIsolationLevel

        +
        public IsolationLevel getIsolationLevel()
        +
        Returns the isolation level of the active transaction, or null if there + is no active transaction.
        +
        • +
      + + + +
        +
      • +

        attach

        +
        public void attach()
        +
        Attach this scope to the current thread, if it has been detached.
        +
        Throws:
        +
        java.lang.IllegalStateException - if current thread has a different + transaction already attached
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html new file mode 100644 index 0000000..5b68ce4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Class com.amazon.carbonado.txn.TransactionManager (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.txn.TransactionManager

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html new file mode 100644 index 0000000..b573164 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html @@ -0,0 +1,157 @@ + + + + + + +Uses of Interface com.amazon.carbonado.txn.TransactionMonitor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.txn.TransactionMonitor

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html new file mode 100644 index 0000000..742eea7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.txn.TransactionPair (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.txn.TransactionPair

+
+
No usage of com.amazon.carbonado.txn.TransactionPair
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html new file mode 100644 index 0000000..65c8f0a --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html @@ -0,0 +1,193 @@ + + + + + + +Uses of Class com.amazon.carbonado.txn.TransactionScope (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.txn.TransactionScope

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/package-frame.html b/apidocs/com/amazon/carbonado/txn/package-frame.html new file mode 100644 index 0000000..afb6b1a --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +com.amazon.carbonado.txn (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.txn

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/txn/package-summary.html b/apidocs/com/amazon/carbonado/txn/package-summary.html new file mode 100644 index 0000000..8ffb693 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-summary.html @@ -0,0 +1,175 @@ + + + + + + +com.amazon.carbonado.txn (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.txn

+
+
Provides support for managing transactions.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.txn Description

+
Provides support for managing transactions.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/package-tree.html b/apidocs/com/amazon/carbonado/txn/package-tree.html new file mode 100644 index 0000000..47040ec --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-tree.html @@ -0,0 +1,136 @@ + + + + + + +com.amazon.carbonado.txn Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.txn

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/package-use.html b/apidocs/com/amazon/carbonado/txn/package-use.html new file mode 100644 index 0000000..eaf68b1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-use.html @@ -0,0 +1,187 @@ + + + + + + +Uses of Package com.amazon.carbonado.txn (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.txn

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3