FtpConfiguration (Waarp All 3.6.2-jre8 API Reference)

java.lang.Object
- org.waarp.ftp.core.config.FtpConfiguration

Direct Known Subclasses:

FileBasedConfiguration, FileBasedConfiguration
```
public abstract class FtpConfiguration
extends Object
```
Abstract class for configuration

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`delayLimit` Delay in ms between two checks
`static io.netty.util.AttributeKey<FtpSession>`	`FTP_SESSION_ATTRIBUTE_KEY`
`static String`	`FTP_SESSION_ATTRIBUTE_KEY_NAME`
`static Object`	`ftpConfiguration` Global Accessor
`protected long`	`serverChannelReadLimit` Limit in Read byte/s to apply by session to the FTP Server
`protected long`	`serverChannelWriteLimit` Limit in Write byte/s to apply by session to the FTP Server
`protected long`	`serverGlobalReadLimit` Limit in Read byte/s to apply globally to the FTP Server
`protected long`	`serverGlobalWriteLimit` Limit in Write byte/s to apply globally to the FTP Server

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`FtpConfiguration(Class<?> classtype, Class<? extends BusinessHandler> businessHandler, Class<? extends DataBusinessHandler> dataBusinessHandler, FileParameterInterface fileParameter)` Simple constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bindLock()` In bind/unbind operation, lock
`void`	`bindUnlock()` In bind/unbind operation, unlock
`void`	`changeNetworkLimit(long writeLimit, long readLimit)` Reset the global monitor for bandwidth limitation and change future channel monitors with values divided by 10 (channel = global / 10)
`boolean`	`checkPassword(String password)` Check the password for Shutdown
`void`	`computeNbThreads()` Compute number of threads for both client and server from the real number of available processors (double + 1) if the value is less than 64 threads.
`void`	`delFtpSession(InetAddress ipOnly, InetSocketAddress fullIp)` Remove the FtpSession
`int`	`getActivePassiveMode()`
`String`	`getBaseDirectory()`
`int`	`getBlocksize()`
`int`	`getClientThread()`
`Class<? extends DataBusinessHandler>`	`getDataBusinessHandler()`
`static long`	`getDataTimeoutCon()`
`long`	`getDelayLimit()`
`FileParameterInterface`	`getFileParameter()`
`File`	`getFileProperty(String key)`
`FtpInternalConfiguration`	`getFtpInternalConfiguration()`
`FtpSession`	`getFtpSession(io.netty.channel.Channel channel, boolean active)` Return and remove the FtpSession
`int`	`getIntProperty(String key)`
`int`	`getMaxGlobalMemory()`
`abstract int`	`getNextRangePort()` Return the next available port for passive connections.
`Object`	`getProperty(String key)`
`String`	`getServerAddress()`
`long`	`getServerChannelReadLimit()`
`long`	`getServerChannelWriteLimit()`
`long`	`getServerGlobalReadLimit()`
`long`	`getServerGlobalWriteLimit()`
`int`	`getServerPort()`
`int`	`getServerThread()`
`WaarpShutdownHook.ShutdownConfiguration`	`getShutdownConfiguration()`
`String`	`getStringProperty(String key)`
`long`	`getTimeoutCon()`
`String`	`getUniqueExtension()`
`abstract void`	`inShutdownProcess()` Shutdown process is on going
`boolean`	`isDeleteOnAbort()`
`boolean`	`isShutdown()`
`void`	`releaseResources()` To use if any external resources are to be released when shutting down
`void`	`serverStartup()` Init internal configuration
`void`	`setActivePassiveMode(int activePassiveModeArg)`
`void`	`setBaseDirectory(String dir)`
`void`	`setBlocksize(int bLOCKSIZE)`
`void`	`setClientThread(int clientThread0)`
`static void`	`setDataTimeoutCon(long dATATIMEOUTCON)`
`void`	`setDeleteOnAbort(boolean deleteOnAbort)`
`void`	`setFileProperty(String key, File f)`
`void`	`setIntProperty(String key, int i)`
`void`	`setMaxGlobalMemory(int maxGlobalMemory)`
`void`	`setNewFtpSession(InetAddress ipOnly, InetSocketAddress fullIp, FtpSession session)` Add a session from a couple of addresses
`void`	`setPassword(String password)`
`void`	`setProperty(String key, Object o)`
`void`	`setServerAddress(String address)`
`void`	`setServerPort(int port)`
`void`	`setServerThread(int serverThread0)`
`void`	`setShutdown(boolean isShutdown)`
`void`	`setStringProperty(String key, String s)`
`void`	`setTimeoutCon(long tIMEOUTCON)`

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

- Field Detail
  - FTP_SESSION_ATTRIBUTE_KEY_NAME
```
public static final String FTP_SESSION_ATTRIBUTE_KEY_NAME
```
    See Also:
    
    Constant Field Values
  - FTP_SESSION_ATTRIBUTE_KEY
```
public static final io.netty.util.AttributeKey<FtpSession> FTP_SESSION_ATTRIBUTE_KEY
```
  - ftpConfiguration
```
public static Object ftpConfiguration
```
    Global Accessor
  - serverGlobalWriteLimit
```
protected long serverGlobalWriteLimit
```
    Limit in Write byte/s to apply globally to the FTP Server
  - serverGlobalReadLimit
```
protected long serverGlobalReadLimit
```
    Limit in Read byte/s to apply globally to the FTP Server
  - serverChannelWriteLimit
```
protected long serverChannelWriteLimit
```
    Limit in Write byte/s to apply by session to the FTP Server
  - serverChannelReadLimit
```
protected long serverChannelReadLimit
```
    Limit in Read byte/s to apply by session to the FTP Server
  - delayLimit
```
protected long delayLimit
```
    Delay in ms between two checks
- Constructor Detail
  - FtpConfiguration
```
protected FtpConfiguration(Class<?> classtype,
                           Class<? extends BusinessHandler> businessHandler,
                           Class<? extends DataBusinessHandler> dataBusinessHandler,
                           FileParameterInterface fileParameter)
