org.apache.ftpserver

Class DataConnectionConfigurationFactory

java.lang.Object

org.apache.ftpserver.DataConnectionConfigurationFactory

public class DataConnectionConfigurationFactory
extends Object

Data connection factory

Author:

Apache MINA Project

Constructor Summary

Constructors

Constructor and Description
DataConnectionConfigurationFactory()

Method Summary

Modifier and Type	Method and Description
DataConnectionConfiguration	createDataConnectionConfiguration() Create a DataConnectionConfiguration instance based on the configuration on this factory
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	getPassiveExternalAddress() Get the passive address that will be returned to clients on the PASV command.
String	getPassivePorts() Retrieve the passive ports configured for this data connection
SslConfiguration	getSslConfiguration() Get the SslConfiguration to be used by data connections
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.
void	setActiveEnabled(boolean activeEnabled) Set if active data connections are enabled
void	setActiveIpCheck(boolean activeIpCheck) Check the PORT IP with the client IP?
void	setActiveLocalAddress(String activeLocalAddress) Set the active data connection local host.
void	setActiveLocalPort(int activeLocalPort) Set the active data connection local port.
void	setIdleTime(int idleTime) Set the maximum idle time in seconds.
void	setImplicitSsl(boolean implicitSsl) Set whether ssl is required for the data connection
void	setPassiveAddress(String passiveAddress) Set the passive server address.
void	setPassiveExternalAddress(String passiveExternalAddress) Set the passive address that will be returned to clients on the PASV command.
void	setPassiveIpCheck(boolean passiveIpCheck) Sets whether or not IP check is performed before accepting a passive data connection.
void	setPassivePorts(String passivePorts) Set the passive ports to be used for data connections.
void	setSslConfiguration(SslConfiguration ssl) Set the SslConfiguration to be used by data connections

Methods inherited from class java.lang.Object

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

Constructor Detail

DataConnectionConfigurationFactory

public DataConnectionConfigurationFactory()

Method Detail

createDataConnectionConfiguration

public DataConnectionConfiguration createDataConnectionConfiguration()

Create a DataConnectionConfiguration instance based on the configuration on this factory

Returns:

The DataConnectionConfiguration instance

getIdleTime

public int getIdleTime()

Get the maximum idle time in seconds.

Returns:

The maximum idle time

setIdleTime

public void setIdleTime(int idleTime)

Set the maximum idle time in seconds.

Parameters:

idleTime - The maximum idle time

isActiveEnabled

public boolean isActiveEnabled()

Is PORT enabled?

Returns:

true if active data connections are enabled

setActiveEnabled

public void setActiveEnabled(boolean activeEnabled)

Set if active data connections are enabled

Parameters:

activeEnabled - true if active data connections are enabled

isActiveIpCheck

public boolean isActiveIpCheck()

Check the PORT IP?

Returns:

true if the client IP is verified against the PORT IP

setActiveIpCheck

public void setActiveIpCheck(boolean activeIpCheck)

Check the PORT IP with the client IP?

Parameters:

activeIpCheck - true if the PORT IP should be verified

getActiveLocalAddress

public String getActiveLocalAddress()

Get the local address for active mode data transfer.

Returns:

The address used for active data connections

setActiveLocalAddress

public void setActiveLocalAddress(String activeLocalAddress)

Set the active data connection local host.

Parameters:

activeLocalAddress - The address for active connections

getActiveLocalPort

public int getActiveLocalPort()

Get the active local port number.

Returns:

The port used for active data connections

setActiveLocalPort

public void setActiveLocalPort(int activeLocalPort)

Set the active data connection local port.

Parameters:

activeLocalPort - The active data connection local port

getPassiveAddress

public String getPassiveAddress()

Get passive host.

Returns:

The address used for passive data connections

setPassiveAddress

public void setPassiveAddress(String passiveAddress)

Set the passive server address.

Parameters:

passiveAddress - The address used for passive connections

getPassiveExternalAddress

public String getPassiveExternalAddress()

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.

setPassiveExternalAddress

public void setPassiveExternalAddress(String passiveExternalAddress)

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

Parameters:

passiveExternalAddress - The passive address to be returned to clients

isPassiveIpCheck

public 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.

setPassiveIpCheck

public void setPassiveIpCheck(boolean passiveIpCheck)

Sets whether or not IP check is performed before accepting a passive data connection.

Parameters:

passiveIpCheck - whether or not IP check is performed before accepting a passive data connection.

requestPassivePort

public int requestPassivePort()

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

Returns:

A passive port to use

getPassivePorts

public String getPassivePorts()

Retrieve the passive ports configured for this data connection

Returns:

The String of passive ports

setPassivePorts

public void setPassivePorts(String passivePorts)

Set 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

Parameters:

passivePorts - The passive ports string

releasePassivePort

public void releasePassivePort(int port)

Release data port

Parameters:

port - The port to release

getSslConfiguration

public SslConfiguration getSslConfiguration()

Get the SslConfiguration to be used by data connections

Returns:

The SslConfiguration used by data connections

setSslConfiguration

public void setSslConfiguration(SslConfiguration ssl)

Set the SslConfiguration to be used by data connections

Parameters:

ssl - The SslConfiguration

isImplicitSsl

public boolean isImplicitSsl()

Returns:

True if ssl is mandatory for the data connection

setImplicitSsl

public void setImplicitSsl(boolean implicitSsl)

Set whether ssl is required for the data connection

Parameters:

implicitSsl - True if ssl is mandatory for the data connection