org.waarp.ftp.core.session

Class FtpSession

java.lang.Object

org.waarp.ftp.core.session.FtpSession

All Implemented Interfaces:

SessionInterface

public class FtpSession
extends Object
implements SessionInterface

Main class that stores any information that must be accessible from anywhere during the connection of one user.

Constructor Summary

Constructors

Constructor and Description
FtpSession(FtpConfiguration configuration, BusinessHandler handler) Constructor

Method Summary

Modifier and Type	Method and Description
void	clear() Clean the session
String	getAnswer()
FtpAuth	getAuth()
static String	getBasename(String path)
int	getBlockSize()
BusinessHandler	getBusinessHandler()
FtpConfiguration	getConfiguration() Get the configuration
io.netty.channel.Channel	getControlChannel()
AbstractCommand	getCurrentCommand()
FtpDataAsyncConn	getDataConn()
FtpDir	getDir()
FileParameterInterface	getFileParameter()
NetworkHandler	getNetworkHandler()
AbstractCommand	getPreviousCommand()
ReplyCode	getReplyCode()
Restart	getRestart()
String	getUniqueExtension()
boolean	isCurrentCommandFinished()
boolean	isDataSsl()
boolean	isReady()
boolean	isSsl()
boolean	isSslReady()
void	openDataConnection() Try to open a connection.
void	prepareSsl()
void	rein() Reinitialize all connection parameters, including authentification
void	reinitFtpAuth() Reinitialize the authentication to the connection step
void	setControlConnected() This function is called when the Command Channel is connected (from channelConnected of the NetworkHandler)
void	setCurrentCommandFinished() Set the Current Command as finished
void	setDataSsl(boolean isDataSsl)
void	setExitErrorCode(String answer) Set Exit code after an error
void	setExitNormalCode(String answer) Set Exit normal code
void	setNextCommand(CommandInterface command) Set the new current command
void	setPreviousAsCurrentCommand() Set the previous command as the new current command (used after a incorrect sequence of commands or unknown command)
void	setReady(boolean isReady)
void	setReplyCode(CommandAbstractException exception)
void	setReplyCode(ReplyCode replyCode, String answer)
void	setSpecialInit(FtpAuth auth, FtpDir dir, Restart restart) Special initialization (FtpExec with Https session)
void	setSsl(boolean isSsl)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpSession

public FtpSession(FtpConfiguration configuration,
                  BusinessHandler handler)

Constructor

Parameters:

configuration -

handler -

Method Detail

getBusinessHandler

public final BusinessHandler getBusinessHandler()

Returns:

the businessHandler

getConfiguration

public final FtpConfiguration getConfiguration()

Get the configuration

Returns:

the configuration

getDir

public final FtpDir getDir()

Specified by:

getDir in interface SessionInterface

Returns:

the DirInterface

getDataConn

public final FtpDataAsyncConn getDataConn()

Returns:

the Data Connection

getAuth

public final FtpAuth getAuth()

Specified by:

getAuth in interface SessionInterface

Returns:

the AuthInterface

getRestart

public final Restart getRestart()

Specified by:

getRestart in interface SessionInterface

Returns:

the Restart

setControlConnected

public final void setControlConnected()

This function is called when the Command Channel is connected (from channelConnected of the NetworkHandler)

setSpecialInit

public final void setSpecialInit(FtpAuth auth,
                                 FtpDir dir,
                                 Restart restart)

Special initialization (FtpExec with Https session)

Parameters:

auth -

dir -

restart -

getControlChannel

public final io.netty.channel.Channel getControlChannel()

Returns:

the Control channel

getNetworkHandler

public final NetworkHandler getNetworkHandler()

Returns:

The network handler associated with control

setNextCommand

public final void setNextCommand(CommandInterface command)

Set the new current command

Parameters:

command -

getCurrentCommand

public final AbstractCommand getCurrentCommand()

Returns:

the currentCommand

getPreviousCommand

public final AbstractCommand getPreviousCommand()

Returns:

the previousCommand

setPreviousAsCurrentCommand

public final void setPreviousAsCurrentCommand()

Set the previous command as the new current command (used after a incorrect sequence of commands or unknown command)

isCurrentCommandFinished

public final boolean isCurrentCommandFinished()

Returns:

True if the Current Command is already Finished (ready to accept a new one)

setCurrentCommandFinished

public final void setCurrentCommandFinished()

Set the Current Command as finished

getAnswer

public final String getAnswer()

Returns:

the answer

setReplyCode

public final void setReplyCode(ReplyCode replyCode,
                               String answer)

Parameters:

replyCode - the replyCode to set

answer -

setReplyCode

public final void setReplyCode(CommandAbstractException exception)

Parameters:

exception -

setExitErrorCode

public final void setExitErrorCode(String answer)

Set Exit code after an error

Parameters:

answer -

setExitNormalCode

public final void setExitNormalCode(String answer)

Set Exit normal code

Parameters:

answer -

getReplyCode

public final ReplyCode getReplyCode()

Returns:

the replyCode

clear

public final void clear()

Description copied from interface: SessionInterface

Clean the session

Specified by:

clear in interface SessionInterface

isReady

public final boolean isReady()

Returns:

True if the Control is ready to accept command

setReady

public final void setReady(boolean isReady)

Parameters:

isReady - the isReady to set

toString

public String toString()

Overrides:

toString in class Object

getBlockSize

public final int getBlockSize()

Specified by:

getBlockSize in interface SessionInterface

Returns:

the BlockSize to use in FileInterface operations

getFileParameter

public final FileParameterInterface getFileParameter()

Specified by:

getFileParameter in interface SessionInterface

Returns:

the configuration

getBasename

public static String getBasename(String path)

Parameters:

path -

Returns:

the basename from the given path

reinitFtpAuth

public final void reinitFtpAuth()

Reinitialize the authentication to the connection step

rein

public final void rein()

Reinitialize all connection parameters, including authentification

openDataConnection

public final void openDataConnection()
                              throws Reply425Exception

Try to open a connection. Do the intermediate reply if any (150) and the final one (125)

Throws:

Reply425Exception - if the connection cannot be opened

getUniqueExtension

public final String getUniqueExtension()

Specified by:

getUniqueExtension in interface SessionInterface

Returns:

the extension to give to Unique File (STOU)

isSsl

public final boolean isSsl()

setSsl

public final void setSsl(boolean isSsl)

prepareSsl

public void prepareSsl()

isSslReady

public final boolean isSslReady()

isDataSsl

public final boolean isDataSsl()

setDataSsl

public final void setDataSsl(boolean isDataSsl)