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 --- .../repo/indexed/IndexEntryAccessCapability.html | 226 +++ .../carbonado/repo/indexed/IndexEntryAccessor.html | 346 ++++ .../repo/indexed/IndexedRepositoryBuilder.html | 616 ++++++ .../carbonado/repo/indexed/StoredIndexInfo.html | 375 ++++ .../amazon/carbonado/repo/indexed/Unindexed.html | 171 ++ .../class-use/IndexEntryAccessCapability.html | 117 ++ .../repo/indexed/class-use/IndexEntryAccessor.html | 163 ++ .../class-use/IndexedRepositoryBuilder.html | 117 ++ .../repo/indexed/class-use/StoredIndexInfo.html | 117 ++ .../repo/indexed/class-use/Unindexed.html | 189 ++ .../carbonado/repo/indexed/package-frame.html | 27 + .../carbonado/repo/indexed/package-summary.html | 187 ++ .../carbonado/repo/indexed/package-tree.html | 162 ++ .../amazon/carbonado/repo/indexed/package-use.html | 185 ++ .../amazon/carbonado/repo/jdbc/JDBCBlobLoader.html | 215 ++ .../amazon/carbonado/repo/jdbc/JDBCClobLoader.html | 215 ++ .../repo/jdbc/JDBCConnectionCapability.html | 370 ++++ .../carbonado/repo/jdbc/JDBCRepositoryBuilder.html | 947 +++++++++ .../carbonado/repo/jdbc/JDBCStorableInfo.html | 423 ++++ .../repo/jdbc/JDBCStorableIntrospector.html | 297 +++ .../carbonado/repo/jdbc/JDBCStorableProperty.html | 554 +++++ .../amazon/carbonado/repo/jdbc/JDBCSupport.html | 348 ++++ .../carbonado/repo/jdbc/LoggingDataSource.html | 447 +++++ .../carbonado/repo/jdbc/SimpleDataSource.html | 501 +++++ .../repo/jdbc/class-use/JDBCBlobLoader.html | 161 ++ .../repo/jdbc/class-use/JDBCClobLoader.html | 161 ++ .../jdbc/class-use/JDBCConnectionCapability.html | 177 ++ .../repo/jdbc/class-use/JDBCRepositoryBuilder.html | 117 ++ .../repo/jdbc/class-use/JDBCStorableInfo.html | 165 ++ .../jdbc/class-use/JDBCStorableIntrospector.html | 117 ++ .../repo/jdbc/class-use/JDBCStorableProperty.html | 203 ++ .../carbonado/repo/jdbc/class-use/JDBCSupport.html | 117 ++ .../repo/jdbc/class-use/LoggingDataSource.html | 117 ++ .../repo/jdbc/class-use/SimpleDataSource.html | 117 ++ .../amazon/carbonado/repo/jdbc/package-frame.html | 32 + .../carbonado/repo/jdbc/package-summary.html | 218 ++ .../amazon/carbonado/repo/jdbc/package-tree.html | 191 ++ .../amazon/carbonado/repo/jdbc/package-use.html | 177 ++ .../amazon/carbonado/repo/logging/CommonsLog.html | 299 +++ apidocs/com/amazon/carbonado/repo/logging/Log.html | 228 +++ .../repo/logging/LogAccessCapability.html | 216 ++ .../repo/logging/LoggingRepositoryBuilder.html | 484 +++++ .../repo/logging/class-use/CommonsLog.html | 117 ++ .../carbonado/repo/logging/class-use/Log.html | 195 ++ .../logging/class-use/LogAccessCapability.html | 117 ++ .../class-use/LoggingRepositoryBuilder.html | 117 ++ .../carbonado/repo/logging/package-frame.html | 26 + .../carbonado/repo/logging/package-summary.html | 177 ++ .../carbonado/repo/logging/package-tree.html | 144 ++ .../amazon/carbonado/repo/logging/package-use.html | 154 ++ .../carbonado/repo/map/MapRepositoryBuilder.html | 481 +++++ .../repo/map/class-use/MapRepositoryBuilder.html | 117 ++ .../amazon/carbonado/repo/map/package-frame.html | 20 + .../amazon/carbonado/repo/map/package-summary.html | 147 ++ .../amazon/carbonado/repo/map/package-tree.html | 134 ++ .../com/amazon/carbonado/repo/map/package-use.html | 117 ++ .../replicated/ReplicatedRepositoryBuilder.html | 473 +++++ .../class-use/ReplicatedRepositoryBuilder.html | 117 ++ .../carbonado/repo/replicated/package-frame.html | 20 + .../carbonado/repo/replicated/package-summary.html | 151 ++ .../carbonado/repo/replicated/package-tree.html | 134 ++ .../carbonado/repo/replicated/package-use.html | 117 ++ .../carbonado/repo/sleepycat/BDBPanicHandler.html | 217 ++ .../carbonado/repo/sleepycat/BDBProduct.html | 392 ++++ .../BDBRepositoryBuilder.DatabaseHook.html | 237 +++ .../repo/sleepycat/BDBRepositoryBuilder.html | 2121 ++++++++++++++++++++ .../repo/sleepycat/CheckpointCapability.html | 291 +++ .../sleepycat/CompactionCapability.Result.html | 264 +++ .../repo/sleepycat/CompactionCapability.html | 244 +++ .../repo/sleepycat/EnvironmentCapability.html | 284 +++ .../repo/sleepycat/HotBackupCapability.Backup.html | 309 +++ .../repo/sleepycat/HotBackupCapability.html | 333 +++ .../repo/sleepycat/StoredDatabaseInfo.html | 537 +++++ .../repo/sleepycat/class-use/BDBPanicHandler.html | 177 ++ .../repo/sleepycat/class-use/BDBProduct.html | 198 ++ .../BDBRepositoryBuilder.DatabaseHook.html | 177 ++ .../sleepycat/class-use/BDBRepositoryBuilder.html | 117 ++ .../sleepycat/class-use/CheckpointCapability.html | 117 ++ .../class-use/CompactionCapability.Result.html | 162 ++ .../sleepycat/class-use/CompactionCapability.html | 117 ++ .../sleepycat/class-use/EnvironmentCapability.html | 117 ++ .../class-use/HotBackupCapability.Backup.html | 181 ++ .../sleepycat/class-use/HotBackupCapability.html | 117 ++ .../sleepycat/class-use/StoredDatabaseInfo.html | 117 ++ .../carbonado/repo/sleepycat/package-frame.html | 36 + .../carbonado/repo/sleepycat/package-summary.html | 228 +++ .../carbonado/repo/sleepycat/package-tree.html | 162 ++ .../carbonado/repo/sleepycat/package-use.html | 169 ++ 88 files changed, 21108 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCSupport.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/LoggingDataSource.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/SimpleDataSource.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableIntrospector.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/LoggingDataSource.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/SimpleDataSource.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/Log.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/LogAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/class-use/CommonsLog.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/class-use/LoggingRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/class-use/ReplicatedRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/BDBProduct.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/StoredDatabaseInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/package-use.html (limited to 'apidocs/com/amazon/carbonado/repo') diff --git a/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html new file mode 100644 index 0000000..53038eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html @@ -0,0 +1,226 @@ + + + + + + +IndexEntryAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.indexed
+

Interface IndexEntryAccessCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface IndexEntryAccessCapability
+extends Capability
    +
    Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <S extends Storable> 
      IndexEntryAccessor<S>[]      		getIndexEntryAccessors(java.lang.Class<S> storableType) +
      Returns index entry accessors for the known indexes of the given + storable type.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIndexEntryAccessors

        +
        <S extends Storable> IndexEntryAccessor<S>[] getIndexEntryAccessors(java.lang.Class<S> storableType)
+                                                                throws RepositoryException
        +
        Returns index entry accessors for the known indexes of the given + storable type. The array might be empty, but it is never null. The array + is a copy, and so it may be safely modified.
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/indexed/IndexEntryAccessor.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html new file mode 100644 index 0000000..7a61df5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html @@ -0,0 +1,346 @@ + + + + + + +IndexEntryAccessor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.indexed
+

Interface IndexEntryAccessor<S extends Storable>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    IndexInfo
    +
    +
    +
    +
    public interface IndexEntryAccessor<S extends Storable>
+extends IndexInfo
    +
    Provides low-level access to index data, which can be used for manual + inspection and repair.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IndexEntryAccessCapability
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidcopyFromMaster(Storable indexEntry, + S master) +
      Sets all the properties of the given index entry, using the applicable + properties of the given master.
      +
      voidcopyToMasterPrimaryKey(Storable indexEntry, + S master) +
      Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.
      +
      java.util.Comparator<? extends Storable>getComparator() +
      Returns a comparator for ordering index entries.
      +
      Storage<?>getIndexEntryStorage() +
      Returns the index entry storage.
      +
      booleanisConsistent(Storable indexEntry, + S master) +
      Returns true if the properties of the given index entry match those + contained in the master, exluding any version property.
      +
      voidrepair(double desiredSpeed) +
      Repairs the index by inserting missing entries and fixing + inconsistencies.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIndexEntryStorage

        +
        Storage<?> getIndexEntryStorage()
        +
        Returns the index entry storage.
        +
        • +
      + + + + + +
        +
      • +

        copyToMasterPrimaryKey

        +
        void copyToMasterPrimaryKey(Storable indexEntry,
+                          S master)
+                            throws FetchException
        +
        Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.
        +
        Parameters:
        indexEntry - source of property values
        master - master whose primary key properties will be set
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        copyFromMaster

        +
        void copyFromMaster(Storable indexEntry,
+                  S master)
+                    throws FetchException
        +
        Sets all the properties of the given index entry, using the applicable + properties of the given master.
        +
        Parameters:
        indexEntry - index entry whose properties will be set
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        isConsistent

        +
        boolean isConsistent(Storable indexEntry,
+                   S master)
+                     throws FetchException
        +
        Returns true if the properties of the given index entry match those + contained in the master, exluding any version property. This will always + return true after a call to copyFromMaster.
        +
        Parameters:
        indexEntry - index entry whose properties will be tested
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        repair

        +
        void repair(double desiredSpeed)
+            throws RepositoryException
        +
        Repairs the index by inserting missing entries and fixing + inconsistencies.
        +
        Parameters:
        desiredSpeed - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        getComparator

        +
        java.util.Comparator<? extends Storable> getComparator()
        +
        Returns a comparator for ordering index entries.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/indexed/IndexedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html new file mode 100644 index 0000000..a18c2a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html @@ -0,0 +1,616 @@ + + + + + + +IndexedRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.indexed
+

Class IndexedRepositoryBuilder

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      voiderrorCheck(java.util.Collection<java.lang.String> messages) +
      This method is called by assertReady, and subclasses must override to + perform custom checks.
      +
      doublegetIndexRepairThrottle() +
      Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.
      +
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      RepositoryBuildergetWrappedRepository() 
      booleanisAllClustered() +
      Returns true if all indexes should be identified as clustered.
      +
      booleanisIndexRepairEnabled() 
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      voidsetAllClustered(boolean clustered) +
      When all indexes are identified as clustered, the query analyzer treats + all indexes as performing equally well.
      +
      voidsetIndexRepairDiscardDuplicates(boolean discardDuplicates) +
      Set true to skip collisions during index repair, logging each as a + warning.
      +
      voidsetIndexRepairEnabled(boolean enabled) +
      By default, index repair is enabled.
      +
      voidsetIndexRepairThrottle(double desiredSpeed) +
      Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.
      +
      voidsetIndexRepairVerifyOnly(boolean verifyOnly) +
      Set true to build and verify indexes, but don't apply any changes.
      +
      voidsetMaster(boolean b) +
      Set to false if repository should not assume the role of master.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      voidsetStrictTriggers(boolean strict) +
      Set to true to require that index maintenance triggers use a "for update" transaction, + avoiding deadlocks and lock upgrade failures.
      +
      voidsetWrappedRepository(RepositoryBuilder repoBuilder) +
      Set the required wrapped respository, which must support the + IndexInfoCapability.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        IndexedRepositoryBuilder

        +
        public IndexedRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        getWrappedRepository

        +
        public RepositoryBuilder getWrappedRepository()
        +
        Returns:
        wrapped respository
        +
        • +
      + + + +
        +
      • +

        setWrappedRepository

        +
        public void setWrappedRepository(RepositoryBuilder repoBuilder)
        +
        Set the required wrapped respository, which must support the + IndexInfoCapability.
        +
        • +
      + + + + + + + +
        +
      • +

        setIndexRepairEnabled

        +
        public void setIndexRepairEnabled(boolean enabled)
        +
        By default, index repair is enabled. In this mode, the first time a + Storable type is used, new indexes are populated and old indexes are + removed. Until finished, access to the Storable is blocked. + +

        When index repair is disabled, the Storable is immediately + available. This does have consequences, however. The set of indexes + available for queries is defined by the intersection of the old + and new index sets. The set of indexes that are kept up-to-date is + defined by the union of the old and new index sets. + +

        While index repair is disabled, another process can safely repair the + indexes in the background. When it is complete, index repair can be + enabled for this repository too.

        +
        • +
      + + + +
        +
      • +

        getIndexRepairThrottle

        +
        public double getIndexRepairThrottle()
        +
        Returns the throttle parameter used when indexes are added, dropped or + bulk repaired. By default this value is 1.0, or maximum speed.
        +
        • +
      + + + +
        +
      • +

        setIndexRepairThrottle

        +
        public void setIndexRepairThrottle(double desiredSpeed)
        +
        Sets the throttle parameter used when indexes are added, dropped or bulk + repaired. By default this value is 1.0, or maximum speed.
        +
        Parameters:
        desiredSpeed - 1.0 = perform work at full speed, + 0.5 = perform work at half speed, 0.0 = fully suspend work
        +
        • +
      + + + +
        +
      • +

        setIndexRepairDiscardDuplicates

        +
        public void setIndexRepairDiscardDuplicates(boolean discardDuplicates)
        +
        Set true to skip collisions during index repair, logging each as a + warning.
        +
        • +
      + + + +
        +
      • +

        setIndexRepairVerifyOnly

        +
        public void setIndexRepairVerifyOnly(boolean verifyOnly)
        +
        Set true to build and verify indexes, but don't apply any changes.
        +
        • +
      + + + +
        +
      • +

        isAllClustered

        +
        public boolean isAllClustered()
        +
        Returns true if all indexes should be identified as clustered. This + affects how indexes are selected by the query analyzer.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setAllClustered

        +
        public void setAllClustered(boolean clustered)
        +
        When all indexes are identified as clustered, the query analyzer treats + all indexes as performing equally well. This is suitable for indexing + repositories that never read from a slow storage medium.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setStrictTriggers

        +
        public void setStrictTriggers(boolean strict)
        +
        Set to true to require that index maintenance triggers use a "for update" transaction, + avoiding deadlocks and lock upgrade failures.
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html b/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html new file mode 100644 index 0000000..9ce8482 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html @@ -0,0 +1,375 @@ + + + + + + +StoredIndexInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.indexed
+

