すべてのパッケージ  クラス階層  このパッケージ  前へ  次へ  索引

クラス com.ibm.eNetwork.ECL.ECLXfer

java.lang.Object
   |
   +----com.ibm.eNetwork.ECL.ECLXfer

public class ECLXfer
extends Object
ECLXfer によって、確立したセッションを介して 3270 ホストと 5250 ホストの間でファイルを転送することができます。 ECLXfer は 3270 ホスト・ファイル転送プログラム IND$FILE (SBCS の場合) または APVUFILE (DBCS の場合) 転送プロトコルをサポートします。これらは、標準の IND$FILE または APVUFILE 送信および受信オプションを使用して制御することができます。 ECLXfer は 5250 ファイル転送もサポートしています。これは、OS/400 に固有の送信および受信オプションを使って制御することができます。

共通パラメーター (送信および受信の場合に有効)

ASCII
SBCS セッションで使用する場合は、 送信の際には ASCII から EBCDIC へ変換し、 受信の際には EBCDIC から ASCII へ変換します。 台湾または韓国語の DBCS セッションで使用する場合は、 ホストと PC のコード・ページに従って、 1 バイトのコードを 1 バイトのコードに、 2 バイトのコードを 2 バイトのコードに変換します。送信の際には DBCS フィールドに SO/SI 文字を挿入し、受信の際には SO/SI を除去します。
JISCII
これは、日本語の DBCS セッションでのみ有効です。 送信の際には 1 バイトのコードを EBCDIC に、 2 バイトのコードを IBM 漢字に変換し、 受信の際にはその逆の変換をします。送信の際には DBCS フィールドに SO/SI 文字を挿入し、受信の際には SO/SI を除去します。
CRLF
送信の際には復帰改行文字を取り去り、 受信の際には復帰改行文字を各レコードに追加します。
NOSO
このオプションは、 送信の際に JISCII または ASCII オプションと共に使用するとき、 DBCS の場合にのみ有効です。 DBCS フィールドの前後の SO (16 進数 0E) および SI (16 進数 0F) の変換や、 RS (16 進数 1E) および US (16 進数 1F) から SO (16 進数 0E) および SI (16 進数 0F) への変換は行いません。
SO
このオプションは、 受信の際に JISCII または ASCII オプションと共に使用するとき、 DBCS の場合にのみ有効です。 SO (16 進数 0E) および SI (16 進数 0F) を RS (16 進数 1E) および US (16 進数 1F) に変換します。
USER
このオプションは、 受信の際に ASCII (JISCII) および SO オプションと共に使用するとき、 DBCS の場合にのみ有効です。 USER を指定すると、 SO (x'0E') および SI (x'0F') は RS(x'1E') および US (x'1F') に変換されません。
APPEND
ソース・ファイルがターゲット・ファイルに付加されます。 APPEND を指定していない場合は、 ターゲット・ファイルが置換されます。 APPEND は MVS 区分データ・セットのメンバーについてはサポートされません。
NEW
ターゲット・ファイルが存在する場合は、 転送を中止します。 このオプションを使用すれば、 既存のターゲット・ファイルを誤って消去してしまうことを避けられます。

追加の送信パラメーター (MVS 専用)

LRECL(n)
n はホスト・ファイルの論理レコード長。
BLKSIZE(n)
n はホスト・ファイルのブロック・サイズ。
RECFM x
ホスト・ファイルの記録モード。 x には F (固定長)、V (可変長)、 U (不定形式レコード・タイプ) のいずれかの値を入れます。
SPACE(quantity[,increment])
新規の TSO データ・セット用に割り振るスペース容量。
Quantity
最初に割り振っておくスペース単位。 SPACE パラメーターを指定するときには、 必須です。
Increment
新規スペースが必要となるたびに追加するスペース単位。

次のパラメーターが有効なのは SPACE パラメーターが指定されたときに限られます。 これらのパラメーターは相互に同時に指定することはできません。

AVBLOCK(n)
SPACE パラメーターが単位サイズとして使用する平均ブロック長。 (n) はブロック長 (バイト)。
TRACKS
スペースの単位がトラックであることを指定します。 SPACE パラメーターでのみ有効です。
CYLINDERS
スペースの単位がシリンダーであることを指定します。 SPACE パラメーターでのみ有効です。

