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 FtpConfiguration

FtpConfiguration based on a XML file

Field Summary

Fields

Modifier and Type	Field and Description
static FileBasedConfiguration	fileBasedConfiguration Use to access directly the configuration
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

delayLimit, FTP_SESSION_ATTRIBUTE_KEY, FTP_SESSION_ATTRIBUTE_KEY_NAME, ftpConfiguration, serverChannelReadLimit, serverChannelWriteLimit, serverGlobalReadLimit, serverGlobalWriteLimit

Constructor Summary

Constructors

Constructor and Description
FileBasedConfiguration(Class<?> classtype, Class<? extends BusinessHandler> businessHandler, Class<? extends DataBusinessHandler> dataBusinessHandler, FileParameterInterface fileParameter)

Method Summary

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	getAdminName()
WaarpSnmpAgent	getAgentSnmp()
String	getAuthenticationFile()
FtpConstraintLimitHandler	getConstraintLimitHandler()
Des	getCryptoKey()
FtpPrivateMib	getFtpMib()
String	getHostId()
String	getHtmlAuth(String format)
String	getHtmlTransfer(String format, int limit) Only available with Database support for Waarp
String	getHttpBasePath()
io.netty.channel.group.ChannelGroup	getHttpChannelGroup()
io.netty.util.concurrent.EventExecutorGroup	getHttpPipelineExecutor()
FtpMonitoring	getMonitoring()
int	getNextRangePort() Return the next available port for passive connections.
SimpleAuth	getSimpleAuth(String user)
String	getSnmpConfig()
boolean	initializeAuthent(String filename, boolean purge) Initialize Authentication from current authenticationFile
void	inShutdownProcess() Shutdown process is on going
boolean	isUseHttpCompression()
boolean	isUseLocalExec()
protected boolean	loadSsl()
void	releaseResources() To use if any external resources are to be released when shutting down
boolean	saveAuthenticationFile(String filename) Export the Authentication to the original files
void	setAdminName(String adminName)
void	setAgentSnmp(WaarpSnmpAgent agentSnmp)
void	setAuthenticationFile(String authenticationFile)
boolean	setConfigurationServerFromXml(String filename) Initiate the configuration from the xml file for server
void	setConstraintLimitHandler(FtpConstraintLimitHandler constraintLimitHandler)
void	setCryptoKey(Des cryptoKey)
void	setFtpMib(FtpPrivateMib ftpMib)
void	setHostId(String hostId)
void	setHttpBasePath(String httpBasePath)
void	setMonitoring(FtpMonitoring monitoring)
void	setSERVERKEY(byte[] serverkey)
void	setSnmpConfig(String snmpConfig)
void	setUseHttpCompression(boolean useHttpCompression)
void	setUseLocalExec(boolean useLocalExec)

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

bindLock, bindUnlock, changeNetworkLimit, computeNbThreads, delFtpSession, getActivePassiveMode, getBaseDirectory, getBlocksize, getClientThread, getDataBusinessHandler, getDataTimeoutCon, getDelayLimit, getFileParameter, getFileProperty, getFtpInternalConfiguration, getFtpSession, getIntProperty, getMaxGlobalMemory, getProperty, getServerAddress, getServerChannelReadLimit, getServerChannelWriteLimit, getServerGlobalReadLimit, getServerGlobalWriteLimit, getServerPort, getServerThread, getShutdownConfiguration, getStringProperty, getTimeoutCon, getUniqueExtension, isDeleteOnAbort, isShutdown, serverStartup, setActivePassiveMode, setBaseDirectory, setBlocksize, setClientThread, setDataTimeoutCon, setDeleteOnAbort, setFileProperty, setIntProperty, setMaxGlobalMemory, setNewFtpSession, setPassword, setProperty, setServerAddress, setServerPort, setServerThread, 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

Constructor Detail

FileBasedConfiguration

