2.8.16 set-web-context-param
WebアプリケーションまたはモジュールのServletContext初期化パラメーターの設定
書式
asadmin [asadmin-options] set-web-context-param [--help] --name=context-param-name {--value=value|--ignoredescriptoritem={false|true}} [--description description] application-name[/module]
格納先
Application Serverインストールディレクトリー/javaee/glassfish/bin
機能
set-web-context-paramサブコマンドは、次のどちらかの項目のServletContext初期化パラメーターを設定します。
-
デプロイ済みのWebアプリケーション
-
デプロイ済みのJava EEアプリケーション内のWebモジュール
このサブコマンドによって、デプロイ済みのアプリケーションのDDを変更したり、アプリケーションを再パッケージおよびリデプロイしたりすることなく、アプリケーションの設定を変更できます。
デプロイ済みのアプリケーションのServletContext初期化パラメーターを設定した場合、ドメイン管理サーバまたはサーバインスタンスを再起動する必要があります。
このサブコマンドはリモートモードだけサポートします。
前提条件
ドメイン管理サーバは、稼働状態である必要があります。
アプリケーションがデプロイされている必要があります。
ファイル
モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。
引数
- --help | -?
-
このサブコマンドのヘルプテキストを表示します。
- --name=context-param-name
-
設定するServletContext初期化パラメーターの名称を指定します。
型:String
指定できる値を次に示します。
-
パラメーター名
デフォルト値:なし
-
- --value=value
-
ServletContext初期化パラメーターに設定する値を指定します。
--valueオプションまたは--ignoredescriptoritemオプションを設定する必要があります。
型:String
指定できる値を次に示します。
-
パラメーター値
デフォルト値:なし
-
- --ignoredescriptoritem={false|true}
-
ServletContext初期化パラメーターがアプリケーションのDDに設定されている場合、そのパラメーターを無視するかどうかを指定します。パラメーターを無視する場合、アプリケーションはDDにパラメーターが設定されたことがないかのように動作します。この状況でのアプリケーションの動作は、アプリケーションによって異なります。
型:Boolean
指定できる値を次に示します。
-
false
値は無視されません。
-
true
値は無視されます。--valueオプションまたは--ignoredescriptoritemオプションを設定する必要があります。
set-web-context-paramサブコマンドで以前に設定したServletContext初期化パラメーターの設定を取り消す場合、--ignoredescriptoritemオプションを使用しないでください。代わりにunset-web-context-paramサブコマンドを使用してください。
デフォルト値:false
-
- --description description
-
設定するコンテキストパラメーターの説明となるテキストを指定します。
型:String
指定できる値を次に示します。
-
環境エントリーの説明
デフォルト値:なし
-
- application-name
-
アプリケーションの名称を指定します。この名称は、list-applicationsサブコマンドで取得できます。
型:String
指定できる値を次に示します。
-
アプリケーション名
デフォルト値:なし
-
- module
-
アプリケーションのEARファイル内のモジュールへの相対パスを指定します。モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。moduleは、ServletContext初期化パラメーターをJava EEアプリケーションのWebモジュールに適用する場合にだけ必要です。モジュールは、myApp/myWebModule.warの形式で指定します。
モジュールは、application-nameの後にスラッシュ(/)で区切って指定する必要があります。
型:String
指定できる値を次に示します。
-
アプリケーション内のモジュール名
デフォルト値:なし
-
使用例
次の例では、Webアプリケーションbasic-ezcompのServletContext初期化パラメーターjavax.faces.STATE_SAVING_METHODをclientに設定します。このパラメーターには、「The location where the application's state is preserved」という説明が設定されています。
asadmin set-web-context-param --name=javax.faces.STATE_SAVING_METHOD --description "The location where the application's state is preserved" --value=client basic-ezcomp
戻り値
戻り値 |
説明 |
---|---|
0 |
サブコマンドの実行に成功しました。 |
1 |
サブコマンドの実行中にエラーが発生しました。 |