第13章 Agroal でのデータソース管理

以下の手順に従うと、管理 CLI を使用して JDBC ドライバーをコアモジュールとしてインストールすることができます。

次に、アプリケーションデータソースによって参照されるよう、JDBC ドライバーとして登録する必要があります。

ドライバーが コアモジュールとしてインストール されたら、以下の管理 CLI コマンドを使用して JDBC ドライバーとして登録する必要があります。管理対象ドメインを実行している場合は、コマンドの前に /profile=PROFILE_NAME を付けてください。

/subsystem=datasources-agroal/driver=DRIVER_NAME:add(module=MODULE_NAME,class=CLASS_NAME)

CLASS_NAME は、非 XA データソースの場合は java.sql.Driver または javax.sql.DataSource、XA データソースの場合は javax.sql.XADataSource を実装する完全修飾クラス名である必要があります。

以下の管理 CLI コマンドは Agroal データソースを作成します。管理対象ドメインを実行している場合は、コマンドの前に /profile=PROFILE_NAME を付けてください。

/subsystem=datasources-agroal/datasource=DATASOURCE_NAME:add(jndi-name=JNDI_NAME,connection-factory={driver=DRIVER_NAME,url=URL},connection-pool={max-size=MAX_POOL_SIZE})

利用できる Agroal データソース属性の完全リストは、「Agroal データソース属性」を参照してください。

Agroal データソース設定の例は、「MySQL Agroal データソースの例」を参照してください。

以下の管理 CLI コマンドは Agroal データソースを削除します。管理対象ドメインを実行している場合は、コマンドの前に /profile=PROFILE_NAME を付けてください。

/subsystem=datasources-agroal/datasource=DATASOURCE_NAME:remove

以下の管理 CLI コマンドは Agroal XA データソースを作成します。管理対象ドメインを実行している場合は、コマンドの前に /profile=PROFILE_NAME を付けてください。

/subsystem=datasources-agroal/xa-datasource=XA_DATASOURCE_NAME:add(jndi-name=JNDI_NAME,connection-factory={driver=DRIVER_NAME,connection-properties={ServerName=HOST_NAME,PortNumber=PORT,DatabaseName=DATABASE_NAME}},connection-pool={max-size=MAX_POOL_SIZE})

利用できる Agroal データソース属性の完全リストは、「Agroal データソース属性」を参照してください。

Agroal XA データソース設定の例は、「MySQL Agroal XA データソースの例」を参照してください。

以下の管理 CLI コマンドは Agroal XA データソースを削除します。管理対象ドメインを実行している場合は、コマンドの前に /profile=PROFILE_NAME を付けてください。

/subsystem=datasources-agroal/xa-datasource=DATASOURCE_NAME:remove

以下は、接続設定および基本のセキュリティー設定が含まれる、MySQL Agroal データソースの設定例になります。

例: MySQL Agroal データソース設定

<subsystem xmlns="urn:jboss:domain:datasources-agroal:1.0">
    <datasource name="ExampleAgroalDS" jndi-name="java:jboss/datasources/ExampleAgroalDS">
        <connection-factory driver="mysql" url="jdbc:mysql://localhost:3306/jbossdb" username="admin" password="admin"/>
        <connection-pool max-size="30"/>
    </datasource>
    <drivers>
        <driver name="mysql" module="com.mysql" class="com.mysql.cj.jdbc.Driver"/>
    </drivers>
</subsystem>

例: MySQL JDBC ドライバー module.xml ファイル

<?xml version='1.0' encoding='UTF-8'?>

<module xmlns="urn:jboss:module:1.1" name="com.mysql">

    <resources>
        <resource-root path="mysql-connector-java-8.0.12.jar"/>
    </resources>

    <dependencies>
        <module name="javax.api"/>
        <module name="javax.transaction.api"/>
    </dependencies>
</module>

管理 CLI コマンドの例

以下の管理 CLI コマンドを使用すると、この設定例を実現できます。

以下は、XA データソースプロパティーおよび基本のセキュリティー設定が含まれる、MySQL Agroal XA データソースの設定例になります。

例: MySQL Agroal XA データソース設定

<subsystem xmlns="urn:jboss:domain:datasources-agroal:1.0">
    <xa-datasource name="ExampleAgroalXADS" jndi-name="java:jboss/datasources/ExampleAgroalXADS">
        <connection-factory driver="mysqlXA" username="admin" password="admin">
            <connection-properties>
                <property name="ServerName" value="localhost"/>
                <property name="PortNumber" value="3306"/>
                <property name="DatabaseName" value="jbossdb"/>
            </connection-properties>
        </connection-factory>
        <connection-pool max-size="30"/>
    </xa-datasource>
    <drivers>
        <driver name="mysqlXA" module="com.mysql" class="com.mysql.cj.jdbc.MysqlXADataSource"/>
    </drivers>
</subsystem>

例: MySQL JDBC ドライバー module.xml ファイル

<?xml version='1.0' encoding='UTF-8'?>

<module xmlns="urn:jboss:module:1.1" name="com.mysql">

    <resources>
        <resource-root path="mysql-connector-java-8.0.12.jar"/>
    </resources>

    <dependencies>
        <module name="javax.api"/>
        <module name="javax.transaction.api"/>
    </dependencies>
</module>

管理 CLI コマンドの例

以下の管理 CLI コマンドを使用すると、この設定例を実現できます。