2.19.3 create-jmsdest
JMSの物理送信先の作成
書式
asadmin [asadmin-options] create-jmsdest [--help] --desttype dest_type [--property name=value[:name=value]...] [--target target] [--force={false|true}] dest_name
格納先
Application Serverインストールディレクトリー/javaee/glassfish/bin
機能
create-jmsdestサブコマンドはJMSの物理送信先を作成します。
このサブコマンドはリモートモードだけサポートします。
create-jms-resourceサブコマンドを使用しても、Nameプロパティーに物理送信先が指定された JMS送信先リソースを作成できます。 この物理送信先は、ユーザーが送信先リソースを使用するアプリケーションを実行するときに自動的に作成されます。プロパティーにデフォルト値がない物理送信先を作成するには、create-jmsdestサブコマンドを使用します。
前提条件
ドメイン管理サーバは、稼働状態である必要があります。
引数
- --help | -?
-
このサブコマンドのヘルプテキストを表示します。
- --desttype dest_type
-
JMS送信先の種類を指定します。
型:String
指定できる値を次に示します。
-
topic
-
queue
デフォルト値:なし
-
- --property name=value[:name=value]...
-
物理送信先を構成するためのプロパティー名と値のペアを指定します。指定形式は、name=valueです。複数指定する場合は、コロン(:)で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。
これらのプロパティーの値を変更するには、Application Serverインストールディレクトリー/javaee/glassfish/mq/bin/imqcmdコマンドを使用できます。
プロパティー名とvalueに指定できる値を次に示します。
MaxNumMsgs=value
送信先で格納できる未配信メッセージの最大数を選択できます。値に-1を指定すると、メッセージの数は制限されません。limitBehaviorプロパティーがFLOW_CONTROLに設定されている場合、ブローカーはメッセージの受信処理をすぐに停止できないため、指定されたメッセージ制限を超過することがあります。
型:Integer
指定できる値を次に示します。
-
-1〜2147483647
デフォルト値:デッドメッセージキューの場合は、1000。その他の場合は、-1。
MaxBytesPerMsg=value
単一メッセージの最大サイズ(バイト単位)を指定します。永続メッセージが拒否されると、メッセージを生成しているクライアントに例外が報告されます。非永続メッセージの場合、例外はクライアントに報告されません。
値は、次のサフィックスを使用して、バイト単位、キロバイト単位、またはメガバイト単位で指定することができます。サフィックスのない値はバイト単位になります。値に-1を設定した場合、メッセージのサイズは制限されません。
-
b:バイト
-
k:キロバイト(1024バイト)
-
m:メガバイト(1024 x 1024 = 1,048,576バイト)
型:Integer
指定できる値を次に示します。
-
-1〜2147483647
デフォルト値:-1
MaxTotalMsgBytes=value
未配信メッセージの最大合計サイズ(バイト単位)を指定します。構文はmaxBytesPerMsgの場合と同じです。
型:Integer
指定できる値を次に示します。
-
-1〜2147483647
デフォルト値:デッドメッセージキューの場合は、10000000。その他の場合は、-1
LimitBehavior=value
メモリー制限のしきい値に達したときのブローカーの動作を指定します。
型:String
指定できる値を次に示します。
-
REJECT_NEWEST
最新のメッセージを拒否し、メッセージを保持する場合だけ、メッセージを生成しているクライアントに例外を通知します。
-
FLOW_CONTROL
メッセージプロデューサーがメッセージを送信する頻度を下げます。
-
REMOVE_OLDEST
最も古いメッセージを廃棄します。
-
REMOVE_LOW_PRIORITY
優先度が最も低いメッセージを、メッセージを生成しているクライアントに通知することなく、古さに応じて削除します。
値がREMOVE_OLDESTまたはREMOVE_LOW_PRIORITYに設定され、さらにuseDMQプロパティーがtrueに設定されている場合は、制限を超えたメッセージはデッドメッセージキューに移動されます。
デッドメッセージキュー自体では、デフォルトの制限動作はREMOVE_OLDESTであり、値にFLOW_CONTROLは設定できません。
デフォルト値:REJECT_NEWEST
MaxNumProducers=value
送信先のメッセージプロデューサーの最大数を指定します。この制限に達すると、新しいプロデューサーを作成できなくなります。値に-1を指定すると、プロデューサーの数は制限されません。デフォルト値は100です。このプロパティーはデッドメッセージキューには適用されません。
型:Integer
指定できる値を次に示します。
-
-1および1〜2147483647
デフォルト値:100
ConsumerFlowLimit=value
単一のバッチでコンシューマーに配信できるメッセージの最大数を指定します。値に-1を指定すると、メッセージの数は制限されません。デフォルト値は1000です。クライアントのランタイムは、より小さい値をコネクションファクトリーオブジェクトに指定することで、この制限を上書きできます。
キュー送信でロードバランスを使用する場合、この値はロードバランスが始まる前に、キューにあるアクティブなコンシューマー宛てメッセージの初期数です。
型:Integer
指定できる値を次に示します。
-
-1〜2147483647
デフォルト値:1000
UseDMQ=value
trueに設定した場合、デッドメッセージはデッドメッセージキューに移動します。falseに設定した場合、デッドメッセージは破棄されます。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:true
ValidateXMLSchemaEnabled=value
trueに設定した場合、送信先に対するXMLスキーマ検証が有効になります。
XML検証が有効になっている場合、MessageQueueクライアントのランタイムは、XMLメッセージをブローカーに送信する前に、指定されたXSD(XSDが指定されていない場合はDTD)に対するメッセージの妥当性の検証を試みます。指定したスキーマが見つからないかメッセージを検証できない場合、メッセージは送信されないで例外がスローされます。
このプロパティーは、送信先が非アクティブである、つまりコンシューマーまたはプロデューサーがない場合、および送信先にメッセージが存在しない場合に設定するようにしてください。それ以外の場合は、プロデューサーが再接続する必要があります。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
XMLSchemaURIList=value
XMLスキーマ定義ファイルURI文字列の空白区切りのリストを指定します。validateXMLSchemaEnabledがtrueに設定されている場合、URLはXMLスキーマ検証に使用するために1つ以上のXSDの場所を指します。
複数のURIを指定する場合は、次の例に示すように、この値をダブルクォーテーションで囲みます。
"http://foo/flap.xsd http://test.com/test.xsd"
このプロパティーが設定されていないか、またはnullの場合にXML検証が有効になっていると、XMLドキュメント内で指定されたDTDを使用してXML検証が実行されます。
アプリケーションの要件が変更された結果XSDが変更された場合は、変更後のXSDに基づいてXMLメッセージを生成するすべてのクライアントアプリケーションをブローカーに再接続する必要があります。
型:String
指定できる値を次に示します。
-
スペースで区切られたXSDのURI文字列のリスト
デフォルト値:null
-
- --target target
-
作成するJMSの物理送信先の対象を指定します。
create-jmsdestサブコマンドは各リソースに関連付けられていますが、物理送信先は、構成の一部のJMSサービス(ブローカー)を使用して作成されます。
型:String
指定できる値を次に示します。
-
server
ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。
-
configuration_name
指定した名称の構成を対象とします。
-
cluster_name
指定した名称のクラスターを対象とします。
-
instance_name
指定した名称のサーバインスタンスを対象とします。
デフォルト値:server
-
- --force={false|true}
-
同じ名称のJMS物理送信先が存在する場合に、このサブコマンドで上書きするかどうかを指定します。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
-
- dest_name
-
作成対象であるJMS送信先の一意の識別子を指定します。
型:String
指定できる値を次に示します。
-
物理送信先の名称
デフォルト値:なし
-
使用例
次の例では、instance1という名称のサーバインスタンスに、デフォルト値以外のプロパティー値を持つ、PhysicalQueueという名称のJMS物理キューを作成します。
asadmin create-jmsdest --target instance1 --desttype queue --property maxNumMsgs=1000:maxBytesPerMsg=5k PhysicalQueue
戻り値
戻り値 |
説明 |
---|---|
0 |
サブコマンドの実行に成功しました。 |
1 |
サブコマンドの実行中にエラーが発生しました。 |