org.apache.ftpserver

Interface DataConnectionConfiguration

public interface DataConnectionConfiguration

Data connection configuration interface.

Author:

Apache MINA Project

Method Summary

Modifier and Type	Method and Description
String	getActiveLocalAddress() Get the active data connection local host.
int	getActiveLocalPort() Get the active data connection local port.
int	getIdleTime() Get the maximum idle time in seconds.
String	getPassiveAddress() Get passive server address.
String	getPassiveExernalAddress() Get the passive address that will be returned to clients on the PASV command.
String	getPassivePorts() Get the passive ports to be used for data connections.
SslConfiguration	getSslConfiguration() Get SSL configuration for this data connection.
boolean	isActiveEnabled() Is active data connection enabled?
boolean	isActiveIpCheck() Check the PORT IP with the client 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 passive port.
int	requestPassivePort() Request a passive port.

Method Detail

getIdleTime

int getIdleTime()

Get the maximum idle time in seconds.

Returns:

The maximum idle time

isActiveEnabled

boolean isActiveEnabled()

Is active data connection enabled?

Returns:

true if active data connections are enabled

isActiveIpCheck

boolean isActiveIpCheck()

Check the PORT IP with the client IP?

Returns:

true if the PORT IP is verified

getActiveLocalAddress

String getActiveLocalAddress()

Get the active data connection local host.

Returns:

The InetAddress for active connections

getActiveLocalPort

int getActiveLocalPort()

Get the active data connection local port.

Returns:

The active data connection local port

getPassiveAddress

String getPassiveAddress()

Get passive server address. null, if not set in the configuration.

Returns:

The InetAddress used for passive connections

getPassiveExernalAddress

String getPassiveExernalAddress()

Get the passive address that will be returned to clients on the PASV command.

Returns:

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

getPassivePorts

String getPassivePorts()

Get the passive ports to be used for data connections. Ports can be defined as single ports, closed or open ranges. Multiple definitions can be separated by commas, for example:

• 2300 : only use port 2300 as the passive port
• 2300-2399 : use all ports in the range
• 2300- : use all ports larger than 2300
• 2300, 2305, 2400- : use 2300 or 2305 or any port larger than 2400

Defaults to using any available port

Returns:

The passive ports string

isPassiveIpCheck

boolean isPassiveIpCheck()

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

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

int requestPassivePort()

Request a passive port. Will block until a port is available

Returns:

A free passive part

releasePassivePort

void releasePassivePort(int port)

Release passive port.

Parameters:

port - The port to be released

getSslConfiguration

SslConfiguration getSslConfiguration()

Get SSL configuration for this data connection.

Returns:

The SslConfiguration

isImplicitSsl

boolean isImplicitSsl()

Returns:

True if SSL is mandatory for the data channel