追加の送信パラメーター (VM 専用)

LRECL n
n はホスト・ファイルの論理レコード長。
RECFM x
ホスト・ファイルの記録モード。 x には F (固定長) および V (可変長) のいずれかの値を入れます。

追加パラメーター (OS/400 のみ)

DSTADDR(dstaddr)
このオプションは、ファイル転送に使用する宛先アドレスを指定します。現行セッションのホスト名がデフォルト宛先アドレスとして使用されます。ホスト名がこのホストの最終宛先アドレスと同じ場合は、このオプションを指定する必要はありません。また、プロキシー・サーバー・サポートを使用している場合には、このオプションには、AS/400 名、またはプロキシー・サーバーから到達可能な宛先アドレスを指定する必要があります。

HOD-uniqueこの転送オプションは、Host On-Demand だけがサポートしています。

PROXYADDR(proxyaddr)
このオプションは、ファイル転送に使用するプロキシー・サーバーの宛先アドレスを指定します。このオプションを指定する必要があるのは、ユーザーがプロキシー・サーバー・サポートを使用したい場合だけです。プロキシー・サーバーのデフォルト・ポートは 3470 です。ただしこれは、PROXYPORT(proxyport) オプションを使用して変更することができます。

HOD-uniqueこの転送オプションは、Host On-Demand だけがサポートしています。

PROXYPORT(proxyport)
このオプションは、ファイル転送に使用するプロキシー・サーバーの宛先ポートを指定します。プロキシー・サーバーのデフォルト・ポートは 3470 です。このオプションを指定する必要があるのは、ユーザーがプロキシー・サーバー・サポートを使用したい場合だけです。

HOD-uniqueこの転送オプションは、Host On-Demand だけがサポートしています。

USERID(usr)
このオプションは、ファイル転送に使用するユーザー ID を指定します。 この ID が Host On Demand セッションで呼び出される場合には、 このオプションを指定する必要はありません。 このオプションは、GUI を使わずに HACL アプリケーションを開発する目的で準備されています。 また、このオプションをセッションごとに何回も指定する必要はありません。

HOD-uniqueこの転送オプションは、Host On-Demand だけがサポートしています。

PASSWORD(pwd)
このオプションは、ファイル転送に使用するパスワードを指定します。 パスワードが Host On Demand セッションで呼び出される場合には、 このオプションを指定する必要はありません。 このオプションは、GUI を使わずに HACL アプリケーションを開発する目的で準備されています。 このオプションは、PASSWORD オプションと一緒に使用してください。

HOD-uniqueこの転送オプションは、Host On-Demand だけがサポートしています。

UNICODE(encoding)
SBCS/DBCS セッションで使用する場合は、 送信の際には UNICODE から EBCDIC へ変換し、 受信の際には EBCDIC から UNICODE へ変換します。 エンコード・オプションとして UCS2 か UTF8 のいずれかを指定することができます。 どちらも指定しないと、転送に使用されるデフォルトのエンコードは UCS2 になります。

HOD-uniqueこの転送オプションは、Host On-Demand だけがサポートしています。

SRC
このオプションは、ファイルの送信に使用する AS/400 のファイル・タイプを指定します。 ホスト・ファイルが存在しない場合、新規のファイルは、「AS/400 ソース物理ファイル」というファイル・タイプで作成されます。このオプションを適用できるのは、 QSYS ライブラリー・ファイル・システムの下のファイルだけです。
DTA
このオプションは、ファイルの送信に使用する AS/400 のファイル・タイプを指定します。 ホスト・ファイルが存在しない場合、新規のファイルは、「AS/400 物理データ・ファイル」というファイル・タイプで作成されます。このオプションを適用できるのは、 QSYS ライブラリー・ファイル・システムの下のファイルだけです。

HOD-uniqueこの転送オプションは、Host On-Demand だけがサポートしています。

SAVF
このオプションは、ファイルの送信に使用する AS/400 のファイル・タイプを指定します。 ホスト・ファイルが存在しない場合、新規のファイルは、「AS/400 保管ファイル」というファイル・タイプで作成されます。このオプションを指定する場合、転送モードは BINARY にする必要があります。また、このオプションを適用できるのは、 QSYS ライブラリー・ファイル・システムの下のファイルだけです。

