oracle.ifs.protocols.ftp.server

Class FtpServerChannel

java.lang.Object

java.lang.Thread

oracle.ifs.protocols.ftp.server.FtpServerChannel

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

FtpsServerChannel

public class FtpServerChannel
extends Thread

The FtpServerChannel.java class - Ftp specific Channel.

Version:

1.0

(Unpublished)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected InetAddress	m_ClientHost
protected BufferedReader	m_CommandLineInput The Commandline input.
protected InputStream	m_ControlIn The control input.
protected OutputStream	m_ControlOut The control output.
protected Socket	m_ControlSocket The Control socket for commands.
protected int	m_ControlSocketTimeout The default timeout for the channel socket.
protected PrintWriter	m_ControlWriter PrintWriter
protected FtpSocketFactory	m_FtpSocketFactory My socket factory.
protected boolean	m_ReachedMaximumConnections Determined in FtpServer whether maximum number of connections has been reached.
protected String	m_ReplyToken Token set by a command used in a sendAnswer reply.
protected String	m_Username Name of user.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
FtpServerChannel(FtpServer server, Socket controlSocket, int key, String threadName, boolean reachedMaximumConnections) The Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	closeConnection() Close outputstream, inputStream, and all sockets setting the member variables to null.
protected FtpSocketFactory	createFtpSocketFactory(InetAddress localhost, int localControlPort, InetAddress clientHost, int clientControlPort) Creates a socket factory with the InetAddresses as given and the ports minus 1.
void	disconnect() Disconnects this Channel.
int	getChannelKey() Gets the channel key given at instantiation.
protected String	getCommandLine() Gets the commandline input.
Socket	getControlSocket() Gets the active socket.
int	getControlSocketTimeout() Gets control socket timeout.
protected FdkSession	getFdkSession()
FtpServer	getFtpServer() Gets the FtpServer that started this Channel.
FtpSession	getFtpSession() Gets the FtpSession associated with this Channel.
FtpSocketFactory	getFtpSocketFactory() Gets the SocketFactory associated with this Channel.
String	getReplyToken() Gets the reply token.
String	getUsername() Gets the username for the channel.
protected void	handleCommandThrowable(Throwable e, String cmdKey) Handles a Throwable while invoking command.
protected void	handleFtpException(FtpException e, String cmdKey) Handles an exception while invoking command.
protected void	handleInterruptedIOException() Handles an InterruptedIOException in the command loop.
protected void	handleThrowable() Handles a Throwable in the command loop.
boolean	isSameClientHost(InetAddress addr) Checks whether the IP address is the same as the FTP client machine.
String	logUser() Gets the username for the channel for logging.
void	run() Runs thread.
protected boolean	satisfiesPolicy(String cmd, String args)
void	sendAnswer(String answer) Convenience method for sending a String answer.
void	setControlSocketTimeout(int timeout) Sets timeout of control socket.
void	setFtpSession(FtpSession ftpSession) Sets the FtpSession associated with this Channel.
void	setReplyToken(String msg) Sets reply token.
void	setShouldContinue(boolean shouldContinue) Set the boolean whether this thread should continue to receive commands.
protected void	setupIO() Create the Reader and Writer associated with this Channel.
void	setUsername(String username) Sets the username for the channel.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_FtpSocketFactory

protected FtpSocketFactory m_FtpSocketFactory

My socket factory.

(Unpublished)

m_ControlSocket

protected Socket m_ControlSocket

The Control socket for commands.

(Unpublished)

m_ControlSocketTimeout

protected int m_ControlSocketTimeout

The default timeout for the channel socket.

(Unpublished)

m_ControlIn

protected InputStream m_ControlIn

The control input.

(Unpublished)

m_ControlOut

protected OutputStream m_ControlOut

The control output.

(Unpublished)

m_CommandLineInput

protected BufferedReader m_CommandLineInput

The Commandline input.

(Unpublished)

m_ControlWriter

protected PrintWriter m_ControlWriter

PrintWriter

(Unpublished)

m_Username

protected String m_Username

Name of user.

(Unpublished)

m_ReplyToken

protected String m_ReplyToken

Token set by a command used in a sendAnswer reply.

(Unpublished)

m_ReachedMaximumConnections

protected boolean m_ReachedMaximumConnections

Determined in FtpServer whether maximum number of connections has been reached.

