8.3.6 コマンドプロパティファイル(property.xml)
利用者のユーザID/パスワードなどの情報を記述したXMLファイルです。コマンドの実行時引数として指定します。パスワードはそのままの文字列で記述しますので,アクセス権を設定するなど適切なセキュリティを設定してください。コマンドプロパティファイルの仕様を次に示します。
項番 |
項目 |
形式または値 |
---|---|---|
1 |
ファイル形式 |
XML形式 |
2 |
文字コード |
UTF-8 |
3 |
改行コード |
CR+LF |
コマンドプロパティファイルは次の形式で記述します。
<?xml version="1.0" encoding="utf-8" ?> <property> <serverUrl>値</serverUrl> <userId>値</userId> <password>値</password> <authenticationMethod>値</authenticationMethod> <certificatePath>値</certficatePath> <certificatePassword>値</certificatePassword> <useProxy>値</useProxy> <proxyHost>値</proxyHost> <proxyPort>値</proxyPort> <proxyId>値</proxyId> <proxyPassword>値</proxyPassword> </property >
それぞれの設定項目について,以下に示します。
項番 |
設定項目 |
要素名 |
説明 |
初期設定値 |
---|---|---|---|---|
1 |
接続先サーバのURL |
serverUrl |
接続先サーバのURLを指定します。 (例)https://jp1dh. hitachi.co.jp/ |
なし |
2 |
ユーザID |
userId |
接続先サーバへのログインユーザIDを指定します。 「標準パスワード認証」の場合は必ず指定する必要があります。 (例)user@company |
なし |
3 |
ユーザパスワード |
password |
接続先サーバへのログインユーザパスワードを,文字列※で指定します。 「標準パスワード認証」の場合は必ず指定する必要があります。 なお,パスワードに「text:HEX」で始まる文字列は指定できません。 (例)password |
なし |
4 |
認証方式 |
authenticationMethod |
認証方式を指定します。省略した場合は標準パスワード認証で動作します。
|
PASSWORD |
5 |
証明書ファイルのパス |
certificatePath |
証明書ファイルのパスを絶対パス形式で指定します。 認証方式に「標準パスワード認証」を使用する場合は,指定を省略できます。「電子証明書認証」を使用する場合は,必ず指定する必要があります。 |
なし |
6 |
証明書ファイルのパスワード |
certificatePassword |
証明書ファイルのパスワードを指定します。 認証方式に「標準パスワード認証」を使用する場合は,指定を省略できます。「電子証明書認証」を使用する場合は,必ず指定する必要があります。 |
なし |
7 |
プロキシ使用フラグ |
useProxy |
プロキシサーバを使用するかどうかを指定します。
大文字・小文字は区別しません。指定できる値以外を指定した場合は,エラーとなります。 (例)true |
false |
8 |
プロキシサーバホスト名 |
proxyHost |
プロキシサーバのホスト名またはIPアドレスを指定します。 (例1)Proxyserver (例2)192.168.0.1 |
なし |
9 |
プロキシサーバポート番号 |
proxyPort |
プロキシサーバのポート番号を指定します。0〜65535の範囲で指定できます。 (例)3128 |
なし |
10 |
プロキシ認証ID |
proxyId |
プロキシサーバの認証IDを指定します。 (例)user |
なし |
11 |
プロキシ認証パスワード |
proxyPassword |
プロキシサーバの認証パスワードを指定します。 (例)password |
なし |
- 注※
-
入力できる文字数,文字の種類は,認証ルールで設定された文字数以内の半角英数字と記号です。
使用できる記号は「!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~」です。
値は,XMLの入力規則に従って入力してください。特に,XMLにおける特殊な記号を使う際はご注意ください。次の文字を使用する場合は,エンティティ参照(エスケープ文字)に置き換えるか,CDATAセクションを利用してください。
項番 |
文字 |
エンティティ参照による表記 |
---|---|---|
1 |
< |
< |
2 |
> |
> |
3 |
& |
& |
4 |
" |
" |
5 |
' |
' |
なお,改行などの制御文字は,XMLの規格に従ったエンティティで表示される場合があります。XMLの属性の出現順は,XMLの規約に従い順序性を持ちません。
日時を表すデータはISO8601:2004に基づいたW3C-DTF形式である「YYYY-MM-DDThh:mm:ssTDZ」で表現されます。タイムゾーン(TDZ)は,OSのタイムゾーンに応じたオフセット時間となります。日本の場合は+09:00です。
設定例を次に示します。
<?xml version="1.0" encoding="utf-8" ?> <property> <serverUrl>https://jp1dh. hitachi.co.jp/</serverUrl> <userId>user@company</userId> <password>password</password> <authenticationMethod>PASSWORD</authenticationMethod> : : <useProxy>true</useProxy> <proxyHost>proxyserver</proxyHost> <proxyPort>8080</proxyPort> <proxyId>proxyid</proxyId> <proxyPassword>proxypassword</proxyPassword> </property >