All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.ECL.ECLXfer
java.lang.Object
|
+----com.ibm.eNetwork.ECL.ECLXfer
- public class ECLXfer
- extends Object
ECLXfer allows the transfer of files to and from a host over an
established session. ECLXfer supports the Host File Transfer Program
IND$FILE (for SBCS) or APVUFILE (for DBCS) transfer protocols.
Transfer behavior can be controlled using the standard IND$FILE or
APVUFILE send and receive options as follows.
Common Parameters (valid for send or receive)
- ASCII
- When used with SBCS session, it causes ASCII to
EBCDIC translation on a send and EBCDIC to ASCII
translation on a receive.
When used with Taiwan or Korean DBCS session, it
causes 1-byte code to 1-byte code and 2-byte code
to 2-byte code translation according to host and
PC code pages. It inserts SO/SI characters into the
DBCS field on send and removes SO/SI on receive.
- JISCII
- This is valid for Japanese DBCS sessions only.
Causes 1-byte code to EBCDIC and 2-byte code to
IBM kanji on a send and reverse translation on a
receive. Inserts SO/SI characters into the DBCS
field on send and removes SO/SI on receive.
- CRLF
- Strips carriage return/line feed characters on
a send and adds carriage return/line feed to
each record on a receive.
- NOSO
- This option is valid only for DBCS when used with
the JISCII or ASCII option on send. It does not
convert SO (hex 0E) and SI (hex 0F) before and after
the DBCS field. It does not convert RS (hex 1E) and
US (hex 1F) to SO (hex 0E) and SI (hex 0F).
- SO
- This option is valid only for DBCS when used with
the JISCII or ASCII option on receive. It converts
SO (hex 0E) and SI (hex 0F) to RS (hex 1E) and
US (hex 1F).
- APPEND
- The source file will be appended to the target file.
If APPEND is not specified, the target file
will be replaced. APPEND is not supported for members
of an MVS partitioned data set.
- NEW
- The transfer will abort if the target file exists.
This option may be used to protect against accidential
erase of an existing target file.
Additional Send Parameters for MVS only
- LRECL(n)
- n is the logical record length of host file.
- BLKSIZE(n)
- n is the block size of of the host file.
- RECFM x
- Recording mode for the host file. Values for
x are F (fixed length), V (variable length), and U
(undefined record type)
- SPACE(quantity[,increment])
- Amount of space to be allocated
for a new TSO data set.
- Quantity
- Units of space to be allocated
initially. This must be specified when
the SPACE parameter is specified.
- Increment
- Units of space to be added each
time new space is required.
The following parameters are only valid when the SPACE parameter is
specified, and are mutually exclusive of each other.
- AVBLOCK(n)
- Average block length used as the unit size by the
SPACE parameter. The n is block length in bytes.
- TRACKS
- Specifies that the unit of space is a track.
Only valid with the SPACE parameter.
- CYLINDERS
- Specifies that the unit of space is a cylinder.
Only valid with the SPACE parameter.
Additional Send Parameters for VM only
- LRECL n
- n is the logical record length of host file.
- RECFM x
- Recording mode for the host file. Values for
x are F (fixed length) and V (variable length).
This class cannot be constructed by the end user, but an instance
of it can be obtained through the ECLSession object.
-
GetCodePage()
- Returns the codepage currently in use by file transfer.
-
ListCodePage()
- Returns a list of valid codepages which can be used by file transfer.
-
ReceiveFile(String, String, String)
- Receives a file from the host using the specified transfer options.
-
SendFile(String, String, String)
- Sends a file to the host using the specified transfer options.
-
SetCodePage(String)
- Sets the file transfer codepage to the specified codepage.
SendFile
public void SendFile(String srcName,
String targName,
String opts) throws ECLErr
- Sends a file to the host using the specified transfer options.
- Parameters:
- srcName - Local file name
- targName - Host file name
- opts - Send transfer options
- Throws: ECLErr
- Thrown if the file transfer is unsuccessful.
ReceiveFile
public void ReceiveFile(String srcName,
String targName,
String opts) throws ECLErr
- Receives a file from the host using the specified transfer options.
- Parameters:
- srcName - Host file name
- targName - Local file name
- opts - Send transfer options
- Throws: ECLErr
- Thrown if the file transfer is unsuccessful.
SetCodePage
public void SetCodePage(String codepage)
- Sets the file transfer codepage to the specified codepage.
The host codepage in use by the session is not affected.
- Parameters:
- codepage - Codepage to be set. The value is ignored if it
is not valid.
GetCodePage
public String GetCodePage()
- Returns the codepage currently in use by file transfer.
- Returns:
- The codepage currently in use by file transfer.
ListCodePage
public String[] ListCodePage()
- Returns a list of valid codepages which can be used by file transfer.
- Returns:
- String array of valid codepages.
All Packages Class Hierarchy This Package Previous Next Index