com.enterprisedt.net.ftp

Class FTPControlSocket

java.lang.Object

com.enterprisedt.net.ftp.FTPControlSocket

public class FTPControlSocket
extends java.lang.Object

Supports client-side FTP operations

Version:

$Revision: 1.1 $

Author:

Bruce Blackshaw

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTROL_PORT The default and standard control port number for FTP
static java.lang.String	cvsId Revision control id
static int	MAX_ACTIVE_RETRY Maximum number of auto retries in active mode

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the socket
void	logout() Quit this FTP session and clean up.
FTPReply	sendCommand(java.lang.String command) Send a command to the FTP server and return the server's reply as a structured reply object
void	setActivePortRange(int lowest, int highest) Set the port number range for active mode
FTPReply	validateReply(FTPReply reply, java.lang.String expectedReplyCode) Validate the response the host has supplied against the expected reply.
FTPReply	validateReply(FTPReply reply, java.lang.String[] expectedReplyCodes) Validate the response the host has supplied against the expected reply.
FTPReply	validateReply(java.lang.String reply, java.lang.String[] expectedReplyCodes) Validate the response the host has supplied against the expected reply.

Methods inherited from class java.lang.Object

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

Field Detail

cvsId

public static final java.lang.String cvsId

Revision control id

See Also:

Constant Field Values

MAX_ACTIVE_RETRY

public static int MAX_ACTIVE_RETRY

Maximum number of auto retries in active mode

CONTROL_PORT

public static final int CONTROL_PORT

The default and standard control port number for FTP

See Also:

Constant Field Values

Method Detail

close

public void close()
           throws java.io.IOException

Close the socket

Throws:

java.io.IOException

logout

public void logout()
            throws java.io.IOException

Quit this FTP session and clean up.

Throws:

java.io.IOException

setActivePortRange

public void setActivePortRange(int lowest,
                      int highest)

Set the port number range for active mode

Parameters:

lowest - lowest port number in range

highest - highest port number in range

sendCommand

public FTPReply sendCommand(java.lang.String command)
                     throws java.io.IOException

Send a command to the FTP server and return the server's reply as a structured reply object

Parameters:

command - command to send

Returns:

reply to the supplied command

Throws:

java.io.IOException

validateReply

public FTPReply validateReply(java.lang.String reply,
                     java.lang.String[] expectedReplyCodes)
                       throws java.io.IOException,
                              FTPException

Validate the response the host has supplied against the expected reply. If we get an unexpected reply we throw an exception, setting the message to that returned by the FTP server

Parameters:

reply - the entire reply string we received

expectedReplyCodes - array of expected replies

Returns:

an object encapsulating the server's reply

Throws:

java.io.IOException

FTPException

validateReply

public FTPReply validateReply(FTPReply reply,
                     java.lang.String[] expectedReplyCodes)
                       throws FTPException

Validate the response the host has supplied against the expected reply. If we get an unexpected reply we throw an exception, setting the message to that returned by the FTP server

Parameters:

reply - reply object

expectedReplyCodes - array of expected replies

Returns:

reply object

Throws:

FTPException

validateReply

public FTPReply validateReply(FTPReply reply,
                     java.lang.String expectedReplyCode)
                       throws FTPException

Validate the response the host has supplied against the expected reply. If we get an unexpected reply we throw an exception, setting the message to that returned by the FTP server

Parameters:

reply - reply object

expectedReplyCode - expected reply

Returns:

reply object

Throws:

FTPException