6.8. アーティファクトとしてのデータソースのデプロイ
この章では、OSGi JDBC サービスを紹介し、pax-jdbc バンドルがデータベース固有および汎用データソースの登録にどのように役立つのか、および OSGi サービスと設定管理者設定の観点から見たすべての仕組みについて説明します。データソースの両方のカテゴリー の設定は、Configuration Admin ファクトリー PID を使用して行うことができますが (pax-jdbc-config バンドルを利用して)、通常は デプロイメント方法 を使用することが推奨されます。
デプロイメント方法 では、javax.sql.DataSource サービスは、通常 Blueprint コンテナー内でアプリケーションコードから直接登録されます。Blueprint XML は、通常の OSGi バンドルの一部で、mvn: URI を使用してインストールでき、Maven リポジトリー (ローカルまたはリモート) に保存されます。このようなバンドルを Configuration Admin 設定と比較することで、バージョン管理がはるかに容易になります。
pax-jdbc-config バンドルバージョン 1.3.0 は、データソース 設定の デプロイメントメソッドを追加します。アプリケーション開発者は (通常 Bluerpint XML を使用して) javax.sql.(XA)DataSource サービスを登録し、サービスプロパティーを指定します。pax-jdbc-config バンドルは、このような登録データベース固有のデータソースを検出し (サービスプロパティーを使用) 、汎用的なデータベース固有でない接続プール内でサービスをラップします。
完全を期すため、Blueprint XML を使用する 3 つの デプロイメントメソッド を以下に示します。Fuse には、Fuse のさまざまな側面の例が含まれる quickstarts ダウンロードを提供します。quickstarts zip ファイルは Fuse Software Downloads ページからダウンロードできます。
クイックスタート zip ファイルの内容をローカルフォルダーに展開します。
以下の例では、quickstarts/persistence ディレクトリーは $PQ_HOME と呼ばれます。
6.8.1. データソースの手動デプロイメント
データソースの手動デプロイメントの例では、docker ベースの PostgreSQL インストールを使用します。この方法では、pax-jdbc-config は必要ありません。アプリケーションコードは、データベース固有および汎用データソースの両方の登録を行います。
これらの 3 つのバンドルが必要です。
-
mvn:org.postgresql/postgresql/42.2.5 -
mvn:org.apache.commons/commons-pool2/2.5.0 -
mvn:org.apache.commons/commons-dbcp2/2.1.1
<!--
Database-specific, non-pooling, non-enlisting javax.sql.XADataSource
-->
<bean id="postgresql" class="org.postgresql.xa.PGXADataSource">
<property name="url" value="jdbc:postgresql://localhost:5432/reportdb" />
<property name="user" value="fuse" />
<property name="password" value="fuse" />
<property name="currentSchema" value="report" />
<property name="connectTimeout" value="5" />
</bean>
<!--
Fuse/Karaf exports this service from fuse-pax-transx-tm-narayana bundle
-->
<reference id="tm" interface="javax.transaction.TransactionManager" />
<!--
Non database-specific, generic, pooling, enlisting javax.sql.DataSource
-->
<bean id="pool" class="org.apache.commons.dbcp2.managed.BasicManagedDataSource">
<property name="xaDataSourceInstance" ref="postgresql" />
<property name="transactionManager" ref="tm" />
<property name="minIdle" value="3" />
<property name="maxTotal" value="10" />
<property name="validationQuery" value="select schema_name, schema_owner from information_schema.schemata" />
</bean>
<!--
Expose datasource to use by application code (like Camel, Spring, ...)
-->
<service interface="javax.sql.DataSource" ref="pool">
<service-properties>
<entry key="osgi.jndi.service.name" value="jdbc/postgresql" />
</service-properties>
</service>上記の Blueprint XML フラグメントは 標準の DataSource 例 と一致します。以下は、その使用方法を示すシェルコマンドです。
karaf@root()> install -s mvn:org.postgresql/postgresql/42.2.5 Bundle ID: 233 karaf@root()> install -s mvn:org.apache.commons/commons-pool2/2.5.0 Bundle ID: 224 karaf@root()> install -s mvn:org.apache.commons/commons-dbcp2/2.1.1 Bundle ID: 225 karaf@root()> install -s blueprint:file://$PQ_HOME/databases/blueprints/postgresql-manual.xml Bundle ID: 226 karaf@root()> bundle:services -p 226 Bundle 226 provides: -------------------- objectClass = [javax.sql.DataSource] osgi.jndi.service.name = jdbc/postgresql osgi.service.blueprint.compname = pool service.bundleid = 226 service.id = 242 service.scope = bundle ----- objectClass = [org.osgi.service.blueprint.container.BlueprintContainer] osgi.blueprint.container.symbolicname = postgresql-manual.xml osgi.blueprint.container.version = 0.0.0 service.bundleid = 226 service.id = 243 service.scope = singleton karaf@root()> feature:install jdbc karaf@root()> jdbc:ds-list Name │ Product │ Version │ URL │ Status ────────────────┼────────────┼───────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼─────── jdbc/postgresql │ PostgreSQL │ 10.3 (Debian 10.3-1.pgdg90+1) │ jdbc:postgresql://localhost:5432/reportdb?prepareThreshold=5&preparedStatementCacheQueries=256&preparedStatementCacheSizeMiB=5&databaseMetadataCacheFields=65536&databaseMetadataCacheFieldsMiB=5&defaultRowFetchSize=0&binaryTransfer=true&readOnly=false&binaryTransferEnable=&binaryTransferDisable=&unknownLength=2147483647&logUnclosedConnections=false&disableColumnSanitiser=false&tcpKeepAlive=false&loginTimeout=0&connectTimeout=5&socketTimeout=0&cancelSignalTimeout=10&receiveBufferSize=-1&sendBufferSize=-1&ApplicationName=PostgreSQL JDBC Driver&jaasLogin=true&useSpnego=false&gsslib=auto&sspiServiceClass=POSTGRES&allowEncodingChanges=false¤tSchema=report&targetServerType=any&loadBalanceHosts=false&hostRecheckSeconds=10&preferQueryMode=extended&autosave=never&reWriteBatchedInserts=false │ OK karaf@root()> jdbc:query jdbc/postgresql 'select * from incident'; date │ summary │ name │ details │ id │ email ────────────────────┼────────────┼────────┼───────────────────────────────┼────┼───────────────── 2018-02-20 08:00:00 │ Incident 1 │ User 1 │ This is a report incident 001 │ 1 │ user1@redhat.com 2018-02-20 08:10:00 │ Incident 2 │ User 2 │ This is a report incident 002 │ 2 │ user2@redhat.com 2018-02-20 08:20:00 │ Incident 3 │ User 3 │ This is a report incident 003 │ 3 │ user3@redhat.com 2018-02-20 08:30:00 │ Incident 4 │ User 4 │ This is a report incident 004 │ 4 │ user4@redhat.com
上記の一覧に示すように、Blueprint バンドルは、汎用的でデータベース固有でない接続プールである javax.sql.DataSource サービスをエクスポートします。Blueprint XML には明示的な <service ref="postgresql"> 宣言がないため、データベース固有の javax.sql.XADataSource バンドルは OSGi サービスとして登録されません。
6.8.2. データソースのファクトリーデプロイメント
データソースのファクトリーデプロイメントは、標準的 な方法で pax-jdbc-config バンドルを使用します。これは、サービスプロパティーとしてプーリング設定を指定する必要があった Fuse6.x で推奨されていた方法とは少し異なります。
Blueprint XML の例を以下に示します。
<!--
A database-specific org.osgi.service.jdbc.DataSourceFactory that can create DataSource/XADataSource/
/ConnectionPoolDataSource/Driver using properties. It is registered by pax-jdbc-* or for example
mvn:org.postgresql/postgresql/42.2.5 bundle natively.
-->
<reference id="dataSourceFactory"
interface="org.osgi.service.jdbc.DataSourceFactory"
filter="(osgi.jdbc.driver.class=org.postgresql.Driver)" />
<!--
Non database-specific org.ops4j.pax.jdbc.pool.common.PooledDataSourceFactory that can create
pooled data sources using some org.osgi.service.jdbc.DataSourceFactory. dbcp2 pool is registered
by pax-jdbc-pool-dbcp2 bundle.
-->
<reference id="pooledDataSourceFactory"
interface="org.ops4j.pax.jdbc.pool.common.PooledDataSourceFactory"
filter="(&(pool=dbcp2)(xa=true))" />
<!--
Finally, use both factories to expose pooled, xa-aware data source.
-->
<bean id="pool" factory-ref="pooledDataSourceFactory" factory-method="create">
<argument ref="dataSourceFactory" />
<argument>
<props>
<!--
Properties needed by postgresql-specific org.osgi.service.jdbc.DataSourceFactory.
Cannot prepend them with 'jdbc.' prefix as the DataSourceFactory is implemented directly
by PostgreSQL driver, not by pax-jdbc-* bundle.
-->
<prop key="url" value="jdbc:postgresql://localhost:5432/reportdb" />
<prop key="user" value="fuse" />
<prop key="password" value="fuse" />
<prop key="currentSchema" value="report" />
<prop key="connectTimeout" value="5" />
<!-- Properties needed by dbcp2-specific org.ops4j.pax.jdbc.pool.common.PooledDataSourceFactory -->
<prop key="pool.minIdle" value="2" />
<prop key="pool.maxTotal" value="10" />
<prop key="pool.blockWhenExhausted" value="true" />
<prop key="pool.maxWaitMillis" value="2000" />
<prop key="pool.testOnBorrow" value="true" />
<prop key="pool.testWhileIdle" value="false" />
<prop key="factory.validationQuery" value="select schema_name from information_schema.schemata" />
<prop key="factory.validationQueryTimeout" value="2" />
</props>
</argument>
</bean>
<!--
Expose data source for use by application code (such as Camel, Spring, ...).
-->
<service interface="javax.sql.DataSource" ref="pool">
<service-properties>
<entry key="osgi.jndi.service.name" value="jdbc/postgresql" />
</service-properties>
</service>
この例では、データソース ファクトリー を使用してデータソースを作成するファクトリー Bean を使用します。XA 対応の PooledDataSourceFactory によって内部的に追跡されるため、javax.transaction.TransactionManager サービスを明示的に参照する必要はありません。
以下の例は Fuse/Karaf シェルと同じです。
注記
ネイティブの org.osgi.service.jdbc.DataSourcFactory バンドルを登録するには、mvn:org.osgi/org.osgi.service.jdbc/1.0.0 をインストールしてから、PostgreSQL ドライバーをインストールします。
karaf@root()> feature:install jdbc pax-jdbc-config pax-jdbc-pool-dbcp2 karaf@root()> install -s mvn:org.postgresql/postgresql/42.2.5 Bundle ID: 232 karaf@root()> install -s blueprint:file://$PQ_HOME/databases/blueprints/postgresql-pax-jdbc-factory-dbcp2.xml Bundle ID: 233 karaf@root()> bundle:services -p 233 Bundle 233 provides: -------------------- objectClass = [javax.sql.DataSource] osgi.jndi.service.name = jdbc/postgresql osgi.service.blueprint.compname = pool service.bundleid = 233 service.id = 336 service.scope = bundle ----- objectClass = [org.osgi.service.blueprint.container.BlueprintContainer] osgi.blueprint.container.symbolicname = postgresql-pax-jdbc-factory-dbcp2.xml osgi.blueprint.container.version = 0.0.0 service.bundleid = 233 service.id = 337 service.scope = singleton karaf@root()> jdbc:ds-list Name │ Product │ Version │ URL │ Status ────────────────┼────────────┼───────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼─────── jdbc/postgresql │ PostgreSQL │ 10.3 (Debian 10.3-1.pgdg90+1) │ jdbc:postgresql://localhost:5432/reportdb?prepareThreshold=5&preparedStatementCacheQueries=256&preparedStatementCacheSizeMiB=5&databaseMetadataCacheFields=65536&databaseMetadataCacheFieldsMiB=5&defaultRowFetchSize=0&binaryTransfer=true&readOnly=false&binaryTransferEnable=&binaryTransferDisable=&unknownLength=2147483647&logUnclosedConnections=false&disableColumnSanitiser=false&tcpKeepAlive=false&loginTimeout=0&connectTimeout=5&socketTimeout=0&cancelSignalTimeout=10&receiveBufferSize=-1&sendBufferSize=-1&ApplicationName=PostgreSQL JDBC Driver&jaasLogin=true&useSpnego=false&gsslib=auto&sspiServiceClass=POSTGRES&allowEncodingChanges=false¤tSchema=report&targetServerType=any&loadBalanceHosts=false&hostRecheckSeconds=10&preferQueryMode=extended&autosave=never&reWriteBatchedInserts=false │ OK karaf@root()> jdbc:query jdbc/postgresql 'select * from incident'; date │ summary │ name │ details │ id │ email ────────────────────┼────────────┼────────┼───────────────────────────────┼────┼───────────────── 2018-02-20 08:00:00 │ Incident 1 │ User 1 │ This is a report incident 001 │ 1 │ user1@redhat.com 2018-02-20 08:10:00 │ Incident 2 │ User 2 │ This is a report incident 002 │ 2 │ user2@redhat.com 2018-02-20 08:20:00 │ Incident 3 │ User 3 │ This is a report incident 003 │ 3 │ user3@redhat.com 2018-02-20 08:30:00 │ Incident 4 │ User 4 │ This is a report incident 004 │ 4 │ user4@redhat.com
上記の一覧に示すように、Blueprint バンドルは、汎用的でデータベース固有でない接続プールである javax.sql.DataSource サービスをエクスポートします。Blueprint XML には明示的な <service ref="postgresql"> 宣言がないため、データベース固有の javax.sql.XADataSource バンドルは OSGi サービスとして登録されません。
6.8.3. データソースの混合デプロイメント
データソースの混合デプロイメントでは、pax-jdbc-config 1.3.0 バンドルは、サービスプロパティーを使用して、プーリングデータソース内でデータベース固有のデータソースを ラッピング する別の方法を追加します。このメソッドは、Fuse 6.x で動作した方法と一致します。
以下は Blueprint XML の例です。
<!--
Database-specific, non-pooling, non-enlisting javax.sql.XADataSource
-->
<bean id="postgresql" class="org.postgresql.xa.PGXADataSource">
<property name="url" value="jdbc:postgresql://localhost:5432/reportdb" />
<property name="user" value="fuse" />
<property name="password" value="fuse" />
<property name="currentSchema" value="report" />
<property name="connectTimeout" value="5" />
</bean>
<!--
Expose database-specific data source with service properties.
No need to expose pooling, enlisting, non database-specific javax.sql.DataSource. It is registered
automatically by pax-jdbc-config with the same properties as this <service>, but with higher service.ranking.
-->
<service id="pool" ref="postgresql" interface="javax.sql.XADataSource">
<service-properties>
<!-- "pool" key is needed for pax-jdbc-config to wrap database-specific data source inside connection pool -->
<entry key="pool" value="dbcp2" />
<entry key="osgi.jndi.service.name" value="jdbc/postgresql" />
<!-- Other properties that configure given connection pool, as indicated by pool=dbcp2 -->
<entry key="pool.minIdle" value="2" />
<entry key="pool.maxTotal" value="10" />
<entry key="pool.blockWhenExhausted" value="true" />
<entry key="pool.maxWaitMillis" value="2000" />
<entry key="pool.testOnBorrow" value="true" />
<entry key="pool.testWhileIdle" value="false" />
<entry key="factory.validationQuery" value="select schema_name from information_schema.schemata" />
<entry key="factory.validationQueryTimeout" value="2" />
</service-properties>
</service>
上記の例では、データベース固有のデータソースのみが手動で登録されています。pool=dbcp2 サービスプロパティーは、pax-jdbc-config バンドルによって管理されるデータソーストラッカーのヒントです。このサービスプロパティーを持つデータソースサービスは、プーリングデータソース内でラップされます (この例では pax-jdbc-pool-dbcp2)。
以下は、Fuse/Karaf シェルと同じ例です。
karaf@root()> feature:install jdbc pax-jdbc-config pax-jdbc-pool-dbcp2 karaf@root()> install -s mvn:org.postgresql/postgresql/42.2.5 Bundle ID: 232 karaf@root()> install -s blueprint:file://$PQ_HOME/databases/blueprints/postgresql-pax-jdbc-discovery.xml Bundle ID: 233 karaf@root()> bundle:services -p 233 Bundle 233 provides: -------------------- factory.validationQuery = select schema_name from information_schema.schemata factory.validationQueryTimeout = 2 objectClass = [javax.sql.XADataSource] osgi.jndi.service.name = jdbc/postgresql osgi.service.blueprint.compname = postgresql pool = dbcp2 pool.blockWhenExhausted = true pool.maxTotal = 10 pool.maxWaitMillis = 2000 pool.minIdle = 2 pool.testOnBorrow = true pool.testWhileIdle = false service.bundleid = 233 service.id = 336 service.scope = bundle ----- objectClass = [org.osgi.service.blueprint.container.BlueprintContainer] osgi.blueprint.container.symbolicname = postgresql-pax-jdbc-discovery.xml osgi.blueprint.container.version = 0.0.0 service.bundleid = 233 service.id = 338 service.scope = singleton karaf@root()> service:list javax.sql.XADataSource [javax.sql.XADataSource] ------------------------ factory.validationQuery = select schema_name from information_schema.schemata factory.validationQueryTimeout = 2 osgi.jndi.service.name = jdbc/postgresql osgi.service.blueprint.compname = postgresql pool = dbcp2 pool.blockWhenExhausted = true pool.maxTotal = 10 pool.maxWaitMillis = 2000 pool.minIdle = 2 pool.testOnBorrow = true pool.testWhileIdle = false service.bundleid = 233 service.id = 336 service.scope = bundle Provided by : Bundle 233 Used by: OPS4J Pax JDBC Config (224) karaf@root()> service:list javax.sql.DataSource [javax.sql.DataSource] ---------------------- factory.validationQuery = select schema_name from information_schema.schemata factory.validationQueryTimeout = 2 osgi.jndi.service.name = jdbc/postgresql osgi.service.blueprint.compname = postgresql pax.jdbc.managed = true pax.jdbc.service.id.ref = 336 pool.blockWhenExhausted = true pool.maxTotal = 10 pool.maxWaitMillis = 2000 pool.minIdle = 2 pool.testOnBorrow = true pool.testWhileIdle = false service.bundleid = 224 service.id = 337 service.ranking = 1000 service.scope = singleton Provided by : OPS4J Pax JDBC Config (224) karaf@root()> jdbc:ds-list Name │ Product │ Version │ URL │ Status ────────────────┼────────────┼───────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼─────── jdbc/postgresql │ PostgreSQL │ 10.3 (Debian 10.3-1.pgdg90+1) │ jdbc:postgresql://localhost:5432/reportdb?prepareThreshold=5&preparedStatementCacheQueries=256&preparedStatementCacheSizeMiB=5&databaseMetadataCacheFields=65536&databaseMetadataCacheFieldsMiB=5&defaultRowFetchSize=0&binaryTransfer=true&readOnly=false&binaryTransferEnable=&binaryTransferDisable=&unknownLength=2147483647&logUnclosedConnections=false&disableColumnSanitiser=false&tcpKeepAlive=false&loginTimeout=0&connectTimeout=5&socketTimeout=0&cancelSignalTimeout=10&receiveBufferSize=-1&sendBufferSize=-1&ApplicationName=PostgreSQL JDBC Driver&jaasLogin=true&useSpnego=false&gsslib=auto&sspiServiceClass=POSTGRES&allowEncodingChanges=false¤tSchema=report&targetServerType=any&loadBalanceHosts=false&hostRecheckSeconds=10&preferQueryMode=extended&autosave=never&reWriteBatchedInserts=false │ OK jdbc/postgresql │ PostgreSQL │ 10.3 (Debian 10.3-1.pgdg90+1) │ jdbc:postgresql://localhost:5432/reportdb?prepareThreshold=5&preparedStatementCacheQueries=256&preparedStatementCacheSizeMiB=5&databaseMetadataCacheFields=65536&databaseMetadataCacheFieldsMiB=5&defaultRowFetchSize=0&binaryTransfer=true&readOnly=false&binaryTransferEnable=&binaryTransferDisable=&unknownLength=2147483647&logUnclosedConnections=false&disableColumnSanitiser=false&tcpKeepAlive=false&loginTimeout=0&connectTimeout=5&socketTimeout=0&cancelSignalTimeout=10&receiveBufferSize=-1&sendBufferSize=-1&ApplicationName=PostgreSQL JDBC Driver&jaasLogin=true&useSpnego=false&gsslib=auto&sspiServiceClass=POSTGRES&allowEncodingChanges=false¤tSchema=report&targetServerType=any&loadBalanceHosts=false&hostRecheckSeconds=10&preferQueryMode=extended&autosave=never&reWriteBatchedInserts=false │ OK karaf@root()> jdbc:query jdbc/postgresql 'select * from incident' date │ summary │ name │ details │ id │ email ────────────────────┼────────────┼────────┼───────────────────────────────┼────┼───────────────── 2018-02-20 08:00:00 │ Incident 1 │ User 1 │ This is a report incident 001 │ 1 │ user1@redhat.com 2018-02-20 08:10:00 │ Incident 2 │ User 2 │ This is a report incident 002 │ 2 │ user2@redhat.com 2018-02-20 08:20:00 │ Incident 3 │ User 3 │ This is a report incident 003 │ 3 │ user3@redhat.com 2018-02-20 08:30:00 │ Incident 4 │ User 4 │ This is a report incident 004 │ 4 │ user4@redhat.com
このリストには、jdbc:ds-list 出力からわかるように、元のデータソースとラッパーデータソースという 2 つのデータソースがあります。
javax.sql.XADataSource は Blueprint バンドルから登録され、pool = dbcp2 プロパティーが宣言されています。
javax.sql.DataSource は pax-jdbc-config バンドルから登録されます。また、
-
pool = dbcp2プロパティーがありません (ラッパーデータソースの登録時に削除されました)。 -
service.ranking = 1000プロパティーがあるので、名前でデータソースを検索する場合などに、常に優先されるバージョンになります。 -
pax.jdbc.managed = trueプロパティーがあるので、再度ラップが試行されていません。 -
pax.jdbc.service.id.ref = 336プロパティーがあり、接続プール内でラップされる元のデータソースサービスを示します。
