IRemoteHostConnectorクラス

putFileメソッド

リモートホストへファイルを転送するメソッドです。転送したファイルは常に上書きされます。このメソッドは,処理が終了するかタイムアウトするまで同期実行します。同一のリモートホストに対して,このメソッドおよびほかのメソッドを同時に複数実行した場合,先に受け付けられたメソッドが終了するまで実行は待機します。

表3-23 各プロトコルにおける転送時の仕様

項番項目DCOM(Windows)SSH(Linux)
1転送したファイルおよびフォルダに付けられるアクセス権限転送先のディレクトリの権限が継承されます。744(rwxr--r--)が付けられます。
2転送したファイルおよびフォルダの日付フォルダの日付が転送時の日付に更新されます。ファイルの日付は,作成日時,アクセス日時が更新されます。ファイル,ディレクトリともに日付が更新されます。
3ショートカットファイルの転送ショートカットファイル単体の転送はできません。ただし,フォルダに格納されたショートカットファイルを転送することはできます。その場合,ショートカットファイルが示す実体ファイルではなく,ショートカットファイル自体が転送されます。ショートカットファイルの転送はできません。
転送した場合,エラーになります。
4隠しファイルおよびフォルダの転送Windowsの隠しファイルおよびフォルダの転送はできます。ファイルの場合だけ隠し属性は維持されます。
Linuxの,先頭が「.」(ピリオド)の隠しファイルおよびフォルダは,転送できません。転送した場合,処理に失敗します。
Windowsの隠しファイルおよびフォルダの転送はできます。ただし,隠しファイル属性は消滅します。
Linuxの,先頭が「.」(ピリオド)の隠しファイルおよびディレクトリは,転送できます。

形式

public void putFile(String src, String dest)

入力

表3-24 入力項目一覧

項番引数名:型引数の意味制限
1src :String転送元ファイル/フォルダパス
  • 絶対パスを指定します。
  • 247文字以内で指定します。※1※3
  • null指定はできません。
  • ドライブだけ(C:¥など)の指定はできません。
2dest :String転送先フォルダパス
  • 絶対パスを指定します。
  • 転送後のファイルおよびフォルダのパスを247文字以内で指定します。 ※1※2
  • null指定はできません。
注※1
英数字,_(半角下線),.(半角ピリオド),△(半角空白),( (半角左括弧),) (半角右括弧),パス区切りの¥¥(半角円マーク2つ)(Windowsの場合),/(スラッシュ)(Linuxの場合)が使用できます。¥¥..¥¥ および ¥¥.¥¥,*(アスタリスク),ネットワークドライブの指定,UNC形式のパス,ピリオドまたはスペースで終端するディレクトリを含めてはなりません(プログラムガードはされません)。
注※2
転送先がWindowsの場合,パスにリモートホスト上の環境変数を含めることもできます。環境変数は,リモートホストへログインしたユーザの環境変数が適用されます。環境変数を使用する場合,%(パーセント)文字が使用できます。ただし,環境変数の展開後のパスの長さが247文字を超えないようにしてください。超えた場合は,転送に失敗します。
注※3
パスにWindowsおよびMS-DOSの予約語を含めてはなりません。含めた場合,処理に失敗します。予約語については,「表1-8 コマンド形式の構文要素」を参照してください。

出力

入力「転送先フォルダパス」で指定したリモートホスト上のディレクトリの下に,入力「転送元ファイル/フォルダパス」で指定したファイルおよびフォルダがコピーされます。転送先のフォルダが存在しない場合は,自動で作成されます。

例外

表3-25 エラーケース一覧

項番Exception発生理由
(原因コード)
発生後の動作対象リモートホスト
(Linux/Windows)
1CsdUocRemoteExecuteAssertionFailedExceptionP_RemoCon.001処理を中断し,リターンします。共通
P_RemoCon.002
2CsdUocRemoteExecuteIOExceptionP_LinSSH.001処理を中断し,リターンします。Linux
P_WinCOM.001Windows
P_WinCOM.002
P_WinCOM.004
P_WinCOM.005
P_WinCOM.006
P_WinCOM.007
P_WinCOM.008
P_WinCOM.010
P_WinCOM.011
P_WinCOM.013
P_WinCOM.014
P_WinCOM.016
P_WinCOM.017
P_WinCOM.019
P_WinCOM.022
P_WinCOM.024
P_WinCOM.026
P_WinCOM.027
P_WinCOM.029
P_WinCOM.030
P_WinCOM.037
P_WinCOM.038
P_WinCOM.039
P_WinCOM.040
P_WinCOM.041
P_WinCOM.042
P_RemoCon.005
3CsdUocRemoteExecuteTimeoutExceptionP_LinSSH.002処理を中断し,リターンします。Linux
P_WinCOM.028Windows

