FtpDataAsyncConn (Waarp All 3.6.2-jre8 API Reference)

java.lang.Object
- org.waarp.ftp.core.data.FtpDataAsyncConn

```
public class FtpDataAsyncConn
extends Object
```
Main class that handles Data connection using asynchronous connection with Netty

Constructor Summary

Constructors
Constructor and Description

FtpDataAsyncConn(FtpSession session)
Constructor for Active session by default

Constructors
Constructor and Description
`FtpDataAsyncConn(FtpSession session)` Constructor for Active session by default

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkCorrectChannel(io.netty.channel.Channel channel)`
`void`	`clear()` Clear the Data Connection
`io.netty.channel.Channel`	`getCurrentDataChannel()` Return the current Data Channel
`DataNetworkHandler`	`getDataNetworkHandler()`
`FtpTransferControl`	`getFtpTransferControl()`
`InetSocketAddress`	`getLocalAddress()`
`int`	`getLocalPort()`
`FtpArgumentCode.TransferMode`	`getMode()`
`static int`	`getNewPassivePort(FtpConfiguration configuration)`
`InetSocketAddress`	`getRemoteAddress()`
`int`	`getRemotePort()`
`String`	`getStatus()`
`FtpArgumentCode.TransferStructure`	`getStructure()`
`FtpArgumentCode.TransferSubType`	`getSubType()`
`FtpArgumentCode.TransferType`	`getType()`
`boolean`	`initPassiveConnection()` Initialize the socket from Server side (only used in Passive)
`boolean`	`isActive()` Is the Data dataChannel connected
`boolean`	`isBind()`
`boolean`	`isFileStreamBlockAsciiImage()`
`boolean`	`isPassiveMode()`
`boolean`	`isStreamFile()`
`void`	`setActive(InetSocketAddress address)` Change to active connection (reset localPort to default)
`void`	`setDataNetworkHandler(DataNetworkHandler dataNetworkHandler)`
`void`	`setLocalPort(int localPort)` Set the Local Port (Active or Passive)
`void`	`setMode(FtpArgumentCode.TransferMode transferMode)`
`void`	`setNewOpenedDataChannel(io.netty.channel.Channel dataChannel)` Set the new connected Data Channel
`void`	`setPassive()` Change to passive connection (all necessaries informations like local port should have been set)
`void`	`setStructure(FtpArgumentCode.TransferStructure transferStructure)`
`void`	`setSubType(FtpArgumentCode.TransferSubType transferSubType)`
`void`	`setType(FtpArgumentCode.TransferType transferType)`
`String`	`toString()`
`void`	`unbindData()` Unbind connection when close the Data Channel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FtpDataAsyncConn
```
public FtpDataAsyncConn(FtpSession session)
```
    Constructor for Active session by default
    
    Parameters:
    
    session -
- Method Detail
  - checkCorrectChannel
```
public final boolean checkCorrectChannel(io.netty.channel.Channel channel)
```
    Parameters:
    
    channel -
    
    Returns:
    
    True if the given channel is the same as the one currently registered
  - clear
```
public final void clear()
```
    Clear the Data Connection
  - setLocalPort
```
public final void setLocalPort(int localPort)
```
    Set the Local Port (Active or Passive)
    
    Parameters:
    
    localPort -
  - getLocalAddress
```
public final InetSocketAddress getLocalAddress()
```
    Returns:
    
    the local address
  - getRemoteAddress
```
public final InetSocketAddress getRemoteAddress()
```
    Returns:
    
    the remote address
  - getRemotePort
```
public final int getRemotePort()
```
    Returns:
    
    the remotePort
  - getLocalPort
```
public final int getLocalPort()
```
    Returns:
    
    the localPort
  - setActive
```
public final void setActive(InetSocketAddress address)
```
    Change to active connection (reset localPort to default)
    
    Parameters:
    
    address - remote address
  - setPassive
```
public final void setPassive()
```
    Change to passive connection (all necessaries informations like local port should have been set)
  - isPassiveMode
```
public final boolean isPassiveMode()
```
    Returns:
    
    the passiveMode
  - isBind
```
public final boolean isBind()
```
    Returns:
    
    True if the connection is bind (active = connected, passive = not necessarily connected)
  - isActive
```
public final boolean isActive()
```
    Is the Data dataChannel connected
    
    Returns:
    
    True if the dataChannel is connected
  - getMode
```
public final FtpArgumentCode.TransferMode getMode()
```
    Returns:
    
    the transferMode
  - setMode
```
public final void setMode(FtpArgumentCode.TransferMode transferMode)
```
    Parameters:
    
    transferMode - the transferMode to set
  - getStructure
```
public final FtpArgumentCode.TransferStructure getStructure()
```
    Returns:
    
    the transferStructure
  - setStructure
```
public final void setStructure(FtpArgumentCode.TransferStructure transferStructure)
```
    Parameters:
    
    transferStructure - the transferStructure to set
  - getSubType
```
public final FtpArgumentCode.TransferSubType getSubType()
```
    Returns:
    
    the transferSubType
  - setSubType
```
public final void setSubType(FtpArgumentCode.TransferSubType transferSubType)
```
    Parameters:
    
    transferSubType - the transferSubType to set
  - getType
```
public final FtpArgumentCode.TransferType getType()
```
    Returns:
    
    the transferType
  - setType
```
public final void setType(FtpArgumentCode.TransferType transferType)
```
    Parameters:
    
    transferType - the transferType to set
  - isFileStreamBlockAsciiImage
```
public final boolean isFileStreamBlockAsciiImage()
```
    Returns:
    
    True if the current mode for data connection is FileInterface + (Stream or Block) + (Ascii or Image)
  - isStreamFile
```
public final boolean isStreamFile()
```
    Returns:
    
    True if the current mode for data connection is Stream
  - unbindData
```
public final void unbindData()
```
    Unbind connection when close the Data Channel
  - initPassiveConnection
```
public final boolean initPassiveConnection()
                                    throws Reply425Exception
