Package org.osgi.service.transaction.control.jdbc

Interface JDBCConnectionProviderFactory

@ProviderType public interface JDBCConnectionProviderFactory
A factory for creating JDBCConnectionProvider instances

This factory can be used if the JDBCConnectionProvider should not be a public service, for example to protect a username/password.

  • Field Details

    • XA_ENLISTMENT_ENABLED

      static final String XA_ENLISTMENT_ENABLED
      The property used to determine whether XA enlistment is enabled for this resource provider
      See Also:

    • LOCAL_ENLISTMENT_ENABLED

      static final String LOCAL_ENLISTMENT_ENABLED
      The property used to determine whether local enlistment is enabled for this resource provider
      See Also:

    • XA_RECOVERY_ENABLED

      static final String XA_RECOVERY_ENABLED
      The property used to determine whether XA recovery is enabled for this resource provider
      See Also:

    • CONNECTION_POOLING_ENABLED

      static final String CONNECTION_POOLING_ENABLED
      The property used to determine whether connection pooling is enabled for this resource provider
      See Also:

    • CONNECTION_TIMEOUT

      static final String CONNECTION_TIMEOUT
      The property used to set the maximum amount of time that the pool should wait for a connection
      See Also:

    • IDLE_TIMEOUT

      static final String IDLE_TIMEOUT
      The property used to set the maximum amount of time that connections in the pool should remain idle before being closed
      See Also:

    • CONNECTION_LIFETIME

      static final String CONNECTION_LIFETIME
      The property used to set the maximum amount of time that connections in the pool should remain open
      See Also:

    • MIN_CONNECTIONS

      static final String MIN_CONNECTIONS
      The property used to set the minimum number of connections that should be held in the pool
      See Also:

    • MAX_CONNECTIONS

      static final String MAX_CONNECTIONS
      The property used to set the maximum number of connections that should be held in the pool
      See Also:

    • USE_DRIVER

      static final String USE_DRIVER
      The property used to set the maximum number of connections that should be held in the pool
      See Also:

    • OSGI_RECOVERY_IDENTIFIER

      static final String OSGI_RECOVERY_IDENTIFIER
      The property used to set the recovery identifier that should be used by this resource
      See Also:

  • Method Details

    • getProviderFor

      JDBCConnectionProvider getProviderFor(DataSourceFactory dsf, Properties jdbcProperties, Map<String,Object> resourceProviderProperties)
      Create a private JDBCConnectionProvider using a DataSourceFactory. This call may fail with a TransactionException if the supplied configuration is invalid. Examples of invalid configuration include:
      • The properties request XA enlistment, but the provider implementation only supports local enlistment
      • The properties attempt to set a recovery alias, but the provider does not support recovery.
      Parameters:
      dsf -
      jdbcProperties - The properties to pass to the DataSourceFactory in order to create the underlying DataSource
      resourceProviderProperties - Configuration properties to pass to the JDBC Resource Provider runtime
      Returns:
      A JDBCConnectionProvider that can be used in transactions

    • getProviderFor

      JDBCConnectionProvider getProviderFor(DataSource ds, Map<String,Object> resourceProviderProperties)
      Create a private JDBCConnectionProvider using an existing DataSource. This call may fail with a TransactionException if the supplied configuration is invalid. Examples of invalid configuration include:
      • The properties request XA enlistment, but the provider implementation only supports local enlistment
      • The properties attempt to set a recovery alias, but the provider does not support recovery.
      Parameters:
      ds -
      resourceProviderProperties - Configuration properties to pass to the JDBC Resource Provider runtime
      Returns:
      A JDBCConnectionProvider that can be used in transactions

    • getProviderFor

      JDBCConnectionProvider getProviderFor(Driver driver, Properties jdbcProperties, Map<String,Object> resourceProviderProperties)
      Create a private JDBCConnectionProvider using an existing Driver. This call may fail with a TransactionException if the supplied configuration is invalid. Examples of invalid configuration include:
      • The properties request XA enlistment, but the provider implementation only supports local enlistment
      • The properties attempt to set a recovery alias, but the provider does not support recovery.
      Parameters:
      driver -
      jdbcProperties - The properties to pass to the Driver in order to create a Connection
      resourceProviderProperties - Configuration properties to pass to the JDBC Resource Provider runtime
      Returns:
      A JDBCConnectionProvider that can be used in transactions

    • getProviderFor

      JDBCConnectionProvider getProviderFor(XADataSource ds, Map<String,Object> resourceProviderProperties)
      Create a private JDBCConnectionProvider using an existing XADataSource. This call may fail with a TransactionException if the supplied configuration is invalid. Examples of invalid configuration include:
      • The properties request XA enlistment, but the provider implementation only supports local enlistment
      • The properties attempt to set a recovery alias, but the provider does not support recovery.
      Parameters:
      ds -
      resourceProviderProperties - Configuration properties to pass to the JDBC Resource Provider runtime
      Returns:
      A JDBCConnectionProvider that can be used in transactions

    • releaseProvider

      void releaseProvider(JDBCConnectionProvider provider)
      Release a JDBCConnectionProvider instance that has been created by this factory. Released instances are eligible to be shut down and have any remaining open connections closed.

      Note that all JDBCConnectionProvider instances created by this factory service are implicitly released when the factory service is released by this bundle.

      Parameters:
      provider -
      Throws:
      IllegalArgumentException - if the supplied resource was not created by this factory service instance.