public FileBasedConfiguration(Class<?> classtype,
                              Class<? extends BusinessHandler> businessHandler,
                              Class<? extends DataBusinessHandler> dataBusinessHandler,
                              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 final boolean loadSsl()

setConfigurationServerFromXml

public final boolean setConfigurationServerFromXml(String filename)

Initiate the configuration from the xml file for server

Parameters:

filename -

Returns:

True if OK

configureHttps

public final void configureHttps()

Configure HTTPS

configureConstraint

public final void configureConstraint()

Configure ConstraintLimitHandler

configureLExec

public final void configureLExec()

Configure LocalExec

configureSnmp

public final void configureSnmp()
                         throws FtpNoConnectionException

Configure the SNMP support if needed

Throws:

FtpNoConnectionException

setSERVERKEY

public final void setSERVERKEY(byte[] serverkey)

Parameters:

serverkey - the SERVERADMINKEY to set

checkPassword

public final boolean checkPassword(String password)

Check the password for Shutdown

Overrides:

checkPassword in class FtpConfiguration

Parameters:

password -

Returns:

True if the password is OK

initializeAuthent

public final 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 final 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 final SimpleAuth getSimpleAuth(String user)

Parameters:

user -

Returns:

the SimpleAuth if any for this user

getHtmlAuth

public final 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 final 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 final int getNextRangePort()

Description copied from class: FtpConfiguration

Return the next available port for passive connections.

Specified by:

getNextRangePort in class FtpConfiguration

Returns:

the next available Port for Passive connections

See Also:

FtpConfiguration.getNextRangePort()

getHttpPipelineExecutor

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

Returns:

the httpPipelineExecutor

getHttpChannelGroup

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

Returns:

the httpChannelGroup

releaseResources

public final void releaseResources()

Description copied from class: FtpConfiguration

To use if any external resources are to be released when shutting down

Overrides:

releaseResources in class FtpConfiguration

inShutdownProcess

public final void inShutdownProcess()

Description copied from class: FtpConfiguration

Shutdown process is on going

Specified by:

inShutdownProcess in class FtpConfiguration

getAuthenticationFile

public final String getAuthenticationFile()

Returns:

the authenticationFile

setAuthenticationFile

public final void setAuthenticationFile(String authenticationFile)

Parameters:

authenticationFile - the authenticationFile to set

getHttpBasePath

public final String getHttpBasePath()

Returns:

the httpBasePath

setHttpBasePath

public final void setHttpBasePath(String httpBasePath)

Parameters:

httpBasePath - the httpBasePath to set

isUseHttpCompression

public final boolean isUseHttpCompression()

Returns:

the useHttpCompression

setUseHttpCompression

public final void setUseHttpCompression(boolean useHttpCompression)

Parameters:

useHttpCompression - the useHttpCompression to set

isUseLocalExec

public final boolean isUseLocalExec()

Returns:

the useLocalExec

setUseLocalExec

public final void setUseLocalExec(boolean useLocalExec)

Parameters:

useLocalExec - the useLocalExec to set

getCryptoKey

public final Des getCryptoKey()

Returns:

the cryptoKey

setCryptoKey

public final void setCryptoKey(Des cryptoKey)

Parameters:

cryptoKey - the cryptoKey to set

getHostId

public final String getHostId()

Returns:

the hostId

setHostId

public final void setHostId(String hostId)

Parameters:

hostId - the hostId to set

getAdminName

public final String getAdminName()

Returns:

the adminName

setAdminName

public final void setAdminName(String adminName)

Parameters:

adminName - the adminName to set

getConstraintLimitHandler

public final FtpConstraintLimitHandler getConstraintLimitHandler()

Returns:

the constraintLimitHandler

setConstraintLimitHandler

public final void setConstraintLimitHandler(FtpConstraintLimitHandler constraintLimitHandler)

Parameters:

constraintLimitHandler - the constraintLimitHandler to set

getSnmpConfig

public final String getSnmpConfig()

Returns:

the snmpConfig

setSnmpConfig

public final void setSnmpConfig(String snmpConfig)

Parameters:

snmpConfig - the snmpConfig to set

getAgentSnmp

public final WaarpSnmpAgent getAgentSnmp()

Returns:

the agentSnmp

setAgentSnmp

public final void setAgentSnmp(WaarpSnmpAgent agentSnmp)

Parameters:

agentSnmp - the agentSnmp to set

getFtpMib

public final FtpPrivateMib getFtpMib()

Returns:

the ftpMib

setFtpMib

public final void setFtpMib(FtpPrivateMib ftpMib)

Parameters:

ftpMib - the ftpMib to set

getMonitoring

public final FtpMonitoring getMonitoring()

Returns:

the monitoring

setMonitoring

public final void setMonitoring(FtpMonitoring monitoring)

Parameters:

monitoring - the monitoring to set