org.waarp.ftp.core.config

Class FtpInternalConfiguration

java.lang.Object

org.waarp.ftp.core.config.FtpInternalConfiguration

public class FtpInternalConfiguration
extends Object

Internal configuration of the FTP server, related to Netty

Author:

Frederic Bregier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FtpInternalConfiguration.BindAddress

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFERSIZEDEFAULT Default size for buffers (NIO)
static long	RETRYINMS Time elapse for retry in ms
static int	RETRYNB Number of retry before error
static long	WAITFORNETOP Time elapse for WRITE OR CLOSE WAIT elaps in ms

Constructor Summary

Constructors

Constructor and Description
FtpInternalConfiguration(FtpConfiguration configuration) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	bindPassive(InetSocketAddress address, boolean ssl) Try to add a Passive Channel listening to the specified local address
void	delFtpSession(InetAddress ipOnly, InetSocketAddress fullIp) Remove the FtpSession
io.netty.bootstrap.Bootstrap	getActiveBootstrap(boolean ssl)
io.netty.channel.group.ChannelGroup	getCommandChannelGroup()
io.netty.channel.group.ChannelGroup	getDataChannelGroup()
io.netty.util.concurrent.EventExecutorGroup	getDataExecutor() Return the associated Executor for Data Event
io.netty.util.concurrent.EventExecutorGroup	getExecutor() Return the associated Executor for Command Event
FtpSession	getFtpSession(io.netty.channel.Channel channel, boolean active, boolean remove) Return and remove the FtpSession
FtpGlobalTrafficShapingHandler	getGlobalTrafficShapingHandler()
int	getNbBindedPassive()
int	getNumberSessions()
ExecutorService	getWorker()
boolean	hasFtpSession(InetAddress ipOnly, InetSocketAddress fullIp) Test if the couple of addresses is already in the context
boolean	isAcceptAuthProt()
boolean	isUsingNativeSsl()
io.netty.handler.traffic.ChannelTrafficShapingHandler	newChannelTrafficShapingHandler()
void	releaseResources()
void	serverStartup() Startup the server
void	setAcceptAuthProt(boolean acceptAuthProt)
void	setNewFtpSession(InetAddress ipOnly, InetSocketAddress fullIp, FtpSession session) Add a session from a couple of addresses
void	setUsingNativeSsl(boolean usingNativeSsl)
void	unbindPassive(InetSocketAddress address) Try to unbind (closing the parent channel) the Passive Channel listening to the specified local address if the last one.

Methods inherited from class java.lang.Object

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

Field Detail

RETRYINMS

public static final long RETRYINMS

Time elapse for retry in ms

See Also:

Constant Field Values

RETRYNB

public static final int RETRYNB

Number of retry before error

See Also:

Constant Field Values

WAITFORNETOP

public static final long WAITFORNETOP

Time elapse for WRITE OR CLOSE WAIT elaps in ms

See Also:

Constant Field Values

BUFFERSIZEDEFAULT

public static final int BUFFERSIZEDEFAULT

Default size for buffers (NIO)

See Also:

Constant Field Values

Constructor Detail

FtpInternalConfiguration

public FtpInternalConfiguration(FtpConfiguration configuration)

Constructor

Parameters:

configuration -

Method Detail

serverStartup

public void serverStartup()
                   throws FtpNoConnectionException

Startup the server

Throws:

FtpNoConnectionException

getWorker

public ExecutorService getWorker()

Returns:

an ExecutorService

setNewFtpSession

public void setNewFtpSession(InetAddress ipOnly,
                    InetSocketAddress fullIp,
                    FtpSession session)

Add a session from a couple of addresses

Parameters:

ipOnly -

fullIp -

session -

getFtpSession

public FtpSession getFtpSession(io.netty.channel.Channel channel,
                       boolean active,
                       boolean remove)

Return and remove the FtpSession

Parameters:

channel -

active -

Returns:

the FtpSession if it exists associated to this channel

delFtpSession

public void delFtpSession(InetAddress ipOnly,
                 InetSocketAddress fullIp)

Remove the FtpSession

Parameters:

ipOnly -

fullIp -

hasFtpSession

public boolean hasFtpSession(InetAddress ipOnly,
                    InetSocketAddress fullIp)

Test if the couple of addresses is already in the context

Parameters:

ipOnly -

fullIp -

Returns:

True if the couple is present

getNumberSessions

public int getNumberSessions()

Returns:

the number of Active Sessions

bindPassive

public void bindPassive(InetSocketAddress address,
               boolean ssl)
                 throws org.waarp.common.command.exception.Reply425Exception

Try to add a Passive Channel listening to the specified local address

Parameters:

address -

ssl -

Throws:

org.waarp.common.command.exception.Reply425Exception - in case the channel cannot be opened

unbindPassive

public void unbindPassive(InetSocketAddress address)

Try to unbind (closing the parent channel) the Passive Channel listening to the specified local address if the last one. It returns only when the underlying parent channel is closed if this was the last session that wants to open on this local address.

Parameters:

address -

getNbBindedPassive

public int getNbBindedPassive()

Returns:

the number of Binded Passive Connections

getExecutor

public io.netty.util.concurrent.EventExecutorGroup getExecutor()

Return the associated Executor for Command Event

Returns:

the Command Event Executor

getDataExecutor

public io.netty.util.concurrent.EventExecutorGroup getDataExecutor()

Return the associated Executor for Data Event

Returns:

the Data Event Executor

getActiveBootstrap

public io.netty.bootstrap.Bootstrap getActiveBootstrap(boolean ssl)

Parameters:

ssl -

Returns:

the ActiveBootstrap

getCommandChannelGroup

public io.netty.channel.group.ChannelGroup getCommandChannelGroup()

Returns:

the commandChannelGroup

getDataChannelGroup

public io.netty.channel.group.ChannelGroup getDataChannelGroup()

Returns:

the dataChannelGroup

getGlobalTrafficShapingHandler

public FtpGlobalTrafficShapingHandler getGlobalTrafficShapingHandler()

Returns:

The TrafficCounterFactory

newChannelTrafficShapingHandler

public io.netty.handler.traffic.ChannelTrafficShapingHandler newChannelTrafficShapingHandler()

Returns:

a new ChannelTrafficShapingHandler

releaseResources

public void releaseResources()

isAcceptAuthProt

public boolean isAcceptAuthProt()

isUsingNativeSsl

public boolean isUsingNativeSsl()

Returns:

the usingNativeSsl

setUsingNativeSsl

public void setUsingNativeSsl(boolean usingNativeSsl)

Parameters:

usingNativeSsl - the usingNativeSsl to set

setAcceptAuthProt

public void setAcceptAuthProt(boolean acceptAuthProt)

Parameters:

acceptAuthProt - the acceptAuthProt to set