```
    Simple constructor
    
    Parameters:
    
    classtype - Owner
    
    businessHandler - class that will be used for BusinessHandler
    
    dataBusinessHandler - class that will be used for DataBusinessHandler
    
    fileParameter - the FileParameterInterface to used
- Method Detail
  - getStringProperty
```
public final String getStringProperty(String key)
                               throws FtpUnknownFieldException
```
    Parameters:
    
    key -
    
    Returns:
    
    The String property associated to the key
    
    Throws:
    
    FtpUnknownFieldException
  - getIntProperty
```
public final int getIntProperty(String key)
                         throws FtpUnknownFieldException
```
    Parameters:
    
    key -
    
    Returns:
    
    The Integer property associated to the key
    
    Throws:
    
    FtpUnknownFieldException
  - getFileProperty
```
public final File getFileProperty(String key)
                           throws FtpUnknownFieldException
```
    Parameters:
    
    key -
    
    Returns:
    
    The File associated to the key
    
    Throws:
    
    FtpUnknownFieldException
  - getProperty
```
public final Object getProperty(String key)
                         throws FtpUnknownFieldException
```
    Parameters:
    
    key -
    
    Returns:
    
    The Object property associated to the key
    
    Throws:
    
    FtpUnknownFieldException
  - getServerPort
```
public final int getServerPort()
```
    Returns:
    
    the TCP Port to listen in the Ftp Server
  - getServerAddress
```
public final String getServerAddress()
```
    Returns:
    
    the Address of the Ftp Server if any (may be null)
  - getServerGlobalWriteLimit
```
public final long getServerGlobalWriteLimit()
```
    Returns:
    
    the limit in Write byte/s to apply globally to the Ftp Server
  - getServerChannelWriteLimit
```
public final long getServerChannelWriteLimit()
```
    Returns:
    
    the limit in Write byte/s to apply for each session to the Ftp Server
  - getServerGlobalReadLimit
```
public final long getServerGlobalReadLimit()
```
    Returns:
    
    the limit in Read byte/s to apply globally to the Ftp Server
  - getServerChannelReadLimit
```
public final long getServerChannelReadLimit()
```
    Returns:
    
    the limit in Read byte/s to apply for each session to the Ftp Server
  - getDelayLimit
```
public final long getDelayLimit()
```
    Returns:
    
    the delayLimit to apply between two check
  - checkPassword
```
public boolean checkPassword(String password)
```
    Check the password for Shutdown
    
    Parameters:
    
    password -
    
    Returns:
    
    True if the password is OK
  - getNextRangePort
```
public abstract int getNextRangePort()
```
    Return the next available port for passive connections.
    
    Returns:
    
    the next available Port for Passive connections
  - getBaseDirectory
```
public final String getBaseDirectory()
```
    Returns:
    
    the Base Directory of this Ftp Server
  - setStringProperty
```
public final void setStringProperty(String key,
                                    String s)
