From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../amazon/carbonado/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 ++++ 24 files changed, 6387 insertions(+) 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 (limited to 'apidocs/com/amazon/carbonado/repo/jdbc') 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.

+ + -- cgit v1.2.3