Interface StoredIndexInfo

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Storable, Unevolvable, Unindexed
    +
    +
    +
    +
    @PrimaryKey(value="indexName")
+@Independent
+@Alias(value="CARBONADO_INDEX_INFO")
+public interface StoredIndexInfo
+extends Storable, Unevolvable, Unindexed
    +
    Stores basic information about the indexes managed by IndexedRepository. + +

    Note: This storable cannot have indexes defined, since it is used to + discover information about indexes. It would create a cyclic dependency.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIndexName

        +
        java.lang.String getIndexName()
        +
        Returns the index name, which is also a valid index name + descriptor. This descriptor is defined by StorableIndex. The name descriptor does not + contain type information.
        +
        • +
      + + + +
        +
      • +

        setIndexName

        +
        void setIndexName(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        getIndexTypeDescriptor

        +
        @Nullable
+java.lang.String getIndexTypeDescriptor()
        +
        Returns the types of the index properties. This descriptor is defined by + StorableIndex.
        +
        • +
      + + + +
        +
      • +

        setIndexTypeDescriptor

        +
        void setIndexTypeDescriptor(java.lang.String descriptor)
        +
        • +
      + + + +
        +
      • +

        getCreationTimestamp

        +
        long getCreationTimestamp()
        +
        Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.
        +
        • +
      + + + +
        +
      • +

        setCreationTimestamp

        +
        void setCreationTimestamp(long timestamp)
        +
        • +
      + + + +
        +
      • +

        getVersionNumber

        +
        @Version
+int getVersionNumber()
        +
        Record version number for this StoredIndexInfo instance. Some encoding + strategies require a version number.
        +
        • +
      + + + +
        +
      • +

        setVersionNumber

        +
        void setVersionNumber(int version)
        +
        • +
      + + + +
        +
      • +

        getExtraData

        +
        @Nullable
+byte[] getExtraData()
        +
        Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.
        +
        • +
      + + + +
        +
      • +

        setExtraData

        +
        void setExtraData(byte[] data)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/indexed/Unindexed.html b/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html new file mode 100644 index 0000000..1563e98 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html @@ -0,0 +1,171 @@ + + + + + + +Unindexed (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.indexed
+

Interface Unindexed

+
+
+
+
    +
  • +
    +
    All Known Subinterfaces:
    +
    StoredIndexInfo
    +
    +
    +
    All Known Implementing Classes:
    +
    StoredDatabaseInfo
    +
    +
    +
    +
    public interface Unindexed
    +
    Marker interface for storables that are not allowed to have indexes.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/indexed/class-use/IndexEntryAccessCapability.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html new file mode 100644 index 0000000..38e77db --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability

+
+
No usage of com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html new file mode 100644 index 0000000..0349ef9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html @@ -0,0 +1,163 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.indexed.IndexEntryAccessor

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

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

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

Uses of Class
com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html new file mode 100644 index 0000000..c9b990f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.indexed.StoredIndexInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.indexed.StoredIndexInfo

+
+
No usage of com.amazon.carbonado.repo.indexed.StoredIndexInfo
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html new file mode 100644 index 0000000..cb241b5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html @@ -0,0 +1,189 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.indexed.Unindexed (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.indexed.Unindexed

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

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

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

com.amazon.carbonado.repo.indexed

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html b/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html new file mode 100644 index 0000000..07a36e4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html @@ -0,0 +1,187 @@ + + + + + + +com.amazon.carbonado.repo.indexed (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.repo.indexed

+
+
Repository implementation that adds index support for repositories that have + little or no index support.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.indexed Description

+
Repository implementation that adds index support for repositories that have + little or no index support. The wrapped repository must support creation of + new types.
+
See Also:
IndexedRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Hierarchy For Package com.amazon.carbonado.repo.indexed

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

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

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

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

Uses of Package
com.amazon.carbonado.repo.indexed

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html new file mode 100644 index 0000000..7a08397 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html @@ -0,0 +1,215 @@ + + + + + + +JDBCBlobLoader (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCBlobLoader

+
+
+
+
    +
  • +
    +
    +
    public interface JDBCBlobLoader
    +
    Callback for reloading Blobs outside original transaction.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/jdbc/JDBCClobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html new file mode 100644 index 0000000..d8b97a8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html @@ -0,0 +1,215 @@ + + + + + + +JDBCClobLoader (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCClobLoader

+
+
+
+
    +
  • +
    +
    +
    public interface JDBCClobLoader
    +
    Callback for reloading Clobs outside original transaction.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/jdbc/JDBCConnectionCapability.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html new file mode 100644 index 0000000..9198bd4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html @@ -0,0 +1,370 @@ + + + + + + +JDBCConnectionCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCConnectionCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    All Known Subinterfaces:
    +
    JDBCSupport<S>
    +
    +
    +
    +
    public interface JDBCConnectionCapability
+extends Capability
    +
    Capability to directly access the JDBC connection being used by the current + transaction, which is thread-local. If no transaction is in progress, then + the connection is in auto-commit mode. + +

    All connections retrieved from this capability must be properly + yielded. Do not close the connection directly, as this interferes with the + transaction's ability to properly manage it. + +

    It is perfectly okay for other Carbonado calls to be made while the + connection is in use. Also, it is okay to request more connections, + although they will usually be the same instance. Failing to yield a + connection has an undefined behavior. + + 

    + JDBCConnectionCapability cap = repo.getCapability(JDBCConnectionCapability.class);
+ Transaction txn = repo.enterTransaction();
+ try {
+     Connection con = cap.getConnection();
+     try {
+         ...
+     } finally {
+         cap.yieldConnection(con);
+     }
+     ...
+     txn.commit();
+ } finally {
+     txn.exit();
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.sql.ConnectiongetConnection() +
      Any connection returned by this method must be closed by calling + yieldConnection.
      +
      java.lang.StringgetDatabaseProductName() +
      Returns the name of the database product connected to.
      +
      booleanisTransactionForUpdate() +
      Returns true if a transaction is in progress and it is for update.
      +
      booleanisUniqueConstraintError(java.sql.SQLException e) +
      Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.
      +
      FetchExceptiontoFetchException(java.lang.Throwable e) +
      Transforms the given throwable into an appropriate fetch exception.
      +
      PersistExceptiontoPersistException(java.lang.Throwable e) +
      Transforms the given throwable into an appropriate persist exception.
      +
      voidyieldConnection(java.sql.Connection con) +
      Gives up a connection returned from getConnection.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getConnection

        +
        java.sql.Connection getConnection()
+                                  throws FetchException
        +
        Any connection returned by this method must be closed by calling + yieldConnection.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        yieldConnection

        +
        void yieldConnection(java.sql.Connection con)
+                     throws FetchException
        +
        Gives up a connection returned from getConnection. Connection must be + yielded in same thread that retrieved it.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toFetchException

        +
        FetchException toFetchException(java.lang.Throwable e)
        +
        Transforms the given throwable into an appropriate fetch exception. If + it already is a fetch exception, it is simply casted.
        +
        Parameters:
        e - required exception to transform
        +
        Returns:
        FetchException, never null
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        toPersistException

        +
        PersistException toPersistException(java.lang.Throwable e)
        +
        Transforms the given throwable into an appropriate persist exception. If + it already is a persist exception, it is simply casted.
        +
        Parameters:
        e - required exception to transform
        +
        Returns:
        PersistException, never null
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isUniqueConstraintError

        +
        boolean isUniqueConstraintError(java.sql.SQLException e)
        +
        Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isTransactionForUpdate

        +
        boolean isTransactionForUpdate()
        +
        Returns true if a transaction is in progress and it is for update.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getDatabaseProductName

        +
        java.lang.String getDatabaseProductName()
        +
        Returns the name of the database product connected to.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/jdbc/JDBCRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html new file mode 100644 index 0000000..9f33066 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html @@ -0,0 +1,947 @@ + + + + + + +JDBCRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Class JDBCRepositoryBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    RepositoryBuilder
    +
    +
    +
    +
    public class JDBCRepositoryBuilder
+extends AbstractRepositoryBuilder
    +
    Builds a repository instance backed by a JDBC accessible database. + JDBCRepository is not independent of the underlying database schema, and so + it requires matching tables and columns in the database. It will not alter + or create tables. Use the Alias + annotation to control precisely which tables and columns must be matched up. + +

    Note: The current JDBC repository implementation makes certain + assumptions about the database it is accessing. It must support transactions + and multiple statements per connection. If it doesn't support savepoints, + then nested transactions are faked -- rollback of inner transaction will + appear to do nothing. + +

    + The following extra capabilities are supported: +

    +
    Author:
    +
    Brian S O'Neill, bcastill, Adam D Bradley
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      voiderrorCheck(java.util.Collection<java.lang.String> messages) +
      This method is called by assertReady, and subclasses must override to + perform custom checks.
      +
      java.lang.StringgetCatalog() +
      Returns the optional catalog to search for metadata.
      +
      javax.sql.DataSourcegetDataSource() +
      Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.
      +
      booleangetDataSourceCloseOnShutdown() +
      Returns true if DataSource is closed when the repository is closed or + shutdown.
      +
      booleangetDataSourceLogging() +
      Returns true if debug logging is enabled.
      +
      java.lang.IntegergetDefaultFetchSize() +
      Returns the default fetch size when running queries, or null if driver + default is used instead.
      +
      java.lang.StringgetDriverClassName() +
      Returns the driver class name, which may be null if a DataSource was provided.
      +
      java.lang.StringgetDriverURL() +
      Returns the connection URL, which may be null if a DataSource was + provided.
      +
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      java.lang.StringgetPassword() +
      Returns the optional password to use with DataSource.
      +
      java.lang.StringgetSchema() +
      Returns the optional schema to search for metadata.
      +
      java.lang.StringgetSequenceSelectStatement() +
      Returns the native sequence select statement, which is null if the + default is chosen.
      +
      java.lang.StringgetUserName() +
      Returns the optional username to use with DataSource.
      +
      booleanisForceStoredSequence() +
      Returns true if native sequences should not be used.
      +
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      voidsetAutoVersioningEnabled(boolean enabled, + java.lang.String className) +
      By default, JDBCRepository assumes that version numbers are initialized and + incremented by triggers installed on the database.
      +
      voidsetCatalog(java.lang.String catalog) +
      Optionally set the catalog to search for metadata.
      +
      voidsetDataSource(javax.sql.DataSource dataSource) +
      Set the source of JDBC connections, overriding any configuration + supported by these methods: + + + setDriverClassName(java.lang.String) + setDriverURL(java.lang.String) + setUserName(java.lang.String) + setPassword(java.lang.String) +
      +
      voidsetDataSourceCloseOnShutdown(boolean b) +
      Pass true to cause the DataSource to be closed when the repository is + closed or shutdown.
      +
      voidsetDataSourceLogging(boolean b) +
      Pass true to enable debug logging.
      +
      voidsetDefaultFetchSize(java.lang.Integer size) +
      Set the default fetch size when running queries.
      +
      voidsetDriverClassName(java.lang.String driverClassName) +
      Set the JDBC driver class name, which is required if a DataSource was not provided.
      +
      voidsetDriverURL(java.lang.String url) +
      Set the JDBC connection URL, which is required if a DataSource was not + provided.
      +
      voidsetForceStoredSequence(boolean forceStoredSequence) +
      By default, native sequences are used if supported.
      +
      voidsetMaster(boolean b) +
      Set to false if repository should not assume the role of master.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      voidsetPassword(java.lang.String password) +
      Optionally set the password to use with DataSource.
      +
      voidsetPrimaryKeyCheckDisabled(boolean primaryKeyCheckDisabled) +
      By default, JDBCRepository makes sure that every declared primary key + in the database table for a Storable lines up with a declared + PrimaryKey or AlternateKey.
      +
      voidsetSchema(java.lang.String schema) +
      Optionally set the schema to search for metadata.
      +
      voidsetSequenceSelectStatement(java.lang.String sequenceSelectStatement) +
      Override the default native sequence select statement with a printf.
      +
      voidsetSuppressReload(boolean suppress, + java.lang.String className) +
      By default, JDBCRepository reloads Storables after every insert or + update.
      +
      voidsetUserName(java.lang.String username) +
      Optionally set the username to use with DataSource.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        JDBCRepositoryBuilder

        +
        public JDBCRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + + + + + +
        +
      • +

        getDataSource

        +
        public javax.sql.DataSource getDataSource()
+                                   throws ConfigurationException
        +
        Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.
        +
        Throws:
        +
        ConfigurationException - if driver class wasn't found
        +
        • +
      + + + +
        +
      • +

        setDataSourceCloseOnShutdown

        +
        public void setDataSourceCloseOnShutdown(boolean b)
        +
        Pass true to cause the DataSource to be closed when the repository is + closed or shutdown. By default, this option is false.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getDataSourceCloseOnShutdown

        +
        public boolean getDataSourceCloseOnShutdown()
        +
        Returns true if DataSource is closed when the repository is closed or + shutdown. By default, this option is false.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setDataSourceLogging

        +
        public void setDataSourceLogging(boolean b)
        +
        Pass true to enable debug logging. By default, it is false.
        +
        See Also:
        LoggingDataSource
        +
        • +
      + + + +
        +
      • +

        getDataSourceLogging

        +
        public boolean getDataSourceLogging()
        +
        Returns true if debug logging is enabled.
        +
        See Also:
        LoggingDataSource
        +
        • +
      + + + +
        +
      • +

        setCatalog

        +
        public void setCatalog(java.lang.String catalog)
        +
        Optionally set the catalog to search for metadata.
        +
        • +
      + + + +
        +
      • +

        getCatalog

        +
        public java.lang.String getCatalog()
        +
        Returns the optional catalog to search for metadata.
        +
        • +
      + + + +
        +
      • +

        setSchema

        +
        public void setSchema(java.lang.String schema)
        +
        Optionally set the schema to search for metadata.
        +
        • +
      + + + +
        +
      • +

        getSchema

        +
        public java.lang.String getSchema()
        +
        Returns the optional schema to search for metadata.
        +
        • +
      + + + +
        +
      • +

        setDriverClassName

        +
        public void setDriverClassName(java.lang.String driverClassName)
        +
        Set the JDBC driver class name, which is required if a DataSource was not provided.
        +
        • +
      + + + +
        +
      • +

        getDriverClassName

        +
        public java.lang.String getDriverClassName()
        +
        Returns the driver class name, which may be null if a DataSource was provided.
        +
        • +
      + + + +
        +
      • +

        setDriverURL

        +
        public void setDriverURL(java.lang.String url)
        +
        Set the JDBC connection URL, which is required if a DataSource was not + provided.
        +
        • +
      + + + +
        +
      • +

        getDriverURL

        +
        public java.lang.String getDriverURL()
        +
        Returns the connection URL, which may be null if a DataSource was + provided.
        +
        • +
      + + + +
        +
      • +

        setUserName

        +
        public void setUserName(java.lang.String username)
        +
        Optionally set the username to use with DataSource.
        +
        • +
      + + + +
        +
      • +

        getUserName

        +
        public java.lang.String getUserName()
        +
        Returns the optional username to use with DataSource.
        +
        • +
      + + + +
        +
      • +

        setPassword

        +
        public void setPassword(java.lang.String password)
        +
        Optionally set the password to use with DataSource.
        +
        • +
      + + + +
        +
      • +

        getPassword

        +
        public java.lang.String getPassword()
        +
        Returns the optional password to use with DataSource.
        +
        • +
      + + + +
        +
      • +

        setDefaultFetchSize

        +
        public void setDefaultFetchSize(java.lang.Integer size)
        +
        Set the default fetch size when running queries. Pass null to let driver + use its own default.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getDefaultFetchSize

        +
        public java.lang.Integer getDefaultFetchSize()
        +
        Returns the default fetch size when running queries, or null if driver + default is used instead.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setAutoVersioningEnabled

        +
        public void setAutoVersioningEnabled(boolean enabled,
+                            java.lang.String className)
        +
        By default, JDBCRepository assumes that version numbers are initialized and + incremented by triggers installed on the database. Enabling automatic + versioning here causes the JDBCRepository to manage these operations + itself.
        +
        Parameters:
        enabled - true to enable, false to disable
        className - name of Storable type to enable automatic version + management on; pass null to enable all
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setSuppressReload

        +
        public void setSuppressReload(boolean suppress,
+                     java.lang.String className)
        +
        By default, JDBCRepository reloads Storables after every insert or + update. This ensures that any applied defaults or triggered changes are + available to the Storable. If the database has no such defaults or + triggers, suppressing reload can improve performance. + +

        Note: If Storable has a version property and auto versioning is not + enabled, or if the Storable has any automatic properties, the Storable + might still be reloaded.

        +
        Parameters:
        suppress - true to suppress, false to unsuppress
        className - name of Storable type to suppress reload for; pass null + to suppress all
        Since:
        +
        1.1.3
        +
        • +
      + + + +
        +
      • +

        getSequenceSelectStatement

        +
        public java.lang.String getSequenceSelectStatement()
        +
        Returns the native sequence select statement, which is null if the + default is chosen.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setSequenceSelectStatement

        +
        public void setSequenceSelectStatement(java.lang.String sequenceSelectStatement)
        +
        Override the default native sequence select statement with a printf. + For example, "SELECT %s.NEXTVAL FROM DUAL".
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isForceStoredSequence

        +
        public boolean isForceStoredSequence()
        +
        Returns true if native sequences should not be used.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setForceStoredSequence

        +
        public void setForceStoredSequence(boolean forceStoredSequence)
        +
        By default, native sequences are used if supported. Otherwise, a table + named "CARBONADO_SEQUENCE" or "CARBONADO_SEQUENCES" is used instead to + hold sequence values. When forced, the table is always used instead of + native sequences.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setPrimaryKeyCheckDisabled

        +
        public void setPrimaryKeyCheckDisabled(boolean primaryKeyCheckDisabled)
        +
        By default, JDBCRepository makes sure that every declared primary key + in the database table for a Storable lines up with a declared + PrimaryKey or AlternateKey. This is not always the desired behavior; + for example, you may have a table which uses a bigint for its actual + primary key but uses another column with a unique index as the + "primary" key from the application's point of view. Setting this + value to true allows this check to fail gracefully instead of + throwing a MismatchException.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html new file mode 100644 index 0000000..39ad99c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html @@ -0,0 +1,423 @@ + + + + + + +JDBCStorableInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCStorableInfo<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isSupported

        +
        boolean isSupported()
        +
        Returns false only if storable type is independent + and no matching table was found.
        +
        • +
      + + + +
        +
      • +

        getCatalogName

        +
        java.lang.String getCatalogName()
        +
        Returns the optional catalog name for the Storable. Some databases use a + catalog name to fully qualify the table name.
        +
        • +
      + + + +
        +
      • +

        getSchemaName

        +
        java.lang.String getSchemaName()
        +
        Returns the optional schema name for the Storable. Some databases use a + schema name to fully qualify the table name.
        +
        • +
      + + + +
        +
      • +

        getTableName

        +
        java.lang.String getTableName()
        +
        Returns the table name for the Storable or null if unsupported.
        +
        • +
      + + + +
        +
      • +

        getQualifiedTableName

        +
        java.lang.String getQualifiedTableName()
        +
        Returns the qualified table name for the Storable or null if + unsupported. Is used by SQL statements.
        +
        • +
      + + + +
        +
      • +

        getIndexInfo

        +
        IndexInfo[] getIndexInfo()
        +
        • +
      + + + +
        +
      • +

        getAllProperties

        +
        java.util.Map<java.lang.String,JDBCStorableProperty<S>> getAllProperties()
        +
        Description copied from interface: StorableInfo
        +
        Returns all the storable properties in an unmodifiable map. Properties + are always ordered, case-sensitive, by name. Primary key properties are + grouped first.
        +
        +
        Specified by:
        +
        getAllProperties in interface StorableInfo<S extends Storable>
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyProperties

        +
        java.util.Map<java.lang.String,JDBCStorableProperty<S>> getPrimaryKeyProperties()
        +
        Description copied from interface: StorableInfo
        +
        Returns a subset of the storable properties in an unmodifiable map + that define the primary key. Properties are always ordered, + case-sensitive, by name.
        +
        +
        Specified by:
        +
        getPrimaryKeyProperties in interface StorableInfo<S extends Storable>
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getDataProperties

        +
        java.util.Map<java.lang.String,JDBCStorableProperty<S>> getDataProperties()
        +
        Description copied from interface: StorableInfo
        +
        Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. Primary keys and joins are + excluded. Properties are always ordered, case-sensitive, by name.
        +
        +
        Specified by:
        +
        getDataProperties in interface StorableInfo<S extends Storable>
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getIdentityProperties

        +
        java.util.Map<java.lang.String,JDBCStorableProperty<S>> getIdentityProperties()
        +
        Returns auto-increment properties which are primary key members. The map + should almost always be empty or contain one property.
        +
        Since:
        +
        1.2
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/jdbc/JDBCStorableIntrospector.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html new file mode 100644 index 0000000..6a25a05 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html @@ -0,0 +1,297 @@ + + + + + + +JDBCStorableIntrospector (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Class JDBCStorableIntrospector

+
+
+ +
+
    +
  • +
    +
    +
    public class JDBCStorableIntrospector
+extends StorableIntrospector
    +
    Provides additional metadata for a Storable type needed by + JDBCRepository. The storable type must match to a table in an external + database. All examined data is cached, so repeat examinations are fast, + unless the examination failed.
    +
    Author:
    +
    Brian S O'Neill, Adam D Bradley, Tobias Holgers, Archit Shivaprakash, Matt Carlson
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      JDBCStorableInfo<S>      		examine(java.lang.Class<S> type, + javax.sql.DataSource ds, + java.lang.String catalog, + java.lang.String schema) +
      Examines the given class and returns a JDBCStorableInfo describing it.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        JDBCStorableIntrospector

        +
        public JDBCStorableIntrospector()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        examine

        +
        public static <S extends Storable> JDBCStorableInfo<S> examine(java.lang.Class<S> type,
+                                               javax.sql.DataSource ds,
+                                               java.lang.String catalog,
+                                               java.lang.String schema)
+                                                    throws java.sql.SQLException,
+                                                           SupportException
        +
        Examines the given class and returns a JDBCStorableInfo describing it. A + MalformedTypeException is thrown for a variety of reasons if the given + class is not a well-defined Storable type or if it can't match up with + an entity in the external database.
        +
        Parameters:
        type - Storable type to examine
        ds - source of JDBC connections to use for matching to a table
        catalog - optional catalog to search
        schema - optional schema to search
        +
        Throws:
        +
        MalformedTypeException - if Storable type is not well-formed
        +
        RepositoryException - if there was a problem in accessing the database
        +
        java.lang.IllegalArgumentException - if type is null
        +
        java.sql.SQLException
        +
        SupportException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html new file mode 100644 index 0000000..d8b240a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html @@ -0,0 +1,554 @@ + + + + + + +JDBCStorableProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCStorableProperty<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isSupported

        +
        boolean isSupported()
        +
        Returns false only if property is independent and no matching column was + found.
        +
        • +
      + + + +
        +
      • +

        isSelectable

        +
        boolean isSelectable()
        +
        Returns true if property is both supported and not a join. Simply put, + it can appear in a select statement.
        +
        • +
      + + + +
        +
      • +

        isAutoIncrement

        +
        boolean isAutoIncrement()
        +
        Returns true if property is declared as @Automatic and column is + designated as auto-increment.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getColumnName

        +
        java.lang.String getColumnName()
        +
        Returns the table column for this property.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getDataType

        +
        java.lang.Integer getDataType()
        +
        Returns the data type as defined by Types.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getDataTypeName

        +
        java.lang.String getDataTypeName()
        +
        Returns the data type name.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        isColumnNullable

        +
        boolean isColumnNullable()
        +
        Returns:
        true if column is nullable
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getResultSetGetMethod

        +
        java.lang.reflect.Method getResultSetGetMethod()
        +
        Returns the method to use to access this property (by index) from a + ResultSet.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getPreparedStatementSetMethod

        +
        java.lang.reflect.Method getPreparedStatementSetMethod()
        +
        Returns the method to use to set this property (by index) into a + PreparedStatement.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getAppliedAdapter

        +
        StorablePropertyAdapter getAppliedAdapter()
        +
        Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements. Is null if not needed.
        +
        Returns:
        null if property is unsupported or if adapter not needed.
        +
        • +
      + + + +
        +
      • +

        getColumnSize

        +
        java.lang.Integer getColumnSize()
        +
        The column size is either the maximum number of characters or the + numeric precision.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getDecimalDigits

        +
        java.lang.Integer getDecimalDigits()
        +
        Returns the amount of fractional decimal digits.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getCharOctetLength

        +
        java.lang.Integer getCharOctetLength()
        +
        Returns the maximum amount of bytes for property value.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getOrdinalPosition

        +
        java.lang.Integer getOrdinalPosition()
        +
        Returns the one-based index of the column in the table.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + + + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/jdbc/JDBCSupport.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCSupport.html new file mode 100644 index 0000000..d8acf12 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCSupport.html @@ -0,0 +1,348 @@ + + + + + + +JDBCSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCSupport<S extends Storable>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/jdbc/LoggingDataSource.html b/apidocs/com/amazon/carbonado/repo/jdbc/LoggingDataSource.html new file mode 100644 index 0000000..d9f8e69 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/LoggingDataSource.html @@ -0,0 +1,447 @@ + + + + + + +LoggingDataSource (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Class LoggingDataSource

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource
    +
    +
    +
    +
    public class LoggingDataSource
+extends java.lang.Object
+implements javax.sql.DataSource
    +
    Wraps another DataSource such that all SQL statements are logged as debug.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      static javax.sql.DataSourcecreate(javax.sql.DataSource ds) +
      Wraps the given DataSource which logs to the default log.
      +
      static javax.sql.DataSourcecreate(javax.sql.DataSource ds, + org.apache.commons.logging.Log log) +
      Wraps the given DataSource which logs to the given log.
      +
      java.sql.ConnectiongetConnection() 
      java.sql.ConnectiongetConnection(java.lang.String username, + java.lang.String password) 
      intgetLoginTimeout() 
      java.io.PrintWritergetLogWriter() 
      java.util.logging.LoggergetParentLogger() 
      booleanisWrapperFor(java.lang.Class<?> iface) 
      voidsetLoginTimeout(int seconds) 
      voidsetLogWriter(java.io.PrintWriter writer) 
      <T> Tunwrap(java.lang.Class<T> iface) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        create

        +
        public static javax.sql.DataSource create(javax.sql.DataSource ds)
        +
        Wraps the given DataSource which logs to the default log. If debug + logging is disabled, the original DataSource is returned.
        +
        • +
      + + + +
        +
      • +

        create

        +
        public static javax.sql.DataSource create(javax.sql.DataSource ds,
+                          org.apache.commons.logging.Log log)
        +
        Wraps the given DataSource which logs to the given log. If debug logging + is disabled, the original DataSource is returned.
        +
        • +
      + + + +
        +
      • +

        getConnection

        +
        public java.sql.Connection getConnection()
+                                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getConnection in interface javax.sql.DataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getConnection

        +
        public java.sql.Connection getConnection(java.lang.String username,
+                                java.lang.String password)
+                                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getConnection in interface javax.sql.DataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getLogWriter

        +
        public java.io.PrintWriter getLogWriter()
+                                 throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getLogWriter in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        setLogWriter

        +
        public void setLogWriter(java.io.PrintWriter writer)
+                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        setLogWriter in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        setLoginTimeout

        +
        public void setLoginTimeout(int seconds)
+                     throws java.sql.SQLException
        +
        +
        Specified by:
        +
        setLoginTimeout in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getLoginTimeout

        +
        public int getLoginTimeout()
+                    throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getLoginTimeout in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.sql.SQLException
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        unwrap

        +
        public <T> T unwrap(java.lang.Class<T> iface)
+         throws java.sql.SQLException
        +
        +
        Specified by:
        +
        unwrap in interface java.sql.Wrapper
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isWrapperFor

        +
        public boolean isWrapperFor(java.lang.Class<?> iface)
+                     throws java.sql.SQLException
        +
        +
        Specified by:
        +
        isWrapperFor in interface java.sql.Wrapper
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getParentLogger

        +
        public java.util.logging.Logger getParentLogger()
+                                         throws java.sql.SQLFeatureNotSupportedException
        +
        +
        Specified by:
        +
        getParentLogger in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLFeatureNotSupportedException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/jdbc/SimpleDataSource.html b/apidocs/com/amazon/carbonado/repo/jdbc/SimpleDataSource.html new file mode 100644 index 0000000..44d9458 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/SimpleDataSource.html @@ -0,0 +1,501 @@ + + + + + + +SimpleDataSource (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Class SimpleDataSource

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource
    +
    +
    +
    +
    public class SimpleDataSource
+extends java.lang.Object
+implements javax.sql.DataSource
    +
    SimpleDataSource does not implement any connection pooling.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      SimpleDataSource(java.lang.String driverClass, + java.lang.String driverURL, + java.util.Properties properties) 
      SimpleDataSource(java.lang.String driverClass, + java.lang.String driverURL, + java.lang.String username, + java.lang.String password) 
      SimpleDataSource(java.lang.String driverClass, + java.lang.String driverURL, + java.lang.String username, + java.lang.String password, + java.util.Properties properties) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      java.sql.ConnectiongetConnection() 
      java.sql.ConnectiongetConnection(java.lang.String username, + java.lang.String password) 
      intgetLoginTimeout() 
      java.io.PrintWritergetLogWriter() 
      java.util.logging.LoggergetParentLogger() 
      booleanisWrapperFor(java.lang.Class<?> iface) 
      voidsetLoginTimeout(int seconds) 
      voidsetLogWriter(java.io.PrintWriter writer) 
      <T> Tunwrap(java.lang.Class<T> iface) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SimpleDataSource

        +
        public SimpleDataSource(java.lang.String driverClass,
+                java.lang.String driverURL,
+                java.util.Properties properties)
+                 throws java.sql.SQLException
        +
        Parameters:
        driverClass - JDBC driver to load; can pass null if already loaded
        driverURL - JDBC driver URL
        properties - optional connection properties
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        SimpleDataSource

        +
        public SimpleDataSource(java.lang.String driverClass,
+                java.lang.String driverURL,
+                java.lang.String username,
+                java.lang.String password)
+                 throws java.sql.SQLException
        +
        Parameters:
        driverClass - JDBC driver to load; can pass null if already loaded
        driverURL - JDBC driver URL
        username - optional username to connect with
        password - optional password to connect with
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        SimpleDataSource

        +
        public SimpleDataSource(java.lang.String driverClass,
+                java.lang.String driverURL,
+                java.lang.String username,
+                java.lang.String password,
+                java.util.Properties properties)
+                 throws java.sql.SQLException
        +
        Parameters:
        driverClass - JDBC driver to load; can pass null if already loaded
        driverURL - JDBC driver URL
        username - optional username to connect with
        password - optional password to connect with
        properties - optional connection properties
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getConnection

        +
        public java.sql.Connection getConnection()
+                                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getConnection in interface javax.sql.DataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getConnection

        +
        public java.sql.Connection getConnection(java.lang.String username,
+                                java.lang.String password)
+                                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getConnection in interface javax.sql.DataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getLogWriter

        +
        public java.io.PrintWriter getLogWriter()
+                                 throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getLogWriter in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        setLogWriter

        +
        public void setLogWriter(java.io.PrintWriter writer)
+                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        setLogWriter in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        setLoginTimeout

        +
        public void setLoginTimeout(int seconds)
+                     throws java.sql.SQLException
        +
        +
        Specified by:
        +
        setLoginTimeout in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getLoginTimeout

        +
        public int getLoginTimeout()
+                    throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getLoginTimeout in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.sql.SQLException
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        unwrap

        +
        public <T> T unwrap(java.lang.Class<T> iface)
+         throws java.sql.SQLException
        +
        +
        Specified by:
        +
        unwrap in interface java.sql.Wrapper
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isWrapperFor

        +
        public boolean isWrapperFor(java.lang.Class<?> iface)
+                     throws java.sql.SQLException
        +
        +
        Specified by:
        +
        isWrapperFor in interface java.sql.Wrapper
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getParentLogger

        +
        public java.util.logging.Logger getParentLogger()
+                                         throws java.sql.SQLFeatureNotSupportedException
        +
        +
        Specified by:
        +
        getParentLogger in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLFeatureNotSupportedException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html new file mode 100644 index 0000000..66eb446 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCBlobLoader (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCBlobLoader

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html new file mode 100644 index 0000000..dfbc020 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCClobLoader (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCClobLoader

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html new file mode 100644 index 0000000..05be10c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html @@ -0,0 +1,177 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability

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

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

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

Uses of Class
com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html new file mode 100644 index 0000000..aa5420a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html @@ -0,0 +1,165 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCStorableInfo

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

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

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

Uses of Class
com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector

+
+
No usage of com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html new file mode 100644 index 0000000..a5f144e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html @@ -0,0 +1,203 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCStorableProperty

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html new file mode 100644 index 0000000..c814a5c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCSupport

+
+
No usage of com.amazon.carbonado.repo.jdbc.JDBCSupport
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.repo.jdbc.LoggingDataSource

+
+
No usage of com.amazon.carbonado.repo.jdbc.LoggingDataSource
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.repo.jdbc.SimpleDataSource

+
+
No usage of com.amazon.carbonado.repo.jdbc.SimpleDataSource
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

com.amazon.carbonado.repo.jdbc

+
+

Interfaces

+ +

Classes

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

Package com.amazon.carbonado.repo.jdbc

+
+
Repository implementation that connects to an external SQL database via + JDBC.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.jdbc Description

+
Repository implementation that connects to an external SQL database via + JDBC. JDBC repository is not independent of the underlying database schema, + and so it requires matching tables and columns in the database. It will not + alter or create tables. Use the Alias + annotation to control precisely which tables and columns must be matched up.
+
See Also:
JDBCRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html b/apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html new file mode 100644 index 0000000..7348f68 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html @@ -0,0 +1,191 @@ + + + + + + +com.amazon.carbonado.repo.jdbc Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.repo.jdbc

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

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

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

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

Uses of Package
com.amazon.carbonado.repo.jdbc

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html b/apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html new file mode 100644 index 0000000..fc37f49 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html @@ -0,0 +1,299 @@ + + + + + + +CommonsLog (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.logging
+

Class CommonsLog

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Log
    +
    +
    +
    +
    public class CommonsLog
+extends java.lang.Object
+implements Log
    +
    Log implementation that uses Jakarta Commons Logging at debug level.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      CommonsLog(java.lang.Class clazz) 
      CommonsLog(org.apache.commons.logging.Log log) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanisEnabled() 
      voidwrite(java.lang.String message) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        CommonsLog

        +
        public CommonsLog(org.apache.commons.logging.Log log)
        +
        • +
      + + + +
        +
      • +

        CommonsLog

        +
        public CommonsLog(java.lang.Class clazz)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEnabled

        +
        public boolean isEnabled()
        +
        +
        Specified by:
        +
        isEnabled in interface Log
        +
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(java.lang.String message)
        +
        +
        Specified by:
        +
        write in interface Log
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/Log.html b/apidocs/com/amazon/carbonado/repo/logging/Log.html new file mode 100644 index 0000000..7fd808e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/Log.html @@ -0,0 +1,228 @@ + + + + + + +Log (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.logging
+

Interface Log

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    CommonsLog
    +
    +
    +
    +
    public interface Log
    +
    Very simple Log interface.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanisEnabled() 
      voidwrite(java.lang.String message) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEnabled

        +
        boolean isEnabled()
        +
        • +
      + + + +
        +
      • +

        write

        +
        void write(java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/logging/LogAccessCapability.html b/apidocs/com/amazon/carbonado/repo/logging/LogAccessCapability.html new file mode 100644 index 0000000..ce9c79c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/LogAccessCapability.html @@ -0,0 +1,216 @@ + + + + + + +LogAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.logging
+

Interface LogAccessCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface LogAccessCapability
+extends Capability
    +
    Provides access to the Log.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      LoggetLog() 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLog

        +
        Log getLog()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/logging/LoggingRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html new file mode 100644 index 0000000..5532586 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html @@ -0,0 +1,484 @@ + + + + + + +LoggingRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.logging
+

Class LoggingRepositoryBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    RepositoryBuilder
    +
    +
    +
    +
    public class LoggingRepositoryBuilder
+extends AbstractRepositoryBuilder
    +
    Repository implementation which logs activity against it. By default, all + logged messages are at the debug level. + +

    + The following extra capabilities are supported: +

    + + Example: + + 
    + LoggingRepositoryBuilder loggingBuilder = new LoggingRepositoryBuilder();
+ loggingBuilder.setActualRepositoryBuilder(...);
+ Repository repo = loggingBuilder.build();
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      voiderrorCheck(java.util.Collection<java.lang.String> messages) +
      This method is called by assertReady, and subclasses must override to + perform custom checks.
      +
      RepositoryBuildergetActualRepositoryBuilder() +
      Returns the Repository that all calls are wrapped to.
      +
      LoggetLog() +
      Return the Log to use.
      +
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      voidsetActualRepositoryBuilder(RepositoryBuilder builder) +
      Set the Repository to wrap all calls to.
      +
      voidsetLog(Log log) +
      Set the Log to use.
      +
      voidsetMaster(boolean master) +
      Set to false if repository should not assume the role of master.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        LoggingRepositoryBuilder

        +
        public LoggingRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean master)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setLog

        +
        public void setLog(Log log)
        +
        Set the Log to use. If null, use default. Log must be enabled when build + is called, or else no logging is ever performed.
        +
        • +
      + + + +
        +
      • +

        getLog

        +
        public Log getLog()
        +
        Return the Log to use. If null, use default.
        +
        • +
      + + + +
        +
      • +

        setActualRepositoryBuilder

        +
        public void setActualRepositoryBuilder(RepositoryBuilder builder)
        +
        Set the Repository to wrap all calls to.
        +
        • +
      + + + +
        +
      • +

        getActualRepositoryBuilder

        +
        public RepositoryBuilder getActualRepositoryBuilder()
        +
        Returns the Repository that all calls are wrapped to.
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.repo.logging.CommonsLog

+
+
No usage of com.amazon.carbonado.repo.logging.CommonsLog
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html b/apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html new file mode 100644 index 0000000..a895db1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html @@ -0,0 +1,195 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.logging.Log (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.logging.Log

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html b/apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html new file mode 100644 index 0000000..febcf9a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.logging.LogAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.logging.LogAccessCapability

+
+
No usage of com.amazon.carbonado.repo.logging.LogAccessCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

com.amazon.carbonado.repo.logging

+
+

Interfaces

+ +

Classes

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

Package com.amazon.carbonado.repo.logging

+
+
Repository implementation which logs activity against it.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.logging Description

+
Repository implementation which logs activity against it. By default, all + logged messages are at the debug level.
+
See Also:
LoggingRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Hierarchy For Package com.amazon.carbonado.repo.logging

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

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

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

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

Uses of Package
com.amazon.carbonado.repo.logging

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html new file mode 100644 index 0000000..8191fcb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html @@ -0,0 +1,481 @@ + + + + + + +MapRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.map
+

Class MapRepositoryBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    RepositoryBuilder
    +
    +
    +
    +
    public class MapRepositoryBuilder
+extends AbstractRepositoryBuilder
    +
    Volatile repository implementation backed by a concurrent map. Locks used by + repository are coarse, much like table locks. Loads and queries + acquire read locks, and modifications acquire write locks. Within + transactions, loads and queries always acquire upgradable locks, to reduce + the likelihood of deadlock. + +

    This repository supports transactions, which also may be + nested. Supported isolation levels are read committed and serializable. Read + uncommitted is promoted to read committed, and repeatable read is promoted + to serializable. + +

    + The following extra capabilities are supported: +

    + +

    Note: This repository uses concurrent navigable map classes, which became + available in JDK1.6.

    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      intgetLockTimeout() +
      Returns the lock timeout.
      +
      java.util.concurrent.TimeUnitgetLockTimeoutUnit() +
      Returns the lock timeout unit.
      +
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      static RepositorynewRepository() +
      Convenience method to build a new MapRepository.
      +
      voidsetLockTimeout(int timeout, + java.util.concurrent.TimeUnit unit) +
      Set the lock timeout.
      +
      voidsetLockTimeoutMillis(int timeout) +
      Set the lock timeout, in milliseconds.
      +
      voidsetMaster(boolean b) +
      Set to false if repository should not assume the role of master.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MapRepositoryBuilder

        +
        public MapRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        newRepository

        +
        public static Repository newRepository()
        +
        Convenience method to build a new MapRepository.
        +
        • +
      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setLockTimeoutMillis

        +
        public void setLockTimeoutMillis(int timeout)
        +
        Set the lock timeout, in milliseconds. Default value is 500 milliseconds.
        +
        • +
      + + + +
        +
      • +

        setLockTimeout

        +
        public void setLockTimeout(int timeout,
+                  java.util.concurrent.TimeUnit unit)
        +
        Set the lock timeout. Default value is 500 milliseconds.
        +
        • +
      + + + +
        +
      • +

        getLockTimeout

        +
        public int getLockTimeout()
        +
        Returns the lock timeout. Call getLockTimeoutUnit to get the unit.
        +
        • +
      + + + +
        +
      • +

        getLockTimeoutUnit

        +
        public java.util.concurrent.TimeUnit getLockTimeoutUnit()
        +
        Returns the lock timeout unit. Call getLockTimeout to get the timeout.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.repo.map.MapRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.map.MapRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

com.amazon.carbonado.repo.map

+
+

Classes

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

Package com.amazon.carbonado.repo.map

+
+
Volatile repository implementation backed by a concurrent map.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.map Description

+
Volatile repository implementation backed by a concurrent map.
+
See Also:
MapRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/package-tree.html b/apidocs/com/amazon/carbonado/repo/map/package-tree.html new file mode 100644 index 0000000..994619c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-tree.html @@ -0,0 +1,134 @@ + + + + + + +com.amazon.carbonado.repo.map Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.repo.map

+Package Hierarchies: + +
+
+

Class Hierarchy

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

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

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

Uses of Package
com.amazon.carbonado.repo.map

+
+
No usage of com.amazon.carbonado.repo.map
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html new file mode 100644 index 0000000..15c406c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html @@ -0,0 +1,473 @@ + + + + + + +ReplicatedRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.replicated
+

Class ReplicatedRepositoryBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    RepositoryBuilder
    +
    +
    +
    +
    public class ReplicatedRepositoryBuilder
+extends AbstractRepositoryBuilder
    +
    Repository builder for the replicated repository. +

    + The following extra capabilities are supported: +

    +
    Author:
    +
    Don Schneider, Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReplicatedRepositoryBuilder

        +
        public ReplicatedRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        getReplicaRepositoryBuilder

        +
        public RepositoryBuilder getReplicaRepositoryBuilder()
        +
        Returns:
        "replica" respository to replicate to.
        +
        • +
      + + + +
        +
      • +

        setReplicaRepositoryBuilder

        +
        public void setReplicaRepositoryBuilder(RepositoryBuilder replicaRepositoryBuilder)
        +
        Set "replica" respository to replicate to, which is required. This builder + automatically sets the master option of the given repository builder to + false.
        +
        • +
      + + + +
        +
      • +

        getMasterRepositoryBuilder

        +
        public RepositoryBuilder getMasterRepositoryBuilder()
        +
        Returns:
        "master" respository to replicate from.
        +
        • +
      + + + +
        +
      • +

        setMasterRepositoryBuilder

        +
        public void setMasterRepositoryBuilder(RepositoryBuilder masterRepositoryBuilder)
        +
        Set "master" respository to replicate from, which is required. This + builder automatically sets the master option of the given repository to + true.
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

com.amazon.carbonado.repo.replicated

+
+

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/repo/replicated/package-summary.html b/apidocs/com/amazon/carbonado/repo/replicated/package-summary.html new file mode 100644 index 0000000..3516d8b --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/package-summary.html @@ -0,0 +1,151 @@ + + + + + + +com.amazon.carbonado.repo.replicated (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.repo.replicated

+
+
Repository implementation that supports replication between two + repositories.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.replicated Description

+
Repository implementation that supports replication between two + repositories. One repository is the replica, and the other is the + master. Read operations are served by the replica, and the master is + consulted when writing. Changes to the master are copied to the replica.
+
See Also:
ReplicatedRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Hierarchy For Package com.amazon.carbonado.repo.replicated

+Package Hierarchies: + +
+
+

Class Hierarchy

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

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

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

Uses of Package
com.amazon.carbonado.repo.replicated

+
+
No usage of com.amazon.carbonado.repo.replicated
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html new file mode 100644 index 0000000..bd9736e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html @@ -0,0 +1,217 @@ + + + + + + +BDBPanicHandler (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface BDBPanicHandler

+
+
+
+
    +
  • +
    +
    +
    public interface BDBPanicHandler
    +
    Interface for a generic panic handler for any BDB products.
    +
    Author:
    +
    Jesse Morgan
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidonPanic(java.lang.Object environment, + java.lang.Exception exception) +
      Called when an Environment panics or an EnvironmentFailureException is thrown.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onPanic

        +
        void onPanic(java.lang.Object environment,
+           java.lang.Exception exception)
        +
        Called when an Environment panics or an EnvironmentFailureException is thrown.
        +
        Parameters:
        environment - The affected environment or null if the environment could not be opened.
        exception - The related exception.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/sleepycat/BDBProduct.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBProduct.html new file mode 100644 index 0000000..a452514 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBProduct.html @@ -0,0 +1,392 @@ + + + + + + +BDBProduct (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Enum BDBProduct

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<BDBProduct>
    +
    +
    +
    +
    public enum BDBProduct
+extends java.lang.Enum<BDBProduct>
    +
    Set of supported BDB products.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      DB +
      BDB Native
      +
      DB_HA +
      BDB Native, High Availability
      +
      DB_Legacy +
      BDB Native, legacy API
      +
      DBX +
      BDB Native, with reduced concurrency to eliminate deadlocks.
      +
      JE +
      BDB Java Edition
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static BDBProductforString(java.lang.String name) 
      static BDBProductvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static BDBProduct[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        DB_Legacy

        +
        public static final BDBProduct DB_Legacy
        +
        BDB Native, legacy API
        +
        • +
      + + + +
        +
      • +

        DB

        +
        public static final BDBProduct DB
        +
        BDB Native
        +
        • +
      + + + +
        +
      • +

        DBX

        +
        public static final BDBProduct DBX
        +
        BDB Native, with reduced concurrency to eliminate deadlocks. Exclusive + lock is held when modifications are made, and at most one open + transaction is allowed at any given time.
        +
        • +
      + + + +
        +
      • +

        DB_HA

        +
        public static final BDBProduct DB_HA
        +
        BDB Native, High Availability
        +
        • +
      + + + +
        +
      • +

        JE

        +
        public static final BDBProduct JE
        +
        BDB Java Edition
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static BDBProduct[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (BDBProduct c : BDBProduct.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static BDBProduct valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        forString

        +
        public static BDBProduct forString(java.lang.String name)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html new file mode 100644 index 0000000..90bc0eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html @@ -0,0 +1,237 @@ + + + + + + +BDBRepositoryBuilder.DatabaseHook (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface BDBRepositoryBuilder.DatabaseHook

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    BDBRepositoryBuilder
    +
    +
    +
    +
    public static interface BDBRepositoryBuilder.DatabaseHook
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringdatabaseName(java.lang.String typeName) +
      Returns an appropriate database name for the given type.
      +
      voidprepareForOpening(java.lang.Object db) +
      Called right before database is opened.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        databaseName

        +
        java.lang.String databaseName(java.lang.String typeName)
        +
        Returns an appropriate database name for the given type. Simply + return the type name as-is to support default behavior.
        +
        • +
      + + + +
        +
      • +

        prepareForOpening

        +
        void prepareForOpening(java.lang.Object db)
+                       throws RepositoryException
        +
        Called right before database is opened.
        +
        Parameters:
        db - reference to database or config - actual type depends on BDB + implementation.
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/sleepycat/BDBRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html new file mode 100644 index 0000000..425a599 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html @@ -0,0 +1,2121 @@ + + + + + + +BDBRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Class BDBRepositoryBuilder

+
+
+ +
+ +
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      voiderrorCheck(java.util.Collection<java.lang.String> messages) +
      This method is called by assertReady, and subclasses must override to + perform custom checks.
      +
      BDBProductgetBDBProduct() +
      Returns the BDB product to use, which is JE by default.
      +
      java.lang.IntegergetCachePercent() +
      Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.
      +
      java.lang.LonggetCacheSize() +
      Returns the repository cache size, or null if default should be + selected.
      +
      intgetCheckpointInterval() 
      intgetCheckpointThresholdKB() 
      intgetCheckpointThresholdMinutes() 
      java.lang.BooleangetChecksumEnabled() +
      Returns true if checksum verification is enabled.
      +
      java.lang.StringgetCompressor(java.lang.String type) +
      Return the compressor used for the given storable.
      +
      BDBRepositoryBuilder.DatabaseHookgetDatabaseHook() +
      Returns the custom open database hook, or null if none.
      +
      java.lang.BooleangetDatabasesTransactional() +
      Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set
      +
      java.lang.StringgetDataHome() +
      Returns the directory to store data files.
      +
      java.io.FilegetDataHomeFile() +
      Returns the optional directory to store data files.
      +
      java.lang.StringgetEnvironmentHome() +
      Returns the repository environment home directory.
      +
      java.io.FilegetEnvironmentHomeFile() +
      Returns the repository environment home directory.
      +
      doublegetIndexRepairThrottle() +
      Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.
      +
      booleangetIndexSupport() +
      Returns true if indexes are supported, which is true by default.
      +
      java.lang.ObjectgetInitialDatabaseConfig() +
      Returns the optional BDB specific database configuration to use + for all databases created.
      +
      java.lang.ObjectgetInitialEnvironmentConfig() +
      Returns the optional BDB specific environment configuration to use.
      +
      booleangetInitializeLogging() 
      booleangetKeepOldLogFiles() +
      Returns false by default.
      +
      booleangetLockConflictDeadlockDetectMode() +
      Returns true if deadlock detection is run whenever a lock conflict occurs.
      +
      doublegetLockTimeout() +
      Returns the lock timeout, in seconds.
      +
      longgetLockTimeoutInMicroseconds() +
      Returns the lock timeout, in microseconds, limited to max long value.
      +
      java.lang.IntegergetLogFileMaxSize() +
      Returns null if default size will be used.
      +
      booleangetLogInMemory() +
      Returns false by default, indicating that transaction logs are persisted.
      +
      java.lang.IntegergetLogRegionSize() +
      Returns the repository log region size, or null if the default + should be selected.
      +
      java.lang.IntegergetMaxLocks() 
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      BDBPanicHandlergetPanicHandler() +
      Return the panic handler to call if the database panics.
      +
      java.lang.RunnablegetPreShutdownHook() +
      Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.
      +
      java.lang.StringgetProduct() +
      Returns the BDB product to use, which is JE by default.
      +
      booleangetReadOnly() +
      Returns true if repository should be opened read-only.
      +
      booleangetRunCheckpointer() +
      Returns true if checkpointer is run automatically.
      +
      booleangetRunDeadlockDetector() +
      Returns true if deadlock detector is configured to run.
      +
      booleangetRunFullRecovery() +
      Returns true if a full (catastrophic) recovery should be performed when + environment is opened.
      +
      java.lang.RunnablegetShutdownHook() +
      Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.
      +
      java.lang.StringgetSingleFileName() +
      Returns the single file that all BDB databases should reside in.
      +
      StorableCodecFactorygetStorableCodecFactory() +
      Returns the storable codec factory used.
      +
      java.lang.IntegergetTransactionMaxActive() +
      Returns the maximum number of concurrent transactions, or null if the + default is used.
      +
      booleangetTransactionNoSync() +
      Returns true if transactions are not written or flushed to disk.
      +
      doublegetTransactionTimeout() +
      Returns the repository transaction timeout, in seconds.
      +
      longgetTransactionTimeoutInMicroseconds() +
      Returns the repository transaction timeout, in microseconds, limited to + max long value.
      +
      booleangetTransactionWriteNoSync() +
      Returns true if transactions are not flushed to disk.
      +
      booleanisIndexRepairEnabled() 
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      booleanisMultiversion() +
      Returns false by default because multiversion concurrency control (MVCC) + is not enabled.
      +
      booleanisPrivate() +
      Returns true if BDB environment is private.
      +
      booleanisReverseSplitOff() 
      voidsetBDBProduct(BDBProduct product) +
      Sets the BDB product to use, which defaults to JE.
      +
      voidsetCachePercent(int cachePercent) +
      Set the percent of JVM heap used by the repository cache.
      +
      voidsetCachePercent(java.lang.Integer cachePercent) +
      Set the percent of JVM heap used by the repository cache.
      +
      voidsetCacheSize(long cacheSize) +
      Set the repository cache size, in bytes.
      +
      voidsetCacheSize(java.lang.Long cacheSize) +
      Set the repository cache size, in bytes.
      +
      voidsetCheckpointInterval(int intervalMillis) +
      Set the interval to run checkpoints.
      +
      voidsetCheckpointThresholdKB(int thresholdKB) +
      Set the size threshold to run checkpoints.
      +
      voidsetCheckpointThresholdMinutes(int thresholdMinutes) +
      Set the time threshold to run checkpoints.
      +
      voidsetChecksumEnabled(java.lang.Boolean checksumEnabled) +
      When true, enable checksum verification of pages read into the cache + from the backing filestore.
      +
      voidsetCompressor(java.lang.String type, + java.lang.String compressionType) +
      Set the compressor for the given class, overriding a custom StorableCodecFactory.
      +
      voidsetDatabaseHook(BDBRepositoryBuilder.DatabaseHook hook) +
      Sets a hook to be called whenever a database is opened.
      +
      voidsetDatabasePageSize(java.lang.Integer bytes, + java.lang.Class<? extends Storable> type) +
      Sets the desired page size for a given type.
      +
      voidsetDatabasesTransactional(java.lang.Boolean transactional) +
      When true, allows databases to be transactional.
      +
      voidsetDataHome(java.lang.String dir) +
      By default, data files are stored relative to the environment home.
      +
      voidsetDataHomeFile(java.io.File dir) +
      By default, data files are stored relative to the environment home.
      +
      voidsetEnvironmentHome(java.lang.String envHome) +
      Sets the repository environment home directory, which is required.
      +
      voidsetEnvironmentHomeFile(java.io.File envHome) +
      Sets the repository environment home directory, which is required.
      +
      voidsetFileName(java.lang.String filename, + java.lang.String typeName) +
      Specify the file that a BDB database should reside in, except for log + files and caches.
      +
      voidsetIndexRepairEnabled(boolean enabled) +
      By default, index repair is enabled.
      +
      voidsetIndexRepairThrottle(double desiredSpeed) +
      Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.
      +
      voidsetIndexSupport(boolean indexSupport) +
      By default, user specified indexes are supported.
      +
      voidsetInitialDatabaseConfig(java.lang.Object dbConfig) +
      Optionally set the BDB specific database configuration to use + for all databases created.
      +
      voidsetInitialEnvironmentConfig(java.lang.Object envConfig) +
      Optionally set the BDB specific environment configuration to + use.
      +
      voidsetInitializeLogging(boolean b) +
      Ensure the transaction logging sub-system is initialized, which is + usually implied.
      +
      voidsetKeepOldLogFiles(boolean keep) +
      By default, transaction log files are deleted when no longer needed.
      +
      voidsetLockConflictDeadlockDetectMode(boolean b) +
      Enable deadlock detection whenever a lock conflict occurs.
      +
      voidsetLockTimeout(double lockTimeout) +
      Set the lock timeout, in seconds.
      +
      voidsetLogFileMaxSize(java.lang.Integer sizeInBytes) +
      Set the maximum transaction log file size for the BDB environment.
      +
      voidsetLogInMemory(boolean logInMemory) +
      Set true to store transaction logs in memory only instead of persistent + storage.
      +
      voidsetLogRegionSize(int logRegionSize) +
      Set the repository log region size, in bytes.
      +
      voidsetLogRegionSize(java.lang.Integer logRegionSize) +
      Set the repository log region size, in bytes.
      +
      voidsetMaster(boolean b) +
      Set to false if repository should not assume the role of master.
      +
      voidsetMaxLocks(java.lang.Integer max) 
      voidsetMultiversion(boolean multiversion) +
      Set true to enable multiversion concurrency control (MVCC) on BDB + environment.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      voidsetPanicHandler(BDBPanicHandler handler) +
      Set the handler to call if the database panics.
      +
      voidsetPreShutdownHook(java.lang.Runnable hook) +
      Sets a callback to be invoked before the repository has finished running + its own shutdown hooks.
      +
      voidsetPrivate(boolean b) +
      When true, BDB environment cannot be shared by other processes, and + region files are not created.
      +
      voidsetProduct(java.lang.String product) +
      Sets the BDB product to use, which defaults to JE.
      +
      voidsetReadOnly(boolean readOnly) +
      Sets the repository to read-only mode.
      +
      voidsetReverseSplitOff(boolean off) +
      Pass true to disable reverse split of B-tree nodes to reduce deadlocks.
      +
      voidsetRunCheckpointer(boolean runCheckpointer) +
      Disable automatic checkpointing of database if another process is + responsible for that.
      +
      voidsetRunDeadlockDetector(boolean runDeadlockDetector) +
      Disable automatic deadlock detection of database if another thread is + responsible for that.
      +
      voidsetRunFullRecovery(boolean runRecovery) +
      Pass true to override the default and run a full (catastrophic) recovery + when environment is opened.
      +
      voidsetShutdownHook(java.lang.Runnable hook) +
      Sets a callback to be invoked after repository has finished running its + own shutdown hooks.
      +
      voidsetSingleFileName(java.lang.String filename) +
      Specify that all BDB databases should reside in one file, except for log + files and caches.
      +
      voidsetStorableCodecFactory(StorableCodecFactory factory) +
      Override the default storable codec factory.
      +
      voidsetTransactionMaxActive(java.lang.Integer max) +
      Set the maximum number of concurrent transactions, or pass null to use + the default.
      +
      voidsetTransactionNoSync(boolean noSync) +
      When true, commits are not immediately written or flushed to disk.
      +
      voidsetTransactionTimeout(double txnTimeout) +
      Set the transaction timeout, in seconds.
      +
      voidsetTransactionWriteNoSync(boolean noSync) +
      When true, commits are written, but they are not flushed to disk.
      +
      booleanverify(java.io.PrintStream out) +
      Opens the BDB environment, checks if it is corrupt, and then closes it.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        BDBRepositoryBuilder

        +
        public BDBRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.io.PrintStream out)
+               throws RepositoryException
        +
        Opens the BDB environment, checks if it is corrupt, and then closes it. + Only one process should open the environment for verification. Expect it + to take a long time.
        +
        Parameters:
        out - optional stream to capture any verfication errors
        +
        Returns:
        true if environment passes verification
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setProduct

        +
        public void setProduct(java.lang.String product)
        +
        Sets the BDB product to use, which defaults to JE. Also supported is DB + and DB_HA. If not supported, an IllegalArgumentException is thrown.
        +
        • +
      + + + +
        +
      • +

        getProduct

        +
        public java.lang.String getProduct()
        +
        Returns the BDB product to use, which is JE by default.
        +
        • +
      + + + +
        +
      • +

        setBDBProduct

        +
        public void setBDBProduct(BDBProduct product)
        +
        Sets the BDB product to use, which defaults to JE.
        +
        • +
      + + + +
        +
      • +

        getBDBProduct

        +
        public BDBProduct getBDBProduct()
        +
        Returns the BDB product to use, which is JE by default.
        +
        • +
      + + + +
        +
      • +

        setEnvironmentHomeFile

        +
        public void setEnvironmentHomeFile(java.io.File envHome)
        +
        Sets the repository environment home directory, which is required.
        +
        • +
      + + + +
        +
      • +

        getEnvironmentHomeFile

        +
        public java.io.File getEnvironmentHomeFile()
        +
        Returns the repository environment home directory.
        +
        • +
      + + + +
        +
      • +

        setEnvironmentHome

        +
        public void setEnvironmentHome(java.lang.String envHome)
        +
        Sets the repository environment home directory, which is required.
        +
        Throws:
        +
        RepositoryException - if environment home is not valid
        +
        • +
      + + + +
        +
      • +

        getEnvironmentHome

        +
        public java.lang.String getEnvironmentHome()
        +
        Returns the repository environment home directory.
        +
        • +
      + + + +
        +
      • +

        setDataHomeFile

        +
        public void setDataHomeFile(java.io.File dir)
        +
        By default, data files are stored relative to the environment home. Call + this method to override. For BDBRepositories that are log files only, + this configuration is ignored.
        +
        • +
      + + + +
        +
      • +

        getDataHomeFile

        +
        public java.io.File getDataHomeFile()
        +
        Returns the optional directory to store data files. Returns null if data + files are expected to be relative to the environment home.
        +
        • +
      + + + +
        +
      • +

        setDataHome

        +
        public void setDataHome(java.lang.String dir)
        +
        By default, data files are stored relative to the environment home. Call + this method to override. For BDBRepositories that are log files only, + this configuration is ignored.
        +
        • +
      + + + +
        +
      • +

        getDataHome

        +
        public java.lang.String getDataHome()
        +
        Returns the directory to store data files.
        +
        • +
      + + + +
        +
      • +

        setSingleFileName

        +
        public void setSingleFileName(java.lang.String filename)
        +
        Specify that all BDB databases should reside in one file, except for log + files and caches. The filename is relative to the environment home, + unless data directories have been specified. For BDBRepositories that + are log files only, this configuration is ignored. + +

        Note: When setting this option, the storable codec factory must also + be changed, since the default storable codec factory is unable to + distinguish storable types that reside in a single database file. Call + setFileName instead to use built-in BDB feature for supporting multiple + databases in one file.

        +
        • +
      + + + +
        +
      • +

        getSingleFileName

        +
        public java.lang.String getSingleFileName()
        +
        Returns the single file that all BDB databases should reside in.
        +
        • +
      + + + +
        +
      • +

        setFileName

        +
        public void setFileName(java.lang.String filename,
+               java.lang.String typeName)
        +
        Specify the file that a BDB database should reside in, except for log + files and caches. The filename is relative to the environment home, + unless data directories have been specified. For BDBRepositories that + are log files only, this configuration is ignored.
        +
        Parameters:
        filename - BDB database filename
        typeName - type to store in file; if null, the file is used by default + for all types
        +
        • +
      + + + +
        +
      • +

        setIndexSupport

        +
        public void setIndexSupport(boolean indexSupport)
        +
        By default, user specified indexes are supported. Pass false to disable + this, and no indexes will be built. Another consequence of this option + is that no unique constraint checks will be applied to alternate keys.
        +
        • +
      + + + +
        +
      • +

        getIndexSupport

        +
        public boolean getIndexSupport()
        +
        Returns true if indexes are supported, which is true by default.
        +
        • +
      + + + + + + + +
        +
      • +

        setIndexRepairEnabled

        +
        public void setIndexRepairEnabled(boolean enabled)
        +
        By default, index repair is enabled. In this mode, the first time a + Storable type is used, new indexes are populated and old indexes are + removed. Until finished, access to the Storable is blocked. + +

        When index repair is disabled, the Storable is immediately + available. This does have consequences, however. The set of indexes + available for queries is defined by the intersection of the old + and new index sets. The set of indexes that are kept up-to-date is + defined by the union of the old and new index sets. + +

        While index repair is disabled, another process can safely repair the + indexes in the background. When it is complete, index repair can be + enabled for this repository too.

        +
        • +
      + + + +
        +
      • +

        getIndexRepairThrottle

        +
        public double getIndexRepairThrottle()
        +
        Returns the throttle parameter used when indexes are added, dropped or + bulk repaired. By default this value is 1.0, or maximum speed.
        +
        • +
      + + + +
        +
      • +

        setIndexRepairThrottle

        +
        public void setIndexRepairThrottle(double desiredSpeed)
        +
        Sets the throttle parameter used when indexes are added, dropped or bulk + repaired. By default this value is 1.0, or maximum speed.
        +
        Parameters:
        desiredSpeed - 1.0 = perform work at full speed, + 0.5 = perform work at half speed, 0.0 = fully suspend work
        +
        • +
      + + + +
        +
      • +

        setReadOnly

        +
        public void setReadOnly(boolean readOnly)
        +
        Sets the repository to read-only mode. By default, repository is opened + for reads and writes.
        +
        • +
      + + + +
        +
      • +

        getReadOnly

        +
        public boolean getReadOnly()
        +
        Returns true if repository should be opened read-only.
        +
        • +
      + + + +
        +
      • +

        setCacheSize

        +
        public void setCacheSize(long cacheSize)
        +
        Set the repository cache size, in bytes. Actual BDB implementation will + select a suitable default if this is not set.
        +
        • +
      + + + +
        +
      • +

        setCacheSize

        +
        public void setCacheSize(java.lang.Long cacheSize)
        +
        Set the repository cache size, in bytes. Actual BDB implementation will + select a suitable default if this is not set.
        +
        Parameters:
        cacheSize - cache size to use, or null for default
        +
        • +
      + + + +
        +
      • +

        getCacheSize

        +
        public java.lang.Long getCacheSize()
        +
        Returns the repository cache size, or null if default should be + selected.
        +
        • +
      + + + +
        +
      • +

        setLogRegionSize

        +
        public void setLogRegionSize(int logRegionSize)
        +
        Set the repository log region size, in bytes.
        +
        • +
      + + + +
        +
      • +

        setLogRegionSize

        +
        public void setLogRegionSize(java.lang.Integer logRegionSize)
        +
        Set the repository log region size, in bytes.
        +
        • +
      + + + +
        +
      • +

        getLogRegionSize

        +
        public java.lang.Integer getLogRegionSize()
        +
        Returns the repository log region size, or null if the default + should be selected.
        +
        • +
      + + + +
        +
      • +

        setCachePercent

        +
        public void setCachePercent(int cachePercent)
        +
        Set the percent of JVM heap used by the repository cache. Actual + BDB implementation will select a suitable default if this is not + set. This is overridden by setting an explicit cacheSize.
        +
        • +
      + + + +
        +
      • +

        setCachePercent

        +
        public void setCachePercent(java.lang.Integer cachePercent)
        +
        Set the percent of JVM heap used by the repository cache. Actual + BDB implementation will select a suitable default if this is not + set. This is overridden by setting an explicit cacheSize.
        +
        Parameters:
        cachePercent - percent of JVM heap to use, or null for default
        +
        • +
      + + + +
        +
      • +

        getCachePercent

        +
        public java.lang.Integer getCachePercent()
        +
        Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.
        +
        • +
      + + + +
        +
      • +

        setLockTimeout

        +
        public void setLockTimeout(double lockTimeout)
        +
        Set the lock timeout, in seconds. Default value is 0.5 seconds.
        +
        • +
      + + + +
        +
      • +

        getLockTimeout

        +
        public double getLockTimeout()
        +
        Returns the lock timeout, in seconds.
        +
        • +
      + + + +
        +
      • +

        getLockTimeoutInMicroseconds

        +
        public long getLockTimeoutInMicroseconds()
        +
        Returns the lock timeout, in microseconds, limited to max long value.
        +
        • +
      + + + +
        +
      • +

        setMaxLocks

        +
        public void setMaxLocks(java.lang.Integer max)
        +
        • +
      + + + +
        +
      • +

        getMaxLocks

        +
        public java.lang.Integer getMaxLocks()
        +
        • +
      + + + +
        +
      • +

        setTransactionTimeout

        +
        public void setTransactionTimeout(double txnTimeout)
        +
        Set the transaction timeout, in seconds. Default value is 300 seconds.
        +
        • +
      + + + +
        +
      • +

        getTransactionTimeout

        +
        public double getTransactionTimeout()
        +
        Returns the repository transaction timeout, in seconds.
        +
        • +
      + + + +
        +
      • +

        getTransactionTimeoutInMicroseconds

        +
        public long getTransactionTimeoutInMicroseconds()
        +
        Returns the repository transaction timeout, in microseconds, limited to + max long value.
        +
        • +
      + + + +
        +
      • +

        setTransactionNoSync

        +
        public void setTransactionNoSync(boolean noSync)
        +
        When true, commits are not immediately written or flushed to disk. This + improves performance, but there is a chance of losing the most recent + commits if the process is killed or if the machine crashes.
        +
        • +
      + + + +
        +
      • +

        getTransactionNoSync

        +
        public boolean getTransactionNoSync()
        +
        Returns true if transactions are not written or flushed to disk.
        +
        • +
      + + + +
        +
      • +

        setTransactionWriteNoSync

        +
        public void setTransactionWriteNoSync(boolean noSync)
        +
        When true, commits are written, but they are not flushed to disk. This + improves performance, but there is a chance of losing the most recent + commits if the machine crashes.
        +
        • +
      + + + +
        +
      • +

        getTransactionWriteNoSync

        +
        public boolean getTransactionWriteNoSync()
        +
        Returns true if transactions are not flushed to disk.
        +
        • +
      + + + +
        +
      • +

        setTransactionMaxActive

        +
        public void setTransactionMaxActive(java.lang.Integer max)
        +
        Set the maximum number of concurrent transactions, or pass null to use + the default. This setting has no effect for BDB-JE.
        +
        • +
      + + + +
        +
      • +

        getTransactionMaxActive

        +
        public java.lang.Integer getTransactionMaxActive()
        +
        Returns the maximum number of concurrent transactions, or null if the + default is used.
        +
        • +
      + + + +
        +
      • +

        setDatabasesTransactional

        +
        public void setDatabasesTransactional(java.lang.Boolean transactional)
        +
        When true, allows databases to be transactional. This setting affects + the databases, not the environment. If this is not explicitly set, the + environment getTransactional is used.
        +
        • +
      + + + +
        +
      • +

        getDatabasesTransactional

        +
        public java.lang.Boolean getDatabasesTransactional()
        +
        Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set
        +
        • +
      + + + +
        +
      • +

        setReverseSplitOff

        +
        public void setReverseSplitOff(boolean off)
        +
        Pass true to disable reverse split of B-tree nodes to reduce deadlocks. + This setting has no effect for BDB-JE.
        +
        • +
      + + + +
        +
      • +

        isReverseSplitOff

        +
        public boolean isReverseSplitOff()
        +
        • +
      + + + +
        +
      • +

        setDatabasePageSize

        +
        public void setDatabasePageSize(java.lang.Integer bytes,
+                       java.lang.Class<? extends Storable> type)
        +
        Sets the desired page size for a given type. If not specified, the page + size applies to all types.
        +
        • +
      + + + +
        +
      • +

        setPrivate

        +
        public void setPrivate(boolean b)
        +
        When true, BDB environment cannot be shared by other processes, and + region files are not created. By default, environment is shared, if + supported.
        +
        • +
      + + + +
        +
      • +

        isPrivate

        +
        public boolean isPrivate()
        +
        Returns true if BDB environment is private. By default, environment is + shared, if supported.
        +
        • +
      + + + +
        +
      • +

        setMultiversion

        +
        public void setMultiversion(boolean multiversion)
        +
        Set true to enable multiversion concurrency control (MVCC) on BDB + environment. This enables snapshot isolation, and is it is not supported + by all BDB products and versions.
        +
        • +
      + + + +
        +
      • +

        isMultiversion

        +
        public boolean isMultiversion()
        +
        Returns false by default because multiversion concurrency control (MVCC) + is not enabled.
        +
        • +
      + + + +
        +
      • +

        setLogInMemory

        +
        public void setLogInMemory(boolean logInMemory)
        +
        Set true to store transaction logs in memory only instead of persistent + storage. For BDB products which are entirely log based, no records are + ever persisted.
        +
        • +
      + + + +
        +
      • +

        getLogInMemory

        +
        public boolean getLogInMemory()
        +
        Returns false by default, indicating that transaction logs are persisted.
        +
        • +
      + + + +
        +
      • +

        setLogFileMaxSize

        +
        public void setLogFileMaxSize(java.lang.Integer sizeInBytes)
        +
        Set the maximum transaction log file size for the BDB environment.
        +
        • +
      + + + +
        +
      • +

        getLogFileMaxSize

        +
        public java.lang.Integer getLogFileMaxSize()
        +
        Returns null if default size will be used.
        +
        • +
      + + + +
        +
      • +

        setInitializeLogging

        +
        public void setInitializeLogging(boolean b)
        +
        Ensure the transaction logging sub-system is initialized, which is + usually implied.
        +
        • +
      + + + +
        +
      • +

        getInitializeLogging

        +
        public boolean getInitializeLogging()
        +
        • +
      + + + +
        +
      • +

        setRunFullRecovery

        +
        public void setRunFullRecovery(boolean runRecovery)
        +
        Pass true to override the default and run a full (catastrophic) recovery + when environment is opened. This setting has no effect for BDB-JE.
        +
        • +
      + + + +
        +
      • +

        getRunFullRecovery

        +
        public boolean getRunFullRecovery()
        +
        Returns true if a full (catastrophic) recovery should be performed when + environment is opened.
        +
        • +
      + + + +
        +
      • +

        setRunCheckpointer

        +
        public void setRunCheckpointer(boolean runCheckpointer)
        +
        Disable automatic checkpointing of database if another process is + responsible for that. The false setting is implied for read-only + databases.
        +
        • +
      + + + +
        +
      • +

        getRunCheckpointer

        +
        public boolean getRunCheckpointer()
        +
        Returns true if checkpointer is run automatically.
        +
        • +
      + + + +
        +
      • +

        setCheckpointInterval

        +
        public void setCheckpointInterval(int intervalMillis)
        +
        Set the interval to run checkpoints. This setting is ignored if the + checkpointer is not configured to run.
        +
        Parameters:
        intervalMillis - interval between checkpoints, in milliseconds
        +
        • +
      + + + +
        +
      • +

        getCheckpointInterval

        +
        public int getCheckpointInterval()
        +
        Returns:
        interval between checkpoints, in milliseconds
        +
        • +
      + + + +
        +
      • +

        setCheckpointThresholdKB

        +
        public void setCheckpointThresholdKB(int thresholdKB)
        +
        Set the size threshold to run checkpoints. This setting is ignored if + the checkpointer is not configured to run. Default value is 1024 KB. + +

        Checkpoint threshold is only used by Carbonado's built-in + checkpointer, and is ignored when using BDB-JE.

        +
        Parameters:
        thresholdKB - run checkpoint if at least this many kilobytes in log
        +
        • +
      + + + +
        +
      • +

        getCheckpointThresholdKB

        +
        public int getCheckpointThresholdKB()
        +
        Returns:
        run checkpoint if at least this many kilobytes in log
        +
        • +
      + + + +
        +
      • +

        setCheckpointThresholdMinutes

        +
        public void setCheckpointThresholdMinutes(int thresholdMinutes)
        +
        Set the time threshold to run checkpoints. This setting is ignored if + the checkpointer is not configured to run. Default value is 1 minute. + +

        Checkpoint threshold is only used by Carbonado's built-in + checkpointer, and is ignored when using BDB-JE.

        +
        Parameters:
        thresholdMinutes - run checkpoint if at least this many minutes + passed since last checkpoint
        +
        • +
      + + + +
        +
      • +

        getCheckpointThresholdMinutes

        +
        public int getCheckpointThresholdMinutes()
        +
        Returns:
        run checkpoint if at least this many minutes passed since last + checkpoint
        +
        • +
      + + + +
        +
      • +

        setKeepOldLogFiles

        +
        public void setKeepOldLogFiles(boolean keep)
        +
        By default, transaction log files are deleted when no longer needed. + Keeping log files can be used for incremental backups or for diagnosing + problems. If using BDB-JE, old log files are renamed with a ".del" + extension. If using BDB-core, the db_archive utility is required for + identifying old log files.
        +
        • +
      + + + +
        +
      • +

        getKeepOldLogFiles

        +
        public boolean getKeepOldLogFiles()
        +
        Returns false by default.
        +
        • +
      + + + +
        +
      • +

        setRunDeadlockDetector

        +
        public void setRunDeadlockDetector(boolean runDeadlockDetector)
        +
        Disable automatic deadlock detection of database if another thread is + responsible for that.
        +
        • +
      + + + +
        +
      • +

        getRunDeadlockDetector

        +
        public boolean getRunDeadlockDetector()
        +
        Returns true if deadlock detector is configured to run.
        +
        • +
      + + + +
        +
      • +

        setLockConflictDeadlockDetectMode

        +
        public void setLockConflictDeadlockDetectMode(boolean b)
        +
        Enable deadlock detection whenever a lock conflict occurs. Default is + off, and it has no effect for BDB-JE.
        +
        • +
      + + + +
        +
      • +

        getLockConflictDeadlockDetectMode

        +
        public boolean getLockConflictDeadlockDetectMode()
        +
        Returns true if deadlock detection is run whenever a lock conflict occurs.
        +
        • +
      + + + +
        +
      • +

        setChecksumEnabled

        +
        public void setChecksumEnabled(java.lang.Boolean checksumEnabled)
        +
        When true, enable checksum verification of pages read into the cache + from the backing filestore. By default checksum is enabled for BDB-JE, + and disabled for BDB-C.
        +
        • +
      + + + +
        +
      • +

        getChecksumEnabled

        +
        public java.lang.Boolean getChecksumEnabled()
        +
        Returns true if checksum verification is enabled. Returns null if the + BDB default is used.
        +
        • +
      + + + +
        +
      • +

        setInitialEnvironmentConfig

        +
        public void setInitialEnvironmentConfig(java.lang.Object envConfig)
        +
        Optionally set the BDB specific environment configuration to + use. The builder will verify that needed configuration values are set.
        +
        • +
      + + + +
        +
      • +

        getInitialEnvironmentConfig

        +
        public java.lang.Object getInitialEnvironmentConfig()
        +
        Returns the optional BDB specific environment configuration to use.
        +
        • +
      + + + +
        +
      • +

        setInitialDatabaseConfig

        +
        public void setInitialDatabaseConfig(java.lang.Object dbConfig)
        +
        Optionally set the BDB specific database configuration to use + for all databases created. The storage will verify that needed + configuration values are set.
        +
        • +
      + + + +
        +
      • +

        getInitialDatabaseConfig

        +
        public java.lang.Object getInitialDatabaseConfig()
        +
        Returns the optional BDB specific database configuration to use + for all databases created.
        +
        • +
      + + + +
        +
      • +

        setStorableCodecFactory

        +
        public void setStorableCodecFactory(StorableCodecFactory factory)
        +
        Override the default storable codec factory.
        +
        • +
      + + + +
        +
      • +

        getStorableCodecFactory

        +
        public StorableCodecFactory getStorableCodecFactory()
        +
        Returns the storable codec factory used.
        +
        • +
      + + + +
        +
      • +

        setPreShutdownHook

        +
        public void setPreShutdownHook(java.lang.Runnable hook)
        +
        Sets a callback to be invoked before the repository has finished running + its own shutdown hooks. This method is also invoked when repository is + manually closed.
        +
        • +
      + + + +
        +
      • +

        getPreShutdownHook

        +
        public java.lang.Runnable getPreShutdownHook()
        +
        Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.
        +
        • +
      + + + +
        +
      • +

        setShutdownHook

        +
        public void setShutdownHook(java.lang.Runnable hook)
        +
        Sets a callback to be invoked after repository has finished running its + own shutdown hooks. This method is also invoked when repository is + manually closed.
        +
        • +
      + + + +
        +
      • +

        getShutdownHook

        +
        public java.lang.Runnable getShutdownHook()
        +
        Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        setCompressor

        +
        public void setCompressor(java.lang.String type,
+                 java.lang.String compressionType)
        +
        Set the compressor for the given class, overriding a custom StorableCodecFactory.
        +
        Parameters:
        type - Storable to compress.
        compressionType - String representation of type of + compression. Available options are "NONE" for no compression or "GZIP" + for gzip compression
        +
        • +
      + + + +
        +
      • +

        getCompressor

        +
        public java.lang.String getCompressor(java.lang.String type)
        +
        Return the compressor used for the given storable.
        +
        Parameters:
        type - Storable to compress
        +
        Returns:
        String representation of the type of compression used. Available options are "NONE" + for no compression and "GZIP" for gzip compression.
        +
        • +
      + + + +
        +
      • +

        setPanicHandler

        +
        public void setPanicHandler(BDBPanicHandler handler)
        +
        Set the handler to call if the database panics.
        +
        Parameters:
        handler -
        +
        • +
      + + + +
        +
      • +

        getPanicHandler

        +
        public BDBPanicHandler getPanicHandler()
        +
        Return the panic handler to call if the database panics.
        +
        Returns:
        The BDBPanicHandler or null if unset.
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html new file mode 100644 index 0000000..9d9eaf1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html @@ -0,0 +1,291 @@ + + + + + + +CheckpointCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface CheckpointCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface CheckpointCapability
+extends Capability
    +
    Capability to control BDB checkpointing.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    HotBackupCapability
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidforceCheckpoint() +
      Forces a checkpoint to run now, even if checkpointer is suspended or + disabled.
      +
      voidresumeCheckpointer() +
      Resumes the checkpointer if it was suspended.
      +
      voidsuspendCheckpointer(long suspensionTime) +
      Suspend the checkpointer until the suspension time has expired or until + manually resumed.
      +
      voidsync() +
      Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        suspendCheckpointer

        +
        void suspendCheckpointer(long suspensionTime)
        +
        Suspend the checkpointer until the suspension time has expired or until + manually resumed. If a checkpoint is in progress, this method will block + until it is finished. If checkpointing is disabled, calling this method + has no effect. + +

        Calling this method repeatedly resets the suspension time. Each + invocation of suspendCheckpointer is like a lease renewal or heartbeat.

        +
        Parameters:
        suspensionTime - minimum length of suspension, in milliseconds, + unless checkpointer is manually resumed
        +
        • +
      + + + +
        +
      • +

        resumeCheckpointer

        +
        void resumeCheckpointer()
        +
        Resumes the checkpointer if it was suspended. If checkpointing is + disabled or if not suspended, calling this method has no effect.
        +
        • +
      + + + +
        +
      • +

        forceCheckpoint

        +
        void forceCheckpoint()
+                     throws PersistException
        +
        Forces a checkpoint to run now, even if checkpointer is suspended or + disabled. If a checkpoint is in progress, then this method will block + until it is finished, and then run another checkpoint. This method does + not return until the requested checkpoint has finished.
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        sync

        +
        void sync()
+          throws PersistException
        +
        Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.
        +
        Throws:
        +
        PersistException
        Since:
        +
        1.2.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/sleepycat/CompactionCapability.Result.html b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html new file mode 100644 index 0000000..bea8c9d --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html @@ -0,0 +1,264 @@ + + + + + + +CompactionCapability.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface CompactionCapability.Result<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPagesExamine

        +
        int getPagesExamine()
        +
        • +
      + + + +
        +
      • +

        getPagesFree

        +
        int getPagesFree()
        +
        • +
      + + + +
        +
      • +

        getPagesTruncated

        +
        int getPagesTruncated()
        +
        • +
      + + + +
        +
      • +

        getLevels

        +
        int getLevels()
        +
        • +
      + + + +
        +
      • +

        getDeadlockCount

        +
        int getDeadlockCount()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/sleepycat/CompactionCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.html new file mode 100644 index 0000000..1b0e2e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.html @@ -0,0 +1,244 @@ + + + + + + +CompactionCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface CompactionCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface CompactionCapability
+extends Capability
    +
    Capability to compact a BDB database. This capability is not supported by + all versions of BDB.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/sleepycat/EnvironmentCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html new file mode 100644 index 0000000..08405e2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html @@ -0,0 +1,284 @@ + + + + + + +EnvironmentCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface EnvironmentCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface EnvironmentCapability
+extends Capability
    +
    Capability to provide direct access to the underlying BDB environment.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      BDBProductgetBDBProduct() 
      java.io.FilegetDataHome() +
      Returns the directory where data files are stored, which is the same as + the home directory by default.
      +
      java.lang.ObjectgetEnvironment() +
      Returns the BDB environment object, which must be cast to the expected + type, depending on the BDB product and version being used.
      +
      java.io.FilegetHome() +
      Returns the home directory for the BDB environment.
      +
      int[]getVersion() +
      Returns the major, minor, and patch version numbers.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getEnvironment

        +
        java.lang.Object getEnvironment()
        +
        Returns the BDB environment object, which must be cast to the expected + type, depending on the BDB product and version being used.
        +
        • +
      + + + +
        +
      • +

        getBDBProduct

        +
        BDBProduct getBDBProduct()
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        int[] getVersion()
        +
        Returns the major, minor, and patch version numbers.
        +
        • +
      + + + +
        +
      • +

        getHome

        +
        java.io.File getHome()
        +
        Returns the home directory for the BDB environment.
        +
        • +
      + + + +
        +
      • +

        getDataHome

        +
        java.io.File getDataHome()
        +
        Returns the directory where data files are stored, which is the same as + the home directory by default.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/sleepycat/HotBackupCapability.Backup.html b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html new file mode 100644 index 0000000..e6dfea5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html @@ -0,0 +1,309 @@ + + + + + + +HotBackupCapability.Backup (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface HotBackupCapability.Backup

+
+
+
+
    +
  • +
    +
    Enclosing interface:
    +
    HotBackupCapability
    +
    +
    +
    +
    public static interface HotBackupCapability.Backup
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidendBackup() +
      Resume normal operation.
      +
      java.io.File[]getDataFiles() +
      Returns all the data files to be copied.
      +
      java.io.File[]getFiles() +
      Deprecated.  +
      use getDataFiles and getLogFiles
      +
      +
      longgetLastLogNumber() +
      Can be called after a backup has been performed to find the last log file + that has been backed up.
      +
      java.io.File[]getLogFiles() +
      Returns all the transaction log files to be copied, in the exact + order in which they must be copied.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getDataFiles

        +
        java.io.File[] getDataFiles()
+                            throws RepositoryException
        +
        Returns all the data files to be copied. After these files are + durably copied, call getLogFiles() and copy the log files + which were created while the data files were copied.
        +
        Returns:
        array of data files, which might be empty
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        getLogFiles

        +
        java.io.File[] getLogFiles()
+                           throws RepositoryException
        +
        Returns all the transaction log files to be copied, in the exact + order in which they must be copied. After these files are durably + copied, call endBackup().
        +
        Returns:
        array of transaction log files, never empty
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        getLastLogNumber

        +
        long getLastLogNumber()
+                      throws RepositoryException
        +
        Can be called after a backup has been performed to find the last log file + that has been backed up.
        +
        Returns:
        the file number of the last file in the current backup set. + This number is required to perform incremental backups.
        +
        Throws:
        +
        java.lang.IllegalStateException - if getFiles() was not called
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/sleepycat/HotBackupCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html new file mode 100644 index 0000000..a3632c0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html @@ -0,0 +1,333 @@ + + + + + + +HotBackupCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface HotBackupCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface HotBackupCapability
+extends Capability
    +
    Capability for performing a backup of an active BDB environment. If in-memory logging is enabled, + backups cannot be performed. To restore from a hot backup, it is + critical that a full recovery be performed. Pass true to setRunFullRecovery to + enable. BDB-JE does not require this, however. + +

    To support incremental backups against the native + BDB product, old log files must be kept. Pass true to setKeepOldLogFiles.

    +
    Since:
    +
    1.2.1
    +
    Author:
    +
    Brian S O'Neill, Olga Kuznetsova
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        startBackup

        +
        HotBackupCapability.Backup startBackup()
+                                       throws RepositoryException
        +
        Starts the backup by disabling log file deletion. Be sure to call + endBackup when done to resume log file cleanup. Concurrent backups are + supported.
        +
        Throws:
        +
        java.lang.IllegalStateException - if configuration doesn't support backups
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        startBackup

        +
        HotBackupCapability.Backup startBackup(boolean deleteOldLogFiles)
+                                       throws RepositoryException
        +
        Starts the backup by disabling log file deletion. Be sure to call + endBackup when done to resume log file cleanup. Concurrent backups are supported. + +

        Caution should be observed when deleting old log files by force, if + an external process is also performing backups. If a concurrent backup + is issued by this repository instance, log file deletion is suppressed.

        +
        Parameters:
        deleteOldLogFiles - deletes log files that are no longer in use and + have been backed up. False by default.
        +
        Throws:
        +
        java.lang.IllegalStateException - if configuration doesn't support backups
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        startIncrementalBackup

        +
        HotBackupCapability.Backup startIncrementalBackup(long lastLogNumber)
+                                                  throws RepositoryException
        +
        Starts an incremental backup. Log files that are newer than the + lastLogNumber will be copied during the backup. Should only be run after + performing a full backup.
        +
        Parameters:
        lastLogNumber - number of the last log file that was copied in a previous backup
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if lastLogNumber is negative
        +
        java.lang.IllegalStateException - if configuration doesn't support backups
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        startIncrementalBackup

        +
        HotBackupCapability.Backup startIncrementalBackup(long lastLogNumber,
+                                                boolean deleteOldLogFiles)
+                                                  throws RepositoryException
        +
        Starts an incremental backup. Log files that are newer than the lastLogNumber will be copied + during the backup. Can only be run after performing a full backup. + +

        Caution should be observed when deleting old log files by force, if + an external process is also performing backups. If a concurrent backup + is issued by this repository instance, log file deletion is suppressed.

        +
        Parameters:
        lastLogNumber - number of the last log file that was copied in a previous backup.
        deleteOldLogFiles - deletes log files that are no longer in use and + have been backed up. False by default.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if lastLogNumber is negative
        +
        java.lang.IllegalStateException - if configuration doesn't support backups
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/repo/sleepycat/StoredDatabaseInfo.html b/apidocs/com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html new file mode 100644 index 0000000..dbd7d87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html @@ -0,0 +1,537 @@ + + + + + + +StoredDatabaseInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Class StoredDatabaseInfo

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Unevolvable, Unindexed, Storable
    +
    +
    +
    +
    @PrimaryKey(value="databaseName")
+@Independent
+@Alias(value="CARBONADO_DATABASE_INFO")
+public abstract class StoredDatabaseInfo
+extends java.lang.Object
+implements Storable, Unevolvable, Unindexed
    +
    Stores basic information about the BDB databases managed by BDBRepository. + +

    Note: This storable cannot have indexes defined, since it is used to + discover information about indexes. It would create a cyclic dependency.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        EVOLUTION_NONE

        +
        public static final int EVOLUTION_NONE
        +
        Evolution strategy code
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        EVOLUTION_STANDARD

        +
        public static final int EVOLUTION_STANDARD
        +
        Evolution strategy code
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StoredDatabaseInfo

        +
        public StoredDatabaseInfo()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDatabaseName

        +
        public abstract java.lang.String getDatabaseName()
        +
        • +
      + + + +
        +
      • +

        setDatabaseName

        +
        public abstract void setDatabaseName(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        getIndexNameDescriptor

        +
        @Nullable
+public abstract java.lang.String getIndexNameDescriptor()
        +
        Returns the index name descriptor for the keys of this database. This + descriptor is defined by StorableIndex, and + it does not contain type information.
        +
        • +
      + + + +
        +
      • +

        setIndexNameDescriptor

        +
        public abstract void setIndexNameDescriptor(java.lang.String descriptor)
        +
        • +
      + + + +
        +
      • +

        getIndexTypeDescriptor

        +
        @Nullable
+public abstract java.lang.String getIndexTypeDescriptor()
        +
        Returns the types of the index properties. This descriptor is defined by + StorableIndex.
        +
        • +
      + + + +
        +
      • +

        setIndexTypeDescriptor

        +
        public abstract void setIndexTypeDescriptor(java.lang.String descriptor)
        +
        • +
      + + + +
        +
      • +

        getEvolutionStrategy

        +
        public abstract int getEvolutionStrategy()
        +
        Returns EVOLUTION_NONE if evolution of records is not supported.
        +
        • +
      + + + +
        +
      • +

        setEvolutionStrategy

        +
        public abstract void setEvolutionStrategy(int strategy)
        +
        • +
      + + + +
        +
      • +

        getCreationTimestamp

        +
        public abstract long getCreationTimestamp()
        +
        Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.
        +
        • +
      + + + +
        +
      • +

        setCreationTimestamp

        +
        public abstract void setCreationTimestamp(long timestamp)
        +
        • +
      + + + +
        +
      • +

        getVersionNumber

        +
        @Version
+public abstract int getVersionNumber()
        +
        Record version number for this StoredDatabaseInfo instance. Some + encoding strategies require a version number.
        +
        • +
      + + + +
        +
      • +

        setVersionNumber

        +
        public abstract void setVersionNumber(int version)
        +
        • +
      + + + +
        +
      • +

        getExtraData

        +
        @Nullable
+public abstract byte[] getExtraData()
        +
        Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.
        +
        • +
      + + + +
        +
      • +

        setExtraData

        +
        public abstract void setExtraData(byte[] data)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html new file mode 100644 index 0000000..37bc176 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html @@ -0,0 +1,177 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.BDBPanicHandler (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.BDBPanicHandler

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html new file mode 100644 index 0000000..62c74c4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html @@ -0,0 +1,198 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.sleepycat.BDBProduct (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.sleepycat.BDBProduct

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html new file mode 100644 index 0000000..80663c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html @@ -0,0 +1,177 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook

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

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

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

Uses of Class
com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html new file mode 100644 index 0000000..445c753 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.CheckpointCapability

+
+
No usage of com.amazon.carbonado.repo.sleepycat.CheckpointCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html new file mode 100644 index 0000000..d3ab8dc --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html @@ -0,0 +1,162 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html new file mode 100644 index 0000000..f810a9f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.CompactionCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.CompactionCapability

+
+
No usage of com.amazon.carbonado.repo.sleepycat.CompactionCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html new file mode 100644 index 0000000..9a62e14 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.EnvironmentCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.EnvironmentCapability

+
+
No usage of com.amazon.carbonado.repo.sleepycat.EnvironmentCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html new file mode 100644 index 0000000..e2700fe --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html @@ -0,0 +1,181 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html new file mode 100644 index 0000000..30aef75 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.HotBackupCapability

+
+
No usage of com.amazon.carbonado.repo.sleepycat.HotBackupCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo

+
+
No usage of com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

com.amazon.carbonado.repo.sleepycat

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html b/apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html new file mode 100644 index 0000000..37f4909 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html @@ -0,0 +1,228 @@ + + + + + + +com.amazon.carbonado.repo.sleepycat (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.repo.sleepycat

+
+
Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.sleepycat Description

+
Repository implementation backed by a Sleepycat (BDB, Berkeley) + database. Data is encoded in a specialized format, and so this repository + should not be used to open arbitrary Berkeley databases. BDBRepository has + total schema ownership, and so it updates type definitions in the storage + layer automatically.
+
See Also:
BDBRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Hierarchy For Package com.amazon.carbonado.repo.sleepycat

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

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

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

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

Uses of Package
com.amazon.carbonado.repo.sleepycat

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

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

+ + -- cgit v1.2.3