(Unpublished)

m_ClientHost

protected InetAddress m_ClientHost

Constructor Detail

FtpServerChannel

public FtpServerChannel(FtpServer server,
                        Socket controlSocket,
                        int key,
                        String threadName,
                        boolean reachedMaximumConnections)
                 throws Exception

The Constructor.

Throws:

Exception

(Unpublished)

Method Detail

run

public void run()

Runs thread.

Specified by:

run in interface Runnable

Overrides:

run in class Thread

(Unpublished)

setReplyToken

public void setReplyToken(String msg)

Sets reply token. A command might have a string to send in the reply.

(Unpublished)

getReplyToken

public String getReplyToken()

Gets the reply token.

(Unpublished)

getChannelKey

public int getChannelKey()

Gets the channel key given at instantiation.

(Unpublished)

getFtpServer

public FtpServer getFtpServer()

Gets the FtpServer that started this Channel.

(Unpublished)

getFtpSession

public FtpSession getFtpSession()

Gets the FtpSession associated with this Channel.

(Unpublished)

setFtpSession

public void setFtpSession(FtpSession ftpSession)

Sets the FtpSession associated with this Channel.

(Unpublished)

getUsername

public String getUsername()

Gets the username for the channel.

Returns:

username

(Unpublished)

logUser

public String logUser()

Gets the username for the channel for logging. There may not be a session, so log username directly.

Returns:

username

(Unpublished)

setUsername

public void setUsername(String username)

Sets the username for the channel.

Parameters:

username - name of user

(Unpublished)

setShouldContinue

public void setShouldContinue(boolean shouldContinue)

Set the boolean whether this thread should continue to receive commands.

(Unpublished)

sendAnswer

public void sendAnswer(String answer)

Convenience method for sending a String answer.

Parameters:

answer - reply string

(Published)

handleInterruptedIOException

protected void handleInterruptedIOException()

Handles an InterruptedIOException in the command loop. This happens on a socket timeout.

(Unpublished)

handleThrowable

protected void handleThrowable()

Handles a Throwable in the command loop. This shouldn't happen.

(Unpublished)

handleFtpException

protected void handleFtpException(FtpException e,
                                  String cmdKey)

Handles an exception while invoking command.

Parameters:

e - the exception object

cmdKey - the command key

(Unpublished)

handleCommandThrowable

protected void handleCommandThrowable(Throwable e,
                                      String cmdKey)

Handles a Throwable while invoking command.

Parameters:

e - the exception object

cmdKey - the command key

(Unpublished)

setupIO

protected void setupIO()
                throws IOException

Create the Reader and Writer associated with this Channel.

Throws:

IOException

(Published)

setControlSocketTimeout

public void setControlSocketTimeout(int timeout)

Sets timeout of control socket. Used by FtpUserCommand.

(Unpublished)

getControlSocketTimeout

public int getControlSocketTimeout()

Gets control socket timeout.

(Unpublished)

getControlSocket

public Socket getControlSocket()

Gets the active socket.

(Unpublished)

getFtpSocketFactory

public FtpSocketFactory getFtpSocketFactory()

Gets the SocketFactory associated with this Channel.

(Published)

createFtpSocketFactory

protected FtpSocketFactory createFtpSocketFactory(InetAddress localhost,
                                                  int localControlPort,
                                                  InetAddress clientHost,
                                                  int clientControlPort)

Creates a socket factory with the InetAddresses as given and the ports minus 1.

(Published)

getCommandLine

protected String getCommandLine()
                         throws FtpException,
                                Exception

Gets the commandline input.

Throws:

FtpException

Exception

(Published)

disconnect

public void disconnect()

Disconnects this Channel. Called by a ProtocolServer shutting down or a Command that want to disconnect the Channel. Disposing of the ProtocolSession is a seperate task. This is a non-blocking call.

(Published)

closeConnection

protected void closeConnection()

Close outputstream, inputStream, and all sockets setting the member variables to null.

(Published)

satisfiesPolicy

protected boolean satisfiesPolicy(String cmd,
                                  String args)

getFdkSession

protected FdkSession getFdkSession()

isSameClientHost

public boolean isSameClientHost(InetAddress addr)

Checks whether the IP address is the same as the FTP client machine. This security measure guards against attacks that can occur through a PORT or PASV command.

(Unpublished)