HOD-uniqueこの転送オプションは、Host On-Demand だけがサポートしています。

LRECL(n)
論理レコード長。このオプションを適用できるのは、 QSYS ライブラリー・ファイル・システムの下のファイルだけです。有効な値は、次のとおりです。
ファイル・タイプが DTA の場合、1 〜 32766 の範囲内のすべての整数
ファイル・タイプが SRC の場合、1 〜 32754 の範囲内のすべての整数
このオプションは、ファイル・タイプ SAVF では無視されます。

OS/400、VM/CMS および CICS の場合、最初のオプションの前に開き括弧 '(' が必要です。

また、上記の転送オプションは、どれも必須オプションではありません。オプションを指定すると、それに対応するアクションが転送中に行われます。

MVS ホスト・ファイル名は、以下のいずれかの形式で指定することができます。

dataSetName
dataSetName(memberName)

VM/CMS ホスト・ファイル名は、以下のいずれかの形式で指定することができます。

fileName fileType
fileName fileType fileMode

OS/400 ホスト・ファイル名は、以下のいずれかの形式で指定することができます。

LibraryName/FileName
LibraryName/FileName(MemberName)
/Dir1/.../DirX/FileName

このクラスは、ユーザーが構成することはできませんが、 クラスのインスタンスは ECLSession オブジェクトを介して取得することができます。


メソッド索引

 o Cancel()
進行中のファイル転送をキャンセルします。
 o GetCodePage()
ファイル転送で現在使用中のコード・ページを戻します。 使用すべきではありません。
 o GetParent()
ECLSession のインスタンスである、この ECLXfer の親を取得します。
 o GetPCCodePage()
ファイル転送で現在使用中のコード・ページを戻します。
 o GetTimeout()
ファイル転送に使用する現在のタイムアウト値を戻します。
 o getTraceLevel()
 o IsClear()
ファイル転送が行われる前に消去がホストに送信されたかどうかを示す、消去フラグを戻します。
 o ListCodePages()
ファイル転送で使用できる有効なコード・ページのリストを戻します。 使用すべきではありません。
 o ListPCCodePages()
ファイル転送で使用できる有効なコード・ページのリストを戻します。
 o ReceiveFile(String, String, String)
指定された転送オプションを使用して、ホストからファイルを受信します。
 o RegisterXferEvent(ECLXferListener)
ECLXferEvent の ECLXferListener を登録します。
 o SendFile(String, String, String)
指定された転送オプションを使用して、ホストにファイルを送信します。
 o SetClear(boolean)
ファイル転送が開始される前に消去がホストに送信されたかどうかを設定します。
 o SetCodePage(String)
ファイル転送コード・ページを指定されたコード・ページに設定します。 使用すべきではありません。
 o SetPCCodePage(String)
ファイル転送コード・ページを指定されたコード・ページに設定します。
 o SetTimeout(int)
ファイル転送タイムアウトを指定値に設定します。
 o SetXferHostUsrPwd(String, String, String, String, int)
 o UnregisterXferEvent(ECLXferListener)
以前に RegisterXferEvent() メソッドを使って登録した ECLXferListener の登録を解除します。

メソッド

 o SendFile
 public void SendFile(String srcName,
                         String targName,
                         String options) throws ECLErr
指定された転送オプションを使用して、ホストにファイルを送信します。

パラメーター:
srcName - ローカル・ファイル名
targName - ホスト・ファイル名
options - 送信転送オプション

ローカル・ファイル名は、自動的に二重引用符で囲んでセットされてから、オペレーティング・システムへ渡されます。

Throws : ECLErr
ファイル転送が成功しなかった場合に throw されます。
 o ReceiveFile
 public void ReceiveFile(String srcName,
                         String targName,
                         String options) throws ECLErr
指定された転送オプションを使用して、ホストからファイルを受信します。

パラメーター:
srcName - ホスト・ファイル名
targName - ローカル・ファイル名
options - 送信転送オプション

ローカル・ファイル名は、自動的に二重引用符で囲んでセットされてから、オペレーティング・システムへ渡されます。

Throws : ECLErr
ファイル転送が成功しなかった場合に throw されます。
 o Cancel
 public void Cancel()
