2.19.2 create-jms-resource
JMSリソースの作成
書式
asadmin [asadmin-options] create-jms-resource [--help] --restype type [--target target] [--enabled={true|false}] [--property name=value[:name=value]...] [--force={false|true}] jndi_name
格納先
Application Serverインストールディレクトリー/javaee/glassfish/bin
機能
create-jms-resourceサブコマンドは、Java Message Service(JMS)コネクションファクトリーリソースまたはJMS送信先リソースを作成します。
このサブコマンドはリモートモードだけサポートします。
asadmin create-jms-resourceコマンドのaddresslistプロパティー(host:mqport,host2:mqport,host3:mqport形式)を指定する場合、\\を使用して : 文字をエスケープします。例えば、host1\\:mqport,host2\\:mqport,host3\\:mqportのようにします。
前提条件
ドメイン管理サーバは、稼働状態である必要があります。
引数
- --help | -?
-
このサブコマンドのヘルプテキストを表示します。
- --restype type
-
JMSリソースのタイプを指定します。
型:String
指定できる値を次に示します。
-
javax.jms.Topic
-
javax.jms.Queue
-
javax.jms.ConnectionFactory
-
javax.jms.TopicConnectionFactory
-
javax.jms.QueueConnectionFactory
デフォルト値:なし
-
- --target target
-
作成するJMSリソースの対象を指定します。
リソースは常にドメイン全体に対して作成されますが、リソースのresource-refは指定した対象に対してだけ作成されるため、リソースがドメインで定義されても、リソースは指定した対象だけで使用できるようになります。複数の対象でリソースを参照する場合は、create-resource-refサブコマンドを使用します。
型:String
指定できる値を次に示します。
-
server
ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。
-
domain
ドメインを対象とします。
-
cluster_name
指定した名称のクラスターを対象とします。
-
instance_name
指定した名称のサーバインスタンスを対象とします。
デフォルト値:server
-
- --enabled={true|false}
-
リソースを実行時に有効にするかどうかを指定します。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:true
-
- --property name=value[:name=value]...
-
JMSリソースの構成時のオプションをプロパティー名と値のペアで指定します。指定形式は、name=valueです。複数指定する場合は、コロン(:)で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。
プロパティー名とvalueに指定できる値を次に示します。
コネクションファクトリーリソースのプロパティー
ClientId=value
永続化サブスクライバーが使用するコネクションファクトリーのクライアントIDを指定します。
型:String
指定できる値を次に示します。
-
JMSリソースのID
デフォルト値:なし
AddressList=value
Message Queueのアドレスのコンマ区切りリストを指定します。アプリケーションが通信する1つまたは複数のメッセージブローカーのインスタンスのホスト名(およびオプションでポート番号)を指定します。
例えば、値にはearthまたはearth:7677を指定できます。メッセージブローカーがデフォルト(7676)以外のポートで動作している場合は、ポート番号を指定します。サーバのJMSサービス構成で定義されたJMSホストから構成されるデフォルト値はlocalhostで、デフォルトのポート番号は7676です。クライアントは、ローカルホストのポート7676のブローカーへの接続を試みます。
型:String
指定できる値を次に示します。
-
コンマで区切られたホスト名およびポート番号
デフォルト値:なし
UserName=value
コネクションファクトリーのユーザー名を指定します。
型:String
指定できる値を次に示します。
-
ユーザー名
デフォルト値:guest
Password=value
コネクションファクトリーのパスワードを指定します。
型:String
指定できる値を次に示します。
-
パスワード
デフォルト値:guest
ReconnectEnabled=value
値をtrueに設定すると、接続が失われたときに、クライアントのランタイムはメッセージサーバ(またはAddressListで指定したアドレスのリスト)への再接続を試みます。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
ReconnectAttempts=value
クライアントのランタイムがリストの次のアドレスを試行する前に、AddressListに指定した各アドレスへの接続(または再接続)を試みる回数。値を-1に設定すると、再接続の試行回数が無制限になります(クライアントのランタイムは、接続が成功するまで最初のアドレスへの接続を試みます)。
型:Integer
指定できる値を次に示します。
-
-1〜2147483647
デフォルト値:6
ReconnectInterval=value
再接続を試みる間隔(ミリ秒単位)を指定します。これは、AddressListで指定した各アドレスでの試行およびリストの連続するアドレスへの再接続に適用されます。間隔が短すぎると、ブローカーが回復できません。また間隔が長すぎると、処理遅延が発生することがあります。
型:Long
指定できる値を次に示します。
-
-1〜9223372036854775807L
デフォルト値:30000(ミリ秒)
AddressListIterations=value
接続を確立(または再確立)するために、クライアントのランタイムがAddressList経由で接続を試みる回数を指定します。値を-1に設定すると、接続回数が無制限になります。コネクターリソースのプロパティーとしてconnector-connection-pool属性を指定できます。
型:Integer
指定できる値を次に示します。
-
-1〜2147483647
デフォルト値:-1
送信先リソースのプロパティー
Name=value
リソースが参照する物理送信先の名称。物理送信先は、送信先リソースを使用するアプリケーションを実行するときに自動的に作成されます。また、create-jmsdestサブコマンドで物理送信先を作成することもできます。このプロパティーを指定しない場合、JMSサービスは送信先リソースと同じ名称で物理送信先を作成します(JNDI名のスラッシュはアンダースコアに置換されます)。
型:String
指定できる値を次に示します。
-
物理送信先の名称
デフォルト値:_ replacing /を含む送信先リソースのJNDI名
Description=value
物理送信先の説明を記述します。
型:String
指定できる値を次に示します。
-
物理送信先の説明
デフォルト値:なし
-
- --force={false|true}
-
このサブコマンドが既存の同名のJMSリソースを上書きするかどうかを指定します。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
-
- jndi_name
-
作成するJMSリソースのJNDI名を指定します。
型:String
指定できる値を次に示します。
-
JNDI名
デフォルト値:なし
-
使用例
次の例では、instance1という名称のサーバインスタンスに、JNDI名がjms/DurableConnectionFactorytypeである型javax.jms.ConnectionFactoryのコネクションファクトリーリソースを作成します。
ClientIdプロパティーは、クライアントIDをコネクションファクトリー上に設定し、コネクションファクトリーが持続性のあるサブスクリプションに使用できるようにします。JMSリソースのJNDI名は、習慣的に、jms/ネーミングサブコンテキストを含んでいます。
asadmin create-jms-resource --restype javax.jms.ConnectionFactory --target instance1 --property ClientId=MyID jms/DurableConnectionFactory
戻り値
戻り値 |
説明 |
---|---|
0 |
サブコマンドの実行に成功しました。 |
1 |
サブコマンドの実行中にエラーが発生しました。 |