com.ibm.eNetwork.ECL Class ECLXfer

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

      

public class ECLXfer

extends java.lang.Object

ECLXfer allows the transfer of files to and from a 3270 or 5250 host, over an established session. ECLXfer supports the 3270 Host File Transfer Program IND$FILE (for SBCS) or APVUFILE (for DBCS) transfer protocols, which can be controlled by means of the standard IND$FILE or APVUFILE send and receive options. ECLXfer also supports 5250 File Transfer, which can be controlled by means of the send and receive options specific to OS/400.

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 or 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).

USER

This option is valid only for DBCS and only when used with ASCII (JISCII) and SO options on receive. If USER is specified, SO (x'0E') and SI (x'0F') will not be converted to RS(x'1E') and US (x'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 accidental 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 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.

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).

Additional Parameters for OS/400 only

DSTADDR(dstaddr)

This option specifies the destination address of the host to be used for the file transfer. The host name of the current session will be used as the default destination address. There is no need to specify this option when the host name is same as the actual final destination address of the host. Also, when you are using Proxy Server support, this option should specify the AS/400 name or the destination address reachable from the Proxy Server.

PROXYADDR(proxyaddr)

This option specifies the destination address of the Proxy Server to be used for the file transfer. This option needs to be specified, only if the user wants to use the Proxy Server support. The default port of the Proxy Server is 3470. However, this can be changed using the the option PROXYPORT(proxyport).

PROXYPORT(proxyport)

This option specifies the destination port of the Proxy Server to be used for the file transfer. The default port of the Proxy Server is 3470. This option needs to be specified, only if the user wants to use the Proxy Server support.

USERID(usr)

This option specifies the user ID to be used for the file transfer. There is no need to specify this option when it is invoked from the Host On Demand session. This option is provided for developing HACL applications without a GUI. Also, there is no need to specify it more than once per session.

PASSWORD(pwd)

This option specifies the password to be used for the file transfer. There is no need to specify this option when it is invoked from Host On Demand session. This option is provided for developing HACL applications without a GUI. Use this option along with the PASSWORD option.

UNICODE(encoding)

When used with an SBCS/DBCS session, it causes UNICODE to EBCDIC translation on a send and EBCDIC to UNICODE translation on a receive. You can specify either UCS2 or UTF8 as the encoding option; if neither is specified, UCS2 is the default encoding used for the transfer.

SRC

The option specifies the AS/400 file type to be used for the file send. If the host file does not exist, a new file is created with the file type "AS/400 Source physical file". This option is applicable only for files under the QSYS library-file system.

DTA

The option specifies the AS/400 file type to be used for the file send. If the host file does not exist, a new file is created with the file type "AS/400 Physical data file". This option is applicable only for files under the QSYS library-file system.

SAVF

The option specifies the AS/400 file type to be used for the file send. If the host file does not exist, a new file is created with the file type "AS/400 save file". If this option is specified, then the transfer mode must be BINARY. Also, this option is applicable only for files under the QSYS library-file system.

LRECL(n)

Logical record length. This option is applicable only for files under the QSYS library-file system.Valid values are as follows:

For OS/400, VM/CMS and CICS, the first option must be preceded by an open parenthesis '('.

Also, none of the aforesaid transfer options are mandatory. When the options are specified, the corresponding action is taken during the transfer.

The MVS host file name can be specified in any of the following formats:

The VM/CMS host file name can be specified in any of the following formats:

The OS/400 host file name can be specified in any of the following formats:

This class cannot be constructed by the user, but an instance of it can be obtained through the ECLSession object.

public void 
SendFile(java.lang.String srcName,
                     java.lang.String targName,
                     java.lang.String options)
              throws 
ECLErr

         

public void 
ReceiveFile(java.lang.String srcName,
                        java.lang.String targName,
                        java.lang.String options)
                 throws 
ECLErr

         

public void 
Cancel()

public void 
RegisterXferEvent(
ECLXferListener listener)

public void 
UnregisterXferEvent(
ECLXferListener listener)

public java.lang.Integer 
getTraceLevel()

public void 
SetPCCodePage(java.lang.String codepage)

public java.lang.String 
GetPCCodePage()

public java.lang.String[] 
ListPCCodePages()

public void 
SetTimeout(int value)

public int 
GetTimeout()

public void 
SetMTUSize(int value)

public int 
GetMTUSize()

public 
ECLXferBIDIServices 

            GetECLXferBIDIServices()

public void 
SetClear(boolean sendClear)

public boolean 
IsClear()

public 
ECLSession 

            GetParent()