org.apache.ftpserver.impl
Class IODataConnectionFactory

java.lang.Object
  extended by org.apache.ftpserver.impl.IODataConnectionFactory
All Implemented Interfaces:
DataConnectionFactory, ServerDataConnectionFactory

public class IODataConnectionFactory
extends Object
implements ServerDataConnectionFactory

Internal class, do not use directly. We can get the FTP data connection using this class. It uses either PORT or PASV command.

Author:
Apache MINA Project

Constructor Summary
IODataConnectionFactory(FtpServerContext serverContext, FtpIoSession session)
           
 
Method Summary
 void closeDataConnection()
          Close data socket.
 void dispose()
          Dispose data connection - close all the sockets.
 InetAddress getInetAddress()
          Get client address.
 int getPort()
          Get port number.
 void initActiveDataConnection(InetSocketAddress address)
          Port command.
 InetSocketAddress initPassiveDataConnection()
          Initiate a data connection in passive mode (server listening).
 boolean isSecure()
          Is secure?
 boolean isTimeout(long currTime)
          Check the data connection idle status.
 boolean isZipMode()
          Is zip mode?
 DataConnection openConnection()
          Open an active data connection
 void setSecure(boolean secure)
          Set the security protocol.
 void setServerControlAddress(InetAddress serverControlAddress)
          Sets the server's control address.
 void setZipMode(boolean zip)
          Set zip mode.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IODataConnectionFactory

public IODataConnectionFactory(FtpServerContext serverContext,
                               FtpIoSession session)
Method Detail

closeDataConnection

public void closeDataConnection()
Close data socket. This method must be idempotent as we might call it multiple times during disconnect.

Specified by:
closeDataConnection in interface DataConnectionFactory

initActiveDataConnection

public void initActiveDataConnection(InetSocketAddress address)
Port command.

Specified by:
initActiveDataConnection in interface ServerDataConnectionFactory

initPassiveDataConnection

public InetSocketAddress initPassiveDataConnection()
                                            throws DataConnectionException
Initiate a data connection in passive mode (server listening).

Specified by:
initPassiveDataConnection in interface ServerDataConnectionFactory
Returns:
The InetSocketAddress on which the data connection if bound.
Throws:
DataConnectionException

getInetAddress

public InetAddress getInetAddress()
Description copied from interface: ServerDataConnectionFactory
Get client address.

Specified by:
getInetAddress in interface ServerDataConnectionFactory

getPort

public int getPort()
Description copied from interface: ServerDataConnectionFactory
Get port number.

Specified by:
getPort in interface ServerDataConnectionFactory

openConnection

public DataConnection openConnection()
                              throws Exception
Description copied from interface: DataConnectionFactory
Open an active data connection

Specified by:
openConnection in interface DataConnectionFactory
Returns:
The open data connection
Throws:
Exception

isSecure

public boolean isSecure()
Description copied from interface: ServerDataConnectionFactory
Is secure?

Specified by:
isSecure in interface DataConnectionFactory
Specified by:
isSecure in interface ServerDataConnectionFactory
Returns:
true if the data socket will be secured

setSecure

public void setSecure(boolean secure)
Set the security protocol.

Specified by:
setSecure in interface ServerDataConnectionFactory

isZipMode

public boolean isZipMode()
Description copied from interface: ServerDataConnectionFactory
Is zip mode?

Specified by:
isZipMode in interface ServerDataConnectionFactory

setZipMode

public void setZipMode(boolean zip)
Set zip mode.

Specified by:
setZipMode in interface ServerDataConnectionFactory

isTimeout

public boolean isTimeout(long currTime)
Check the data connection idle status.

Specified by:
isTimeout in interface ServerDataConnectionFactory

dispose

public void dispose()
Dispose data connection - close all the sockets.

Specified by:
dispose in interface ServerDataConnectionFactory

setServerControlAddress

public void setServerControlAddress(InetAddress serverControlAddress)
Sets the server's control address.

Specified by:
setServerControlAddress in interface ServerDataConnectionFactory


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