com.sabratec.util.ftp

Class GXFtpRequest

java.lang.Object

com.sabratec.util.ftp.GXFtpRequest

public class GXFtpRequest
extends Object

This class is used as a data structure for all the parameters which are relevant
for an FTP transmission. Some of the data is stored in the object by designated methods, e.g.: setUser().
The restof the data is stored using the setValue() method and pre defined constants such as:
setValue(GXMFCommands.CMD_MF_DATA_TYPE, GXMFCommands.CMD_VAL_MF_DATA_TYPE_BIN);

An initalized object of this class can be passed as a parameter to each of the following GXFtpManager methods:
GXFtpManager.instance().putFile(GXFtpRequest);
GXFtpManager.instance().getFile(GXFtpRequest);

Constructor Summary

Constructors

Constructor and Description
GXFtpRequest() Class constractor

Method Summary

Modifier and Type	Method and Description
String	getAdditionalCommand() For internal use
byte[]	getLocalFile() For internal use
byte[]	getLocalFileBytes() For internal use
String	getPassword() For internal use
String	getRemoteFile() For internal use
String	getServer() For internal use
String	getUser() For internal use
String	getValue(String key) For internal use
String	getValues() For internal use
void	readFileToUpload(String filename) Reads and stores the content of the local file into the request data structure.
void	setAdditional(String additionalCommands) Sets an additional user defined command for the FTP request.
void	setLocalFileBytes(byte[] fileByBytes) For internal use
void	setPassword(String password) Sets the remote host FTP password
void	setRemoteFile(String remoteFile) Sets the remote file name using the full path.
void	setServer(String server) Sets the FTP remote server IP address.
void	setUser(String user) Sets the FTP server user name.
void	setValue(String key, String value) Stores command values in the FTP request.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GXFtpRequest

public GXFtpRequest()

Class constractor

Method Detail

getValue

public String getValue(String key)

For internal use

getValues

public String getValues()

For internal use

setValue

public void setValue(String key,
                     String value)

Stores command values in the FTP request.
For example:setValue(GXMFCommands.CMD_MF_DATA_TYPE, GXMFCommands.CMD_VAL_MF_DATA_TYPE_BIN);

Parameters:

key - command constant which can be either from the
GXMFCommands class or from the GXAS400Commands class.

value - The cmd value, which can be a constant either from one of these classes (GXMFCommands or GXAS400Commands ) or a positive number.

getPassword

public String getPassword()

For internal use

setPassword

public void setPassword(String password)

Sets the remote host FTP password

Parameters:

password - host password.

getRemoteFile

public String getRemoteFile()

For internal use

setRemoteFile

public void setRemoteFile(String remoteFile)

Sets the remote file name using the full path.

Parameters:

remoteFile - The full path name of the remote name.

getServer

public String getServer()

For internal use

setServer

public void setServer(String server)

Sets the FTP remote server IP address.

Parameters:

server -

getUser

public String getUser()

For internal use

setUser

public void setUser(String user)

Sets the FTP server user name.

Parameters:

user -

setLocalFileBytes

public void setLocalFileBytes(byte[] fileByBytes)

For internal use

getLocalFileBytes

public byte[] getLocalFileBytes()

For internal use

getLocalFile

public byte[] getLocalFile()

For internal use

setAdditional

public void setAdditional(String additionalCommands)

Sets an additional user defined command for the FTP request.

Parameters:

additionalCommands -

getAdditionalCommand

public String getAdditionalCommand()

For internal use

readFileToUpload

public void readFileToUpload(String filename)
                      throws GXGeneralException,
                             IOException

Reads and stores the content of the local file into the request data structure. Should be used before uploading a file.

Parameters:

filename -

Throws:

GXGeneralException

IOException