org.waarp.gateway.ftp.config

Class FileBasedConfiguration

java.lang.Object

org.waarp.ftp.core.config.FtpConfiguration

org.waarp.gateway.ftp.config.FileBasedConfiguration

public class FileBasedConfiguration
extends org.waarp.ftp.core.config.FtpConfiguration

FtpConfiguration based on a XML file

Author:

Frederic Bregier

Field Summary

Fields

Modifier and Type	Field and Description
String	ADMINNAME Admin name Id
org.waarp.snmp.WaarpSnmpAgent	agentSnmp SNMP Agent (if any)
FtpConstraintLimitHandler	constraintLimitHandler Limit on CPU and Connection
org.waarp.common.crypto.Des	cryptoKey Crypto Key
long	delayLimit Delay in ms between two checks
static FileBasedConfiguration	fileBasedConfiguration Use to access directly the configuration
FtpPrivateMib	ftpMib Associated MIB
String	HOST_ID FTP server ID
String	httpBasePath Http Admin base
FtpMonitoring	monitoring Monitoring object
String	snmpConfig Monitoring: snmp configuration file (empty means no snmp support)
boolean	useHttpCompression Does this server will try to compress HTTP connections
boolean	useLocalExec Does this server will use Waarp LocalExec Daemon for Execute
static String	XML_DELAYRETRIEVE_COMMAND DELAY RETRIEVE COMMAND
static String	XML_DELAYSTORE_COMMAND DELAY STORE COMMAND
static String	XML_RETRIEVE_COMMAND RETRIEVE COMMAND
static String	XML_STORE_COMMAND STORE COMMAND

Fields inherited from class org.waarp.ftp.core.config.FtpConfiguration

serverChannelReadLimit, serverChannelWriteLimit, serverGlobalReadLimit, serverGlobalWriteLimit

Constructor Summary

Constructors

Constructor and Description
FileBasedConfiguration(Class<?> classtype, Class<? extends org.waarp.ftp.core.control.BusinessHandler> businessHandler, Class<? extends org.waarp.ftp.core.data.handler.DataBusinessHandler> dataBusinessHandler, org.waarp.common.file.FileParameterInterface fileParameter)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkPassword(String password) Check the password for Shutdown
void	configureConstraint() Configure ConstraintLimitHandler
void	configureHttps() Configure HTTPS
void	configureLExec() Configure LocalExec
void	configureSnmp() Configure the SNMP support if needed
String	getAuthenticationFile()
String	getHtmlAuth(String format)
String	getHtmlTransfer(String format, int limit) Only available with Database support for Waarp
io.netty.channel.group.ChannelGroup	getHttpChannelGroup()
io.netty.util.concurrent.EventExecutorGroup	getHttpPipelineExecutor()
int	getNextRangePort()
SimpleAuth	getSimpleAuth(String user)
boolean	initializeAuthent(String filename, boolean purge) Initialize Authentication from current authenticationFile
void	inShutdownProcess()
protected boolean	loadSsl()
void	releaseResources()
boolean	saveAuthenticationFile(String filename) Export the Authentication to the original files
void	setAuthenticationFile(String authenticationFile)
boolean	setConfigurationServerFromXml(String filename) Initiate the configuration from the xml file for server
void	setSERVERKEY(byte[] serverkey)

Methods inherited from class org.waarp.ftp.core.config.FtpConfiguration

bindLock, bindUnlock, changeNetworkLimit, computeNbThreads, delFtpSession, getBaseDirectory, getBLOCKSIZE, getCLIENT_THREAD, getDataBusinessHandler, getDATATIMEOUTCON, getDelayLimit, getFileParameter, getFileProperty, getFtpInternalConfiguration, getFtpSession, getFtpSessionNoRemove, getIntProperty, getLock, getMaxGlobalMemory, getProperty, getSERVER_THREAD, getServerAddress, getServerChannelReadLimit, getServerChannelWriteLimit, getServerGlobalReadLimit, getServerGlobalWriteLimit, getServerPort, getShutdownConfiguration, getStringProperty, getTIMEOUTCON, getUniqueExtension, hasFtpSession, isDeleteOnAbort, isShutdown, serverStartup, setBaseDirectory, setBLOCKSIZE, setCLIENT_THREAD, setDATATIMEOUTCON, setDeleteOnAbort, setFileProperty, setIntProperty, setMaxGlobalMemory, setNewFtpSession, setPassword, setProperty, setSERVER_THREAD, setServerAddress, setServerPort, setShutdown, setStringProperty, setTIMEOUTCON

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XML_RETRIEVE_COMMAND

public static final String XML_RETRIEVE_COMMAND

RETRIEVE COMMAND

See Also:

Constant Field Values

XML_STORE_COMMAND

public static final String XML_STORE_COMMAND

STORE COMMAND

See Also:

Constant Field Values

XML_DELAYRETRIEVE_COMMAND

public static final String XML_DELAYRETRIEVE_COMMAND

DELAY RETRIEVE COMMAND