```
    Initialize the socket from Server side (only used in Passive)
    
    Returns:
    
    True if OK
    
    Throws:
    
    Reply425Exception
  - getCurrentDataChannel
```
public final io.netty.channel.Channel getCurrentDataChannel()
                                                     throws FtpNoConnectionException
```
    Return the current Data Channel
    
    Returns:
    
    the current Data Channel
    
    Throws:
    
    FtpNoConnectionException
  - getDataNetworkHandler
```
public final DataNetworkHandler getDataNetworkHandler()
                                               throws FtpNoConnectionException
```
    Returns:
    
    the DataNetworkHandler
    
    Throws:
    
    FtpNoConnectionException
  - setDataNetworkHandler
```
public final void setDataNetworkHandler(DataNetworkHandler dataNetworkHandler)
```
    Parameters:
    
    dataNetworkHandler - the DataNetworkHandler to set
  - getNewPassivePort
```
public static int getNewPassivePort(FtpConfiguration configuration)
```
    Parameters:
    
    configuration -
    
    Returns:
    
    a new Passive Port
  - getStatus
```
public final String getStatus()
```
    Returns:
    
    The current status in String of the different parameters
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getFtpTransferControl
```
public final FtpTransferControl getFtpTransferControl()
```
    Returns:
    
    the FtpTransferControl
  - setNewOpenedDataChannel
```
public final void setNewOpenedDataChannel(io.netty.channel.Channel dataChannel)
                                   throws Reply425Exception
```
    Set the new connected Data Channel
    
    Parameters:
    
    dataChannel - the new Data Channel
    
    Throws:
    
    Reply425Exception

Class FtpDataAsyncConn

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FtpDataAsyncConn

Method Detail

checkCorrectChannel

clear

setLocalPort

getLocalAddress

getRemoteAddress

getRemotePort

getLocalPort

setActive

setPassive

isPassiveMode

isBind

isActive

getMode

setMode

getStructure

setStructure

getSubType

setSubType

getType

setType

isFileStreamBlockAsciiImage

isStreamFile

unbindData

initPassiveConnection

getCurrentDataChannel

getDataNetworkHandler

setDataNetworkHandler

getNewPassivePort

getStatus

toString

getFtpTransferControl

setNewOpenedDataChannel