設定ファイル

java -jar hccommand.jar -cmd コマンド種別 -config 設定ファイル ...

(1) 記述形式

設定ファイルはXML形式です。文字コードはUTF-8で記述してください。

設定ファイルは、以下のようにすべてのコマンドに共通の項目と、各コマンドに固有の項目に分かれています。

<common>～</common>の部分は必須ですが、<specific>～</specific>内の各コマンドに固有の部分は、使用するコマンドの記載だけでかまいません。たとえばアップロードコマンドだけで使用する設定ファイルは、以下の部分だけ記述すれば動作します。

<webft>
  <common>
    ...
  </common>
  <specific>
    <info_upload>
      ...
    </info_upload>
  </specific>
</webft>

個々の項目が省略可能かどうかは、共通項目および各コマンドの説明を参照してください。

(2) 共通項目

すべてのコマンドに共通の項目は、以下の形式で記述します。

  ...
  <common>
    <info_connection>
      <server_url>接続先サーバURL</server_url>
      <info_proxy>
        <proxy_server>プロキシサーバ</proxy_server>
        <proxy_port>プロキシポート番号</proxy_port>
        <proxy_connection_id>プロキシ接続ID</proxy_connection_id>
        <proxy_connection_passwd>プロキシ接続パスワード</proxy_connection_passwd>
      </info_proxy>
      <request_timeout>リクエストタイムアウト</request_timeout>
      <connection_retry_count>接続リトライ回数</connection_retry_count>
      <connection_retry_interval>接続リトライ間隔</connection_retry_interval>
    </info_connection>
    <info_login>
      <group_id>グループID</group_id>
      <user_id>ユーザID</user_id>
      <passwd>パスワード</passwd>
      <login_type>ログイン方法</login_type>
    </info_login>
    <info_language>
      <language_type>言語種別</language_type>
    </info_language>
  </common>
  ...

共通項目の詳細は以下のとおりです。

表2.4 設定ファイルの共通項目

タグ名（設定項目名）	用途	省略	省略時値
server_url	接続先サーバのURL 接続先のHULFT-WebFileTransfer のサーバのURL 255バイト以内の半角文字で指定します。	×	―
info_proxy	プロキシサーバの情報を指定するタグ	*1
proxy_server	プロキシサーバ 経由するプロキシサーバのホスト名 255バイト以内の半角文字で指定します。	*1	ブランク
proxy_port	プロキシボート番号 経由するプロキシサーバのポート番号 設定値：1～65535	*1	ブランク
proxy_connection_id	プロキシ接続ID 経由するプロキシサーバの接続ID 255バイト以内の半角文字で指定します。	*1	ブランク
proxy_connection_passwd	プロキシ接続パスワード 経由するプロキシサーバのパスワード 255バイト以内の半角文字で指定します。	*1	ブランク
request_timeout	リクエストタイムアウト（単位：秒） コマンドクライアントからリクエストを送信した際のタイムアウト時間（*2） 0 タイムアウトしない 1～3600 指定した時間経過後にリクエストタイムアウトエラーとなる	○	0
connection_retry_count	接続リトライ回数 Login APIが失敗した場合のリトライ回数 0～10 指定した回数だけリトライする	○	0
connection_retry_interval	接続リトライ時間（単位：秒） Login APIが失敗した場合のリトライ間隔 0～3600 指定した時間経過後にリトライする	○
info_login	ログイン情報を指定するタグ	×	―
group_id	グループID（*3） HULFT-WebFileTransferにログインするためのグループID	*4	―
user_id	ユーザID（*3） HULFT-WebFileTransferにログインするためのユーザID	*4	―
passwd	パスワード（*3） HULFT-WebFileTransferにログインするためのパスワード	*4	―
login_type	ログイン方法 0 ID／パスワード 1 クライアント証明書 2 ID／パスワード+クライアント証明書	○	0
info_language	言語種別を指定するタグ	○	*5
language_type	言語種別 0 日本語 1 英語 2 中国語	○	*5

*1	:	info_proxyを指定した場合、プロキシサーバの各項目の省略可否は以下のようになります。   proxy_server proxy_port proxy_connection_id proxy_connection_passwd proxy_server指定時 ― 省略不可 省略可 省略可 proxy_port指定時 省略不可 ― 省略可 省略可 proxy_connection_id 指定時 省略不可 省略不可 ― 省略可 proxy_connection_passwd 指定時 省略不可 省略不可 省略不可 ―
*2	:	当該設定ファイルを指定して実行されたコマンドのすべてのリクエストに適用されます。
*3	:	コマンドの実行に必要な権限を持つユーザのグループID、ユーザID、パスワードを指定します。 設定値はLogin APIのリクエストパラメータに従います。詳細は「HULFT-WebFileTransfer Web API 説明書」を参照してください。
*4	:	login_type（ログイン方法）が“0”（ID／パスワード）または“2”（ID／パスワード+クライアント証明書）の場合は省略不可です。 login_type（ログイン方法）が“1”（クライアント証明書）の場合は設定不可です。
*5	:	コマンドクライアントの実行環境が日本語の場合は0、英語の場合は1、中国語の場合は2となります。