org.apache.ftpserver.impl

Class DefaultDataConnectionConfiguration

java.lang.Object

org.apache.ftpserver.impl.DefaultDataConnectionConfiguration

All Implemented Interfaces:

DataConnectionConfiguration

public class DefaultDataConnectionConfiguration
extends Object
implements DataConnectionConfiguration

Internal class, do not use directly. Data connection configuration.

Author:

Apache MINA Project

Constructor Summary

Constructors

Constructor and Description
DefaultDataConnectionConfiguration(int idleTime, SslConfiguration ssl, boolean activeEnabled, boolean activeIpCheck, String activeLocalAddress, int activeLocalPort, String passiveAddress, PassivePorts passivePorts, String passiveExternalAddress, boolean passiveIpCheck, boolean implicitSsl) Internal constructor, do not use directly.

Method Summary

Modifier and Type	Method and Description
String	getActiveLocalAddress() Get the local address for active mode data transfer.
int	getActiveLocalPort() Get the active local port number.
int	getIdleTime() Get the maximum idle time in seconds.
String	getPassiveAddress() Get passive host.
String	getPassiveExernalAddress() Get external passive host.
String	getPassivePorts() Retrive the passive ports configured for this data connection
SslConfiguration	getSslConfiguration() Get SSL component.
boolean	isActiveEnabled() Is PORT enabled?
boolean	isActiveIpCheck() Check the PORT IP?
boolean	isImplicitSsl()
boolean	isPassiveIpCheck() Tells whether or not IP address check is performed when accepting a passive data connection.
void	releasePassivePort(int port) Release data port
int	requestPassivePort() Get passive data port.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDataConnectionConfiguration

public DefaultDataConnectionConfiguration(int idleTime,
                                          SslConfiguration ssl,
                                          boolean activeEnabled,
                                          boolean activeIpCheck,
                                          String activeLocalAddress,
                                          int activeLocalPort,
                                          String passiveAddress,
                                          PassivePorts passivePorts,
                                          String passiveExternalAddress,
                                          boolean passiveIpCheck,
                                          boolean implicitSsl)

Internal constructor, do not use directly. Use DataConnectionConfigurationFactory instead.

Method Detail

getIdleTime

public int getIdleTime()

Get the maximum idle time in seconds.

Specified by:

getIdleTime in interface DataConnectionConfiguration

Returns:

The maximum idle time

isActiveEnabled

public boolean isActiveEnabled()

Is PORT enabled?

Specified by:

isActiveEnabled in interface DataConnectionConfiguration

Returns:

true if active data connections are enabled

isActiveIpCheck

public boolean isActiveIpCheck()

Check the PORT IP?

Specified by:

isActiveIpCheck in interface DataConnectionConfiguration

Returns:

true if the PORT IP is verified

getActiveLocalAddress

public String getActiveLocalAddress()

Get the local address for active mode data transfer.

Specified by:

getActiveLocalAddress in interface DataConnectionConfiguration

Returns:

The InetAddress for active connections

getActiveLocalPort

public int getActiveLocalPort()

Get the active local port number.

Specified by:

getActiveLocalPort in interface DataConnectionConfiguration

Returns:

The active data connection local port

getPassiveAddress

public String getPassiveAddress()

Get passive host.

Specified by:

getPassiveAddress in interface DataConnectionConfiguration

Returns:

The InetAddress used for passive connections

getPassiveExernalAddress

public String getPassiveExernalAddress()

Get external passive host.

Specified by:

getPassiveExernalAddress in interface DataConnectionConfiguration

Returns:

The passive address to be returned to clients, null if not configured.

isPassiveIpCheck

public boolean isPassiveIpCheck()

Description copied from interface: DataConnectionConfiguration

Tells whether or not IP address check is performed when accepting a passive data connection.

Specified by:

isPassiveIpCheck in interface DataConnectionConfiguration

Returns:

true, if the IP address checking is enabled; false, otherwise. A value of true means that site to site transfers are disabled. In other words, a passive data connection MUST be made from the same IP address that issued the PASV command.

requestPassivePort

public int requestPassivePort()

Get passive data port. Data port number zero (0) means that any available port will be used.

Specified by:

requestPassivePort in interface DataConnectionConfiguration

Returns:

A free passive part

getPassivePorts

public String getPassivePorts()

Retrive the passive ports configured for this data connection

Specified by:

getPassivePorts in interface DataConnectionConfiguration

Returns:

The String of passive ports

releasePassivePort

public void releasePassivePort(int port)

Release data port

Specified by:

releasePassivePort in interface DataConnectionConfiguration

Parameters:

port - The port to be released

getSslConfiguration

public SslConfiguration getSslConfiguration()

Get SSL component.

Specified by:

getSslConfiguration in interface DataConnectionConfiguration

Returns:

The SslConfiguration

isImplicitSsl

public boolean isImplicitSsl()

Specified by:

isImplicitSsl in interface DataConnectionConfiguration

Returns:

True if SSL is mandatory for the data channel

See Also:

DataConnectionConfiguration.isImplicitSsl()