FtpConfiguration (WaarpFtp 3.0.7 API Reference)

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

Direct Known Subclasses:

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

Author:

Frederic Bregier

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`delayLimit` Delay in ms between two checks
`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
Constructor and Description
`FtpConfiguration(Class<?> classtype, Class<? extends BusinessHandler> businessHandler, Class<? extends DataBusinessHandler> dataBusinessHandler, org.waarp.common.file.FileParameterInterface fileParameter)` Simple constructor

Method Summary

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
`String`	`getBaseDirectory()`
`int`	`getBLOCKSIZE()`
`int`	`getCLIENT_THREAD()`
`Class<? extends DataBusinessHandler>`	`getDataBusinessHandler()`
`static long`	`getDATATIMEOUTCON()`
`long`	`getDelayLimit()`
`org.waarp.common.file.FileParameterInterface`	`getFileParameter()`
`File`	`getFileProperty(String key)`
`FtpInternalConfiguration`	`getFtpInternalConfiguration()`
`FtpSession`	`getFtpSession(io.netty.channel.Channel channel, boolean active)` Return and remove the FtpSession
`FtpSession`	`getFtpSessionNoRemove(io.netty.channel.Channel channel, boolean active)` Return the FtpSession
`int`	`getIntProperty(String key)`
`Lock`	`getLock()`
`long`	`getMaxGlobalMemory()`
`abstract int`	`getNextRangePort()` Return the next available port for passive connections.
`Object`	`getProperty(String key)`
`int`	`getSERVER_THREAD()`
`String`	`getServerAddress()`
`long`	`getServerChannelReadLimit()`
`long`	`getServerChannelWriteLimit()`
`long`	`getServerGlobalReadLimit()`
`long`	`getServerGlobalWriteLimit()`
`int`	`getServerPort()`
`org.waarp.common.utility.WaarpShutdownHook.ShutdownConfiguration`	`getShutdownConfiguration()`
`String`	`getStringProperty(String key)`
`long`	`getTIMEOUTCON()`
`String`	`getUniqueExtension()`
`boolean`	`hasFtpSession(InetAddress ipOnly, InetSocketAddress fullIp)` Test if the couple of addresses is already in the context
`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`	`setBaseDirectory(String dir)`
`void`	`setBLOCKSIZE(int bLOCKSIZE)`
`void`	`setCLIENT_THREAD(int cLIENT_THREAD)`
`static void`	`setDATATIMEOUTCON(long dATATIMEOUTCON)`
`void`	`setDeleteOnAbort(boolean deleteOnAbort)`
`void`	`setFileProperty(String key, File f)`
`void`	`setIntProperty(String key, int i)`
`void`	`setMaxGlobalMemory(long 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`	`setSERVER_THREAD(int sERVER_THREAD)`
`void`	`setServerAddress(String address)`
`void`	`setServerPort(int port)`
`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
  - 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
```
public FtpConfiguration(Class<?> classtype,
                Class<? extends BusinessHandler> businessHandler,
                Class<? extends DataBusinessHandler> dataBusinessHandler,
                org.waarp.common.file.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 String getStringProperty(String key)
                         throws FtpUnknownFieldException
```
    Parameters:
    key -
    
    Returns:
    The String property associated to the key
    
    Throws:
    
    FtpUnknownFieldException
  - getIntProperty
```
public int getIntProperty(String key)
                   throws FtpUnknownFieldException
```
    Parameters:
    key -
    
    Returns:
    The Integer property associated to the key
    
    Throws:
    
    FtpUnknownFieldException
  - getFileProperty
```
public File getFileProperty(String key)
                     throws FtpUnknownFieldException
```
    Parameters:
    key -
    
    Returns:
    The File associated to the key
    
    Throws:
    
    FtpUnknownFieldException
  - getProperty
```
public Object getProperty(String key)
                   throws FtpUnknownFieldException
```
    Parameters:
    key -
    
    Returns:
    The Object property associated to the key
    
    Throws:
    
    FtpUnknownFieldException
  - getServerPort
```
public int getServerPort()
```
    Returns:
    the TCP Port to listen in the Ftp Server
  - getServerAddress
```
public String getServerAddress()
```
    Returns:
    the Address of the Ftp Server if any (may be null)
  - getServerGlobalWriteLimit
```
public long getServerGlobalWriteLimit()
```
    Returns:
    the limit in Write byte/s to apply globally to the Ftp Server
  - getServerChannelWriteLimit
```
public long getServerChannelWriteLimit()
```
    Returns:
    the limit in Write byte/s to apply for each session to the Ftp Server
  - getServerGlobalReadLimit
```
public long getServerGlobalReadLimit()
```
    Returns:
    the limit in Read byte/s to apply globally to the Ftp Server
  - getServerChannelReadLimit
```
public long getServerChannelReadLimit()
```
    Returns:
    the limit in Read byte/s to apply for each session to the Ftp Server
  - getDelayLimit
```
public 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 String getBaseDirectory()
```
    Returns:
    the Base Directory of this Ftp Server
  - setStringProperty
```
public void setStringProperty(String key,
                     String s)
```
    Parameters:
    key -
    s -
  - setIntProperty
```
public void setIntProperty(String key,
                  int i)
```
    Parameters:
    key -
    i -
  - setFileProperty
```
public void setFileProperty(String key,
                   File f)
```
    Parameters:
    key -
    f -
  - setProperty
```
public void setProperty(String key,
               Object o)
```
    Parameters:
    key -
    o -
  - setServerPort
```
public void setServerPort(int port)
```
    Parameters:
    port - the new port
  - setServerAddress
```
public void setServerAddress(String address)
```
    Parameters:
    address - the address to use while answering for address
  - setBaseDirectory
```
public void setBaseDirectory(String dir)
```
    Parameters:
    dir - the new base directory
  - setPassword
```
public void setPassword(String password)
```
    Parameters:
    password - the new password for shutdown
  - getDataBusinessHandler
```
public Class<? extends DataBusinessHandler> getDataBusinessHandler()
```
    Returns:
    the dataBusinessHandler
  - serverStartup
```
public void serverStartup()
                   throws FtpNoConnectionException
```
    Init internal configuration
    
    Throws:
    
    FtpNoConnectionException
  - changeNetworkLimit
```
public 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 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.
  - getLock
```
public Lock getLock()
```
    Returns:
    the lock on configuration
  - bindLock
```
public void bindLock()
```
    In bind/unbind operation, lock
  - bindUnlock
```
public void bindUnlock()
```
    In bind/unbind operation, unlock
  - getFtpInternalConfiguration
```
public FtpInternalConfiguration getFtpInternalConfiguration()
```
    Returns:
    the FtpInternalConfiguration
  - setNewFtpSession
```
public void setNewFtpSession(InetAddress ipOnly,
                    InetSocketAddress fullIp,
                    FtpSession session)
```
    Add a session from a couple of addresses
    
    Parameters:
    ipOnly -
    fullIp -
    session -
  - getFtpSession
```
public 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
  - getFtpSessionNoRemove
```
public FtpSession getFtpSessionNoRemove(io.netty.channel.Channel channel,
                               boolean active)
```
    Return the FtpSession
    
    Parameters:
    channel -
    active -
    
    Returns:
    the FtpSession if it exists associated to this channel
  - delFtpSession
```
public void delFtpSession(InetAddress ipOnly,
                 InetSocketAddress fullIp)
```
    Remove the FtpSession
    
    Parameters:
    ipOnly -
    fullIp -
  - hasFtpSession
```
public boolean hasFtpSession(InetAddress ipOnly,
                    InetSocketAddress fullIp)
```
    Test if the couple of addresses is already in the context
    
    Parameters:
    ipOnly -
    fullIp -
    
    Returns:
    True if the couple is present
  - getFileParameter
```
public org.waarp.common.file.FileParameterInterface getFileParameter()
```
    Returns:
    the fileParameter
  - getUniqueExtension
```
public 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 boolean isShutdown()
```
    Returns:
    the isShutdown
  - setShutdown
```
public void setShutdown(boolean isShutdown)
```
    Parameters:
    isShutdown - the isShutdown to set
  - getSERVER_THREAD
```
public int getSERVER_THREAD()
```
    Returns:
    the sERVER_THREAD
  - setSERVER_THREAD
```
public void setSERVER_THREAD(int sERVER_THREAD)
```
    Parameters:
    sERVER_THREAD - the sERVER_THREAD to set
  - getCLIENT_THREAD
```
public int getCLIENT_THREAD()
```
    Returns:
    the cLIENT_THREAD
  - setCLIENT_THREAD
```
public void setCLIENT_THREAD(int cLIENT_THREAD)
```
    Parameters:
    cLIENT_THREAD - the cLIENT_THREAD to set
  - getTIMEOUTCON
```
public long getTIMEOUTCON()
```
    Returns:
    the tIMEOUTCON
  - setTIMEOUTCON
```
public void setTIMEOUTCON(long tIMEOUTCON)
```
    Parameters:
    tIMEOUTCON - the tIMEOUTCON to set
  - getBLOCKSIZE
```
public int getBLOCKSIZE()
```
    Returns:
    the bLOCKSIZE
  - setBLOCKSIZE
```
public void setBLOCKSIZE(int bLOCKSIZE)
```
    Parameters:
    bLOCKSIZE - the bLOCKSIZE to set
  - isDeleteOnAbort
```
public boolean isDeleteOnAbort()
```
    Returns:
    the deleteOnAbort
  - setDeleteOnAbort
```
public 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
  - getMaxGlobalMemory
```
public long getMaxGlobalMemory()
```
    Returns:
    the maxGlobalMemory
  - setMaxGlobalMemory
```
public void setMaxGlobalMemory(long maxGlobalMemory)
```
    Parameters:
    maxGlobalMemory - the maxGlobalMemory to set
  - getShutdownConfiguration
```
public org.waarp.common.utility.WaarpShutdownHook.ShutdownConfiguration getShutdownConfiguration()
```
    Returns:
    the shutdownConfiguration

Class FtpConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

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

getLock

bindLock

bindUnlock

getFtpInternalConfiguration

setNewFtpSession

getFtpSession

getFtpSessionNoRemove

delFtpSession

hasFtpSession

getFileParameter

getUniqueExtension

releaseResources

inShutdownProcess

isShutdown

setShutdown

getSERVER_THREAD

setSERVER_THREAD

getCLIENT_THREAD

setCLIENT_THREAD

getTIMEOUTCON

setTIMEOUTCON

getBLOCKSIZE

setBLOCKSIZE

isDeleteOnAbort

setDeleteOnAbort

getDATATIMEOUTCON

setDATATIMEOUTCON

getMaxGlobalMemory

setMaxGlobalMemory

getShutdownConfiguration