See Also:

Constant Field Values

XML_DELAYSTORE_COMMAND

public static final String XML_DELAYSTORE_COMMAND

DELAY STORE COMMAND

See Also:

Constant Field Values

fileBasedConfiguration

public static FileBasedConfiguration fileBasedConfiguration

Use to access directly the configuration

httpBasePath

public String httpBasePath

Http Admin base

delayLimit

public long delayLimit

Delay in ms between two checks

useHttpCompression

public boolean useHttpCompression

Does this server will try to compress HTTP connections

useLocalExec

public boolean useLocalExec

Does this server will use Waarp LocalExec Daemon for Execute

cryptoKey

public org.waarp.common.crypto.Des cryptoKey

Crypto Key

HOST_ID

public String HOST_ID

FTP server ID

ADMINNAME

public String ADMINNAME

Admin name Id

constraintLimitHandler

public FtpConstraintLimitHandler constraintLimitHandler

Limit on CPU and Connection

snmpConfig

public String snmpConfig

Monitoring: snmp configuration file (empty means no snmp support)

agentSnmp

public org.waarp.snmp.WaarpSnmpAgent agentSnmp

SNMP Agent (if any)

ftpMib

public FtpPrivateMib ftpMib

Associated MIB

monitoring

public FtpMonitoring monitoring

Monitoring object

Constructor Detail

FileBasedConfiguration

public FileBasedConfiguration(Class<?> classtype,
                      Class<? extends org.waarp.ftp.core.control.BusinessHandler> businessHandler,
                      Class<? extends org.waarp.ftp.core.data.handler.DataBusinessHandler> dataBusinessHandler,
                      org.waarp.common.file.FileParameterInterface fileParameter)

Parameters:

classtype -

businessHandler - class that will be used for BusinessHandler

dataBusinessHandler - class that will be used for DataBusinessHandler

fileParameter - the FileParameter to use

Method Detail

loadSsl

protected boolean loadSsl()

setConfigurationServerFromXml

public boolean setConfigurationServerFromXml(String filename)

Initiate the configuration from the xml file for server

Parameters:

filename -

Returns:

True if OK

configureHttps

public void configureHttps()

Configure HTTPS

configureConstraint

public void configureConstraint()

Configure ConstraintLimitHandler

configureLExec

public void configureLExec()

Configure LocalExec

configureSnmp

public void configureSnmp()
                   throws org.waarp.ftp.core.exception.FtpNoConnectionException

Configure the SNMP support if needed

Throws:

org.waarp.ftp.core.exception.FtpNoConnectionException

setSERVERKEY

public void setSERVERKEY(byte[] serverkey)

Parameters:

serverkey - the SERVERADMINKEY to set

checkPassword

public boolean checkPassword(String password)

Check the password for Shutdown

Overrides:

checkPassword in class org.waarp.ftp.core.config.FtpConfiguration

Parameters:

password -

Returns:

True if the password is OK

initializeAuthent

public boolean initializeAuthent(String filename,
                        boolean purge)

Initialize Authentication from current authenticationFile

Parameters:

filename - the filename from which authentication will be loaded

purge - if True, the current authentications are totally replaced by the new ones

Returns:

True if OK

saveAuthenticationFile

public boolean saveAuthenticationFile(String filename)

Export the Authentication to the original files

Parameters:

filename - the filename where the authentication will be exported

Returns:

True if successful

getSimpleAuth

public SimpleAuth getSimpleAuth(String user)

Parameters:

user -

Returns:

the SimpleAuth if any for this user

getHtmlAuth

public String getHtmlAuth(String format)

Parameters:

format - Format in HTML to use as ouput format

Returns:

the Html String containing the table of all Authentication entries

getHtmlTransfer

public String getHtmlTransfer(String format,
                     int limit)

Only available with Database support for Waarp

Parameters:

format - Format in HTML to use as ouput format

limit - number of TransferLog to populate

Returns:

the Html String containing the table of all Transfer entries

getNextRangePort

public int getNextRangePort()

Specified by:

getNextRangePort in class org.waarp.ftp.core.config.FtpConfiguration

See Also:

FtpConfiguration.getNextRangePort()

getHttpPipelineExecutor

public io.netty.util.concurrent.EventExecutorGroup getHttpPipelineExecutor()

Returns:

the httpPipelineExecutor

getHttpChannelGroup

public io.netty.channel.group.ChannelGroup getHttpChannelGroup()

Returns:

the httpChannelGroup

releaseResources

public void releaseResources()

Overrides:

releaseResources in class org.waarp.ftp.core.config.FtpConfiguration

inShutdownProcess

public void inShutdownProcess()

Specified by:

inShutdownProcess in class org.waarp.ftp.core.config.FtpConfiguration

getAuthenticationFile

public String getAuthenticationFile()

Returns:

the authenticationFile

setAuthenticationFile

public void setAuthenticationFile(String authenticationFile)

Parameters:

authenticationFile - the authenticationFile to set