org.apache.ftpserver.interfaces
Interface DataConnectionConfiguration

All Known Implementing Classes:
DefaultDataConnectionConfiguration

public interface DataConnectionConfiguration

Data connection configuration interface.


Method Summary
 java.net.InetAddress 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.net.InetAddress getPassiveAddress()
          Get passive server address.
 java.net.InetAddress getPassiveExernalAddress()
          Get the passive address that will be returned to clients on the PASV command.
 java.lang.String getPassivePorts()
          Set 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?
 void releasePassivePort(int port)
          Release passive port.
 int requestPassivePort()
          Request a passive port
 void setPassivePorts(java.lang.String passivePorts)
          Set the allowed passive ports.
 

Method Detail

getIdleTime

int getIdleTime()
Get the maximum idle time in seconds.


isActiveEnabled

boolean isActiveEnabled()
Is active data connection enabled?


isActiveIpCheck

boolean isActiveIpCheck()
Check the PORT IP with the client IP?


getActiveLocalAddress

java.net.InetAddress getActiveLocalAddress()
Get the active data connection local host.


getActiveLocalPort

int getActiveLocalPort()
Get the active data connection local port.


getPassiveAddress

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


getPassiveExernalAddress

java.net.InetAddress 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()
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: Defaults to using any available port

Returns:
The passive ports string

setPassivePorts

void setPassivePorts(java.lang.String passivePorts)
Set the allowed passive ports.

Parameters:
passivePorts - The passive ports to use for this data connection
See Also:
for details on the allowed format. If set to null, the passive port with be assigned from any available port

requestPassivePort

int requestPassivePort()
Request a passive port


releasePassivePort

void releasePassivePort(int port)
Release passive port.


getSslConfiguration

SslConfiguration getSslConfiguration()
Get SSL configuration for this data connection.



Copyright © 2003-2008 The Apache Software Foundation. All Rights Reserved.