注 対処方法については,マニュアル「uCosminexus Service Director メッセージ」の「ファイル転送とコマンドのリモート実行時に出力するメッセージの原因コード」を参照してください。


注意事項

同一リモートホストに対して複数のIPアドレスが設定されている場合,異なるIPアドレスを指定して,このメソッドを複数同時実行すると,処理が失敗することがあります。

getFileメソッド

リモートホストからファイルを取得するメソッドです。転送したファイルは常に上書きされます。このメソッドは,処理が終了するかタイムアウトするまで同期実行します。同一のリモートホストに対して,このメソッドおよびほかのメソッドを同時に複数実行した場合,先に受け付けられたメソッドが終了するまで実行は待機します。

表3-26 各プロトコルにおける取得時の仕様

項番項目DCOM(Windows)SSH(Linux)
1取得したファイル/フォルダに付けられるアクセス権限取得先のディレクトリの権限が継承されます。取得先のディレクトリの権限が継承されます。
2転送したファイル/フォルダの日付更新フォルダの日付が取得時の日付に更新されます。ファイルの日付は,作成日時,アクセス日時が更新されます。ファイル,ディレクトリともに日付が更新されます。
3ショートカットファイル(Windowsの場合),シンボリックリンク・ハードリンク(Linuxの場合)の転送ショートカットファイル単体の取得はできません。ただし,フォルダに格納されたショートカットファイルを転送することはできます。その場合,ショートカットファイルが示す実体ファイルではなく,ショートカットファイル自体が転送されます。シンボリックリンク・ハードリンクの取得ができます。どちらもリンク先の実体が取得されます。
4隠しファイルおよびフォルダの取得Windowsの隠しファイルおよびフォルダの取得はできます。ファイルの場合だけ隠し属性は維持されます。
Linuxの,先頭が「.」(ピリオド)の隠しファイルおよびフォルダは,取得できません。取得を試みた場合,処理に失敗します。
Windowsの隠しファイルおよびフォルダの取得はできます。ただし,隠しファイル属性は消滅します。
Linuxの,先頭が「.」(ピリオド)の隠しファイル/ディレクトリは,取得できます。

形式

public void getFile(String src, String dest)

入力

表3-27 入力項目一覧

項番引数名:型引数の意味制限
1src :String取得元ファイル/フォルダパス
  • 絶対パスを指定します。
  • 247文字以内で指定します。
  • 環境変数を使用する場合は,環境変数評価後の長さが247文字以内になるように指定します。※1※2
  • null指定はできません。
  • ドライブだけ(C:¥など)の指定はできません。
2dest :String取得先フォルダパス
  • 絶対パスを指定します。
  • 247文字以内で指定します。※1※3
  • null指定はできません。
注※1
英数字,_(半角下線),.(半角ピリオド),△(半角空白),( (半角左括弧),) (半角右括弧),パス区切りの¥¥(半角円マーク2つ)(Windowsの場合),/(スラッシュ)(Linuxの場合)が使用できます。¥¥..¥¥ および ¥¥.¥¥,*(アスタリスク),ネットワークドライブの指定,UNC形式のパス,ピリオドまたはスペースで終端するディレクトリを含めてはなりません(プログラムガードはされません)。
注※2
取得元がWindowsの場合,パスにリモートホスト上の環境変数を含めることもできます。環境変数は,リモートホストへログインしたユーザの環境変数が適用されます。環境変数を使用する場合,%(パーセント)が使用できます。ただし,環境変数の展開後のパスの長さが247文字を超えないようにしてください。超えた場合は,取得に失敗します。
注※3
パスにWindowsおよびMS-DOSの予約語を含めてはなりません。含めた場合,処理に失敗します。予約語については,「表1-8 コマンド形式の構文要素」を参照してください。

出力

入力「取得先フォルダパス」で指定したローカルホスト上のフォルダの下に,入力「取得元ファイル/フォルダパス」で指定したファイル/フォルダがコピーされます。取得先のフォルダが存在しない場合は,自動で作成されます。

