org.apache.ftpserver
Interface DataConnectionConfiguration

All Known Implementing Classes:
DefaultDataConnectionConfiguration

public interface DataConnectionConfiguration

Data connection configuration interface.

Version:
$Rev: 729474 $, $Date: 2008-12-26 11:09:07 +0100 (Fri, 26 Dec 2008) $
Author:
The Apache MINA Project (dev@mina.apache.org)

Method Summary
 java.lang.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.
 java.lang.String getPassiveAddress()
          Get passive server address.
 java.lang.String getPassiveExernalAddress()
          Get the passive address that will be returned to clients on the PASV command.
 java.lang.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()
           
 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

java.lang.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

java.lang.String getPassiveAddress()
Get passive server address. null, if not set in the configuration.

Returns:
The InetAddress used for passive connections

getPassiveExernalAddress

java.lang.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

java.lang.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: Defaults to using any available port

Returns:
The passive ports string

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


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.