```
    Parameters:
    
    key -
    
    s -
  - setIntProperty
```
public final void setIntProperty(String key,
                                 int i)
```
    Parameters:
    
    key -
    
    i -
  - setFileProperty
```
public final void setFileProperty(String key,
                                  File f)
```
    Parameters:
    
    key -
    
    f -
  - setProperty
```
public final void setProperty(String key,
                              Object o)
```
    Parameters:
    
    key -
    
    o -
  - setServerPort
```
public final void setServerPort(int port)
```
    Parameters:
    
    port - the new port
  - setServerAddress
```
public final void setServerAddress(String address)
```
    Parameters:
    
    address - the address to use while answering for address
  - setBaseDirectory
```
public final void setBaseDirectory(String dir)
```
    Parameters:
    
    dir - the new base directory
  - setPassword
```
public final void setPassword(String password)
```
    Parameters:
    
    password - the new password for shutdown
  - getDataBusinessHandler
```
public final Class<? extends DataBusinessHandler> getDataBusinessHandler()
```
    Returns:
    
    the dataBusinessHandler
  - serverStartup
```
public final void serverStartup()
                         throws FtpNoConnectionException
```
    Init internal configuration
    
    Throws:
    
    FtpNoConnectionException
  - changeNetworkLimit
```
public final void changeNetworkLimit(long writeLimit,
                                     long readLimit)
```
    Reset the global monitor for bandwidth limitation and change future channel monitors with values divided by 10 (channel = global / 10)
    
    Parameters:
    
    writeLimit -
    
    readLimit -
  - computeNbThreads
```
public final void computeNbThreads()
```
    Compute number of threads for both client and server from the real number of available processors (double + 1) if the value is less than 64 threads.
  - bindLock
```
public final void bindLock()
```
    In bind/unbind operation, lock
  - bindUnlock
```
public final void bindUnlock()
```
    In bind/unbind operation, unlock
  - getFtpInternalConfiguration
```
public final FtpInternalConfiguration getFtpInternalConfiguration()
```
    Returns:
    
    the FtpInternalConfiguration
  - setNewFtpSession
```
public final void setNewFtpSession(InetAddress ipOnly,
                                   InetSocketAddress fullIp,
                                   FtpSession session)
```
    Add a session from a couple of addresses
    
    Parameters:
    
    ipOnly -
    
    fullIp -
    
    session -
  - getFtpSession
```
public final FtpSession getFtpSession(io.netty.channel.Channel channel,
                                      boolean active)
```
    Return and remove the FtpSession
    
    Parameters:
    
    channel -
    
    active -
    
    Returns:
    
    the FtpSession if it exists associated to this channel
  - delFtpSession
```
public final void delFtpSession(InetAddress ipOnly,
                                InetSocketAddress fullIp)