例外

表3-28 エラーケース一覧

項番Exception発生理由
(原因コード)
発生後の動作対象リモートホスト
(Linux /Windows)
1CsdUocRemoteExecuteAssertionFailedExceptionP_RemoCon.001処理を中断し,リターンします。共通
P_RemoCon.002
2CsdUocRemoteExecuteIOExceptionP_LinSSH.001処理を中断し,リターンします。Linux
P_WinCOM.001Windows
P_WinCOM.002
P_WinCOM.004
P_WinCOM.005
P_WinCOM.006
P_WinCOM.007
P_WinCOM.008
P_WinCOM.010
P_WinCOM.011
P_WinCOM.013
P_WinCOM.014
P_WinCOM.016
P_WinCOM.017
P_WinCOM.019
P_WinCOM.022
P_WinCOM.024
P_WinCOM.026
P_WinCOM.027
P_WinCOM.029
P_WinCOM.030
P_WinCOM.037
P_WinCOM.038
P_WinCOM.039
P_WinCOM.040
P_WinCOM.041
P_WinCOM.042
P_RemoCon.006
3CsdUocRemoteExecuteTimeoutExceptionP_LinSSH.002処理を中断し,リターンします。Linux
P_WinCOM.028Windows

注 対処方法については,マニュアル「uCosminexus Service Director メッセージ」の「ファイル転送とコマンドのリモート実行時に出力するメッセージの原因コード」を参照してください。


注意事項

同一リモートホストに対して複数のIPアドレスが設定されている場合,異なるIPアドレスを指定して,このメソッドを複数同時実行すると,処理が失敗することがあります。

execCommandメソッド

形式

public int execCommand(String commandline)

入力

表3-29 入力項目一覧

項番引数名:型引数の意味制限
1commandline :String実行するコマンドのパスコマンドライン全体で1023文字以内になるように指定します。
コマンドは絶対パスを指定します。
パスの長さは247文字以内で指定します。※1※2
ただし,リモートホストのPATH環境変数に設定されていれば,コマンド名だけの実行もできます。
null指定はできません。
注※1
英数字,_(半角下線),.(半角ピリオド),△(半角空白),( (半角左括弧),) (半角右括弧),パス区切りの¥¥(半角円マーク2つ)(Windowsの場合),/(スラッシュ)(Linuxの場合)が使用できます。
注※2
リモートホストがWindowsの場合,パスにリモートホスト上の環境変数を含めることもできます。環境変数は,リモートホストへログインしたユーザの環境変数が適用されます。環境変数を使用する場合,%(パーセント)が使用できます。ただし,環境変数の展開後のパスの長さが247文字を超えないようにしてください。超えた場合は,コマンド実行が失敗します。

出力

なし

例外

表3-30 エラーケース一覧

項番Exception発生理由
(原因コード)
発生後の動作対象リモートホスト
(Linux /Windows)
1CsdUocRemoteExecuteAssertionFailedExceptionP_RemoCon.001処理を中断し,リターンする。共通
P_RemoCon.002
2CsdUocRemoteExecuteIOExceptionP_LinSSH.001処理を中断し,リターンする。Linux
P_WinCOM.001Windows
P_WinCOM.002
P_WinCOM.004
P_WinCOM.005
P_WinCOM.006
P_WinCOM.007
P_WinCOM.008
P_WinCOM.010
P_WinCOM.011
P_WinCOM.013
P_WinCOM.016
P_WinCOM.017
P_WinCOM.019
P_WinCOM.022
P_WinCOM.024
P_WinCOM.026
P_WinCOM.027
P_WinCOM.029
P_WinCOM.030
P_WinCOM.037
P_WinCOM.038
P_WinCOM.039
P_WinCOM.040
P_WinCOM.041
P_WinCOM.042
P_RemoCon.007
3CsdUocRemoteExecuteTimeoutExceptionP_LinSSH.002処理を中断し,リターンする。Linux
P_WinCOM.028Windows

注 対処方法については,マニュアル「uCosminexus Service Director メッセージ」の「ファイル転送とコマンドのリモート実行時に出力するメッセージの原因コード」を参照してください。


注意事項

同一リモートホストに対して複数のIPアドレスが設定されている場合,異なるIPアドレスを指定して,このメソッドを複数同時実行すると,処理が失敗することがあります。