org.waarp.ftp.core.data.handler

Class DataBusinessHandler

java.lang.Object

org.waarp.ftp.core.data.handler.DataBusinessHandler

Direct Known Subclasses:

FileSystemBasedDataBusinessHandler

public abstract class DataBusinessHandler
extends Object

This class is to be implemented in order to allow Business actions according to FTP service

Author:

Frederic Bregier

Constructor Summary

Constructors

Constructor and Description
DataBusinessHandler() Constructor with no argument (mandatory)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	cleanSession() To Clean the session attached objects for Data Network
void	clear() Clean the DataBusinessHandler
abstract void	exceptionLocalCaught(Throwable e) Run when an exception is get before the channel is closed.
abstract void	executeChannelClosed() Is executed when the channel is closed, just before the test on the finish status.
abstract void	executeChannelConnected(io.netty.channel.Channel channel) Is executed when the channel is connected after the handler is on, before answering OK or not on connection, except if the global service is going to shutdown.
DataNetworkHandler	getDataNetworkHandler()
FtpSession	getFtpSession()
void	setDataNetworkHandler(DataNetworkHandler dataNetworkHandler) Call when the DataNetworkHandler is created
void	setFtpSession(FtpSession session) Called when the connection is opened

Methods inherited from class java.lang.Object

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

Constructor Detail

DataBusinessHandler

public DataBusinessHandler()

Constructor with no argument (mandatory)

Method Detail

setDataNetworkHandler

public void setDataNetworkHandler(DataNetworkHandler dataNetworkHandler)

Call when the DataNetworkHandler is created

Parameters:

dataNetworkHandler - the dataNetworkHandler to set

getDataNetworkHandler

public DataNetworkHandler getDataNetworkHandler()

Returns:

the dataNetworkHandler

setFtpSession

public void setFtpSession(FtpSession session)

Called when the connection is opened

Parameters:

session - the session to set

getFtpSession

public FtpSession getFtpSession()

Returns:

the ftpSession

executeChannelClosed

public abstract void executeChannelClosed()

Is executed when the channel is closed, just before the test on the finish status.

cleanSession

protected abstract void cleanSession()

To Clean the session attached objects for Data Network

clear

public void clear()

Clean the DataBusinessHandler

executeChannelConnected

public abstract void executeChannelConnected(io.netty.channel.Channel channel)

Is executed when the channel is connected after the handler is on, before answering OK or not on connection, except if the global service is going to shutdown.

Parameters:

channel -

exceptionLocalCaught

public abstract void exceptionLocalCaught(Throwable e)

Run when an exception is get before the channel is closed.

Parameters:

e -