2.8.17　set-web-env-entry

書式

asadmin [asadmin-options] set-web-env-entry [--help]
    --name=env-entry-name --type=env-entry-type
    {--value=value|--ignoredescriptoritem={true|false}}
    [--description description] application-name[/module]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

set-web-env-entryサブコマンドは、次のどちらかの項目の環境エントリーを設定します。

• デプロイ済みのWebアプリケーション

• デプロイ済みのJava EEアプリケーション内のWebモジュール

このサブコマンドによって、デプロイ済みのアプリケーションのDDを変更したり、アプリケーションを再パッケージおよびリデプロイしたりすることなく、アプリケーションの設定を変更できます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

アプリケーションがデプロイされている必要があります。

ファイル

モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--name=env-entry-name

設定する環境エントリーの名称を指定します。この名称はjava:comp/envコンテキストに相対するJNDI名です。この名称はデプロイ機能内で一意でなければなりません。

型：String

指定できる値を次に示します。

• 環境エントリー名

デフォルト値：なし

--type=env-entry-type

アプリケーションのコードが求める環境エントリー値の完全修飾Javaタイプを指定します。

型：String

指定できる値を次に示します。

• java.lang.Boolean

• java.lang.Byte

• java.lang.Character

• java.lang.Double

• java.lang.Float

• java.lang.Integer

• java.lang.Long

• java.lang.Short

• java.lang.String

デフォルト値：なし

--value=value

環境エントリーに設定する値を指定します。

--typeがjava.lang.Characterの場合、値は1文字でなければなりません。そうでない場合は、指定したタイプのコンストラクターに有効な文字列でなければなりません。

--valueオプションまたは--ignoredescriptoritemオプションを設定する必要があります。

型：String

指定できる値を次に示します。

• 環境エントリー値

デフォルト値：なし

--ignoredescriptoritem={true|false}

環境エントリーがアプリケーションのDDに設定されている場合、そのエントリーを無視するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

• false

  値は無視されません。

• true

  値は無視されます。--valueオプションまたは--ignoredescriptoritemオプションを設定する必要があります。

set-web-env-entryサブコマンドで以前に設定した環境エントリーの設定を取り消す場合、--ignoredescriptoritemオプションを使用しないでください。その用途では、代わりにunset-web-env-entryサブコマンドを使用してください。

デフォルト値：false

--description description

設定する環境エントリーの説明となるテキストを指定します。

型：String

指定できる値を次に示します。

• パラメーターの説明

デフォルト値：なし

application-name

アプリケーションの名称を指定します。この名称は、list-applicationsサブコマンドで取得できます。

型：String

指定できる値を次に示します。

• アプリケーション名

デフォルト値：なし

module

アプリケーションのEARファイル内のモジュールへの相対パスを指定します。モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。moduleは、環境エントリーをJava EEアプリケーションのWebモジュールに適用する場合にだけ必要です。モジュールはmyApp/myWebModule.warの形式で指定します。

モジュールは、application-nameの後にスラッシュ（/）で区切って指定する必要があります。

型：String

指定できる値を次に示します。

• アプリケーション内のモジュール名

デフォルト値：なし

asadmin set-web-env-entry --name="Hello User" 
--type=java.lang.String --value=techscribe 
--description "User authentication for Hello application" hello

戻り値

戻り値	説明
0	サブコマンドの実行に成功しました。
1	サブコマンドの実行中にエラーが発生しました。