進行中のファイル転送をキャンセルします。 進行中の転送がない場合は、このメソッドが戻るだけです。

HOD-uniqueこのメソッドは、Host On-Demand だけがサポートしています。

 o RegisterXferEvent
 public void RegisterXferEvent(ECLXferListener listener)
ECLXferEvent の ECLXferListener を登録します。

HOD-uniqueECLXferEvents は Host On-Demand 内でのみ生成されます。

パラメーター:
listener - イベントの発生時に通知を受ける ECLXferListener オブジェクト。
関連項目:
UnregisterXferEventECLXferListener
 o UnregisterXferEvent
 public void UnregisterXferEvent(ECLXferListener listener)
以前に RegisterXferEvent() メソッドを使って登録した ECLXferListener の登録を解除します。現在登録されているリスナーがなければ、このメソッドは何もしません。

HOD-uniqueECLXferEvents は Host On-Demand 内でのみ生成されます。

パラメーター:
listener - 登録が解除される ECLXferListener オブジェクト。
関連項目:
RegisterXferEventECLXferListener
 o SetXferHostUsrPwd
 public void SetXferHostUsrPwd(String dstAddr,
                               String usr,
                               String pwd,
                               String proxyAddr,
                               int proxyPort)
 o getTraceLevel
 public Integer getTraceLevel()
 o SetCodePage
 public void SetCodePage(String codepage)
注: SetCodePage() は使用すべきではありません。

ファイル転送コード・ページを指定されたコード・ページに設定します。セッションが使用中のホスト・コード・ページには影響しません。

パラメーター:
codepage - 設定するコード・ページ。無効な値は無視されます。
 o GetCodePage
 public String GetCodePage()
注: GetCodePage() は使用すべきではありません。

ファイル転送で現在使用中のコード・ページを戻します。

戻り値 :
ファイル転送で現在使用中のコード・ページ。
 o ListCodePages
 public String[] ListCodePages()
注: ListCodePages() は使用すべきではありません。

ファイル転送で使用できる有効なコード・ページのリストを戻します。

戻り値 :
有効なコード・ページのストリング配列。
 o SetPCCodePage
 public void SetPCCodePage(String codepage)
ファイル転送コード・ページを指定されたコード・ページに設定します。セッションが使用中のホスト・コード・ページには影響しません。

パラメーター:
codepage - 設定するコード・ページ。無効な値は無視されます。
 o GetPCCodePage
 public String GetPCCodePage()
ファイル転送で現在使用中のコード・ページを戻します。

戻り値 :
ファイル転送で現在使用中のコード・ページ。
 o ListPCCodePages
 public String[] ListPCCodePages()
ファイル転送で使用できる有効なコード・ページのリストを戻します。

戻り値 :
有効なコード・ページのストリング配列。
 o SetTimeout
 public void SetTimeout(int value)
ファイル転送タイムアウトを指定値に設定します。

HOD-uniqueこのメソッドは、Host On-Demand だけがサポートしています。

パラメーター:
value - 転送中に使用されるタイムアウト値 (秒)。
 o GetTimeout
 public int GetTimeout()
ファイル転送に使用する現在のタイムアウト値を戻します。

HOD-uniqueこのメソッドは、Host On-Demand だけがサポートしています。

戻り値 :
転送中に使用されるタイムアウト値 (秒)。
 o SetClear
 public void SetClear(boolean sendClear)
ファイル転送が開始される前に消去がホストに送信されたかどうかを設定します。

HOD-uniqueこのメソッドは、Host On-Demand だけがサポートしています。

パラメーター:
sendClear - 消去が送信されたかどうかを示すブール。
 o IsClear
 public boolean IsClear()
ファイル転送が行われる前に消去がホストに送信されたかどうかを示す、消去フラグを戻します。

HOD-uniqueこのメソッドは、Host On-Demand だけがサポートしています。

戻り値 :
ファイル転送の前に消去が送信されたかどうか。
 o GetParent
 public ECLSession GetParent()
ECLSession のインスタンスである、この ECLXfer の親を取得します。

戻り値 :
親 ECLSession

すべてのパッケージ  クラス階層  このパッケージ  前へ  次へ  索引