```
    Remove the FtpSession
    
    Parameters:
    
    ipOnly -
    
    fullIp -
  - getFileParameter
```
public final FileParameterInterface getFileParameter()
```
    Returns:
    
    the fileParameter
  - getUniqueExtension
```
public final String getUniqueExtension()
```
  - releaseResources
```
public void releaseResources()
```
    To use if any external resources are to be released when shutting down
  - inShutdownProcess
```
public abstract void inShutdownProcess()
```
    Shutdown process is on going
  - isShutdown
```
public final boolean isShutdown()
```
    Returns:
    
    the isShutdown
  - setShutdown
```
public final void setShutdown(boolean isShutdown)
```
    Parameters:
    
    isShutdown - the isShutdown to set
  - getServerThread
```
public final int getServerThread()
```
    Returns:
    
    the sERVER_THREAD
  - setServerThread
```
public final void setServerThread(int serverThread0)
```
    Parameters:
    
    serverThread0 - the sERVER_THREAD to set
  - getClientThread
```
public final int getClientThread()
```
    Returns:
    
    the cLIENT_THREAD
  - setClientThread
```
public final void setClientThread(int clientThread0)
```
    Parameters:
    
    clientThread0 - the cLIENT_THREAD to set
  - getTimeoutCon
```
public final long getTimeoutCon()
```
    Returns:
    
    the tIMEOUTCON
  - setTimeoutCon
```
public final void setTimeoutCon(long tIMEOUTCON)
```
    Parameters:
    
    tIMEOUTCON - the tIMEOUTCON to set
  - getBlocksize
```
public final int getBlocksize()
```
    Returns:
    
    the bLOCKSIZE
  - setBlocksize
```
public final void setBlocksize(int bLOCKSIZE)
```
    Parameters:
    
    bLOCKSIZE - the bLOCKSIZE to set
  - isDeleteOnAbort
```
public final boolean isDeleteOnAbort()
```
    Returns:
    
    the deleteOnAbort
  - setDeleteOnAbort
```
public final void setDeleteOnAbort(boolean deleteOnAbort)
```
    Parameters:
    
    deleteOnAbort - the deleteOnAbort to set
  - getDataTimeoutCon
```
public static long getDataTimeoutCon()
```
    Returns:
    
    the dATATIMEOUTCON
  - setDataTimeoutCon
```
public static void setDataTimeoutCon(long dATATIMEOUTCON)
```
    Parameters:
    
    dATATIMEOUTCON - the dATATIMEOUTCON to set
  - getActivePassiveMode
```
public final int getActivePassiveMode()
```
    Returns:
    
    the active (1) or passive (-1) or both (0) mode
  - setActivePassiveMode
```
public final void setActivePassiveMode(int activePassiveModeArg)
```
    Parameters:
    
    activePassiveModeArg - the mode to set (1 = Active, -1 = Passive, 0 = Both - default -)
  - getMaxGlobalMemory
```
public final int getMaxGlobalMemory()
```
    Returns:
    
    the maxGlobalMemory
  - setMaxGlobalMemory
```
public final void setMaxGlobalMemory(int maxGlobalMemory)
```
    Parameters:
    
    maxGlobalMemory - the maxGlobalMemory to set
  - getShutdownConfiguration
```
public final WaarpShutdownHook.ShutdownConfiguration getShutdownConfiguration()
```
    Returns:
    
    the shutdownConfiguration

Class FtpConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FTP_SESSION_ATTRIBUTE_KEY_NAME

FTP_SESSION_ATTRIBUTE_KEY

ftpConfiguration

serverGlobalWriteLimit

serverGlobalReadLimit

serverChannelWriteLimit

serverChannelReadLimit

delayLimit

Constructor Detail

FtpConfiguration

Method Detail

getStringProperty

getIntProperty

getFileProperty

getProperty

getServerPort

getServerAddress

getServerGlobalWriteLimit

getServerChannelWriteLimit

getServerGlobalReadLimit

getServerChannelReadLimit

getDelayLimit

checkPassword

getNextRangePort

getBaseDirectory

setStringProperty

setIntProperty

setFileProperty

setProperty

setServerPort

setServerAddress

setBaseDirectory

setPassword

getDataBusinessHandler

serverStartup

changeNetworkLimit

computeNbThreads

bindLock

bindUnlock

getFtpInternalConfiguration

setNewFtpSession

getFtpSession

delFtpSession

getFileParameter

getUniqueExtension

releaseResources

inShutdownProcess

isShutdown

setShutdown

getServerThread

setServerThread

getClientThread

setClientThread

getTimeoutCon

setTimeoutCon

getBlocksize

setBlocksize

isDeleteOnAbort

setDeleteOnAbort

getDataTimeoutCon

setDataTimeoutCon

getActivePassiveMode

setActivePassiveMode

getMaxGlobalMemory

setMaxGlobalMemory

getShutdownConfiguration