public class FTPConfigSection extends ConfigSection
Modifier and Type | Field and Description |
---|---|
static String |
DefaultKeyStoreType |
static String |
DefaultTrustStoreType |
static String |
SectionName |
Constructor and Description |
---|
FTPConfigSection(ServerConfiguration config)
Class constructor
|
Modifier and Type | Method and Description |
---|---|
boolean |
allowAnonymousFTP()
Determine if anonymous FTP access is allowed
|
void |
closeConfig()
Close the configuration section
|
String |
getAnonymousFTPAccount()
Return the anonymous FTP account name
|
FTPAuthenticator |
getFTPAuthenticator()
Return the FTP authenticator interface
|
InetAddress |
getFTPBindAddress()
Return the FTP server bind address, may be null to indicate bind to all available addresses
|
String |
getFTPCharacterSet()
Return the FTP character set
|
int |
getFTPDataPortHigh()
Return the FTP data socket range high value
|
int |
getFTPDataPortLow()
Return the FTP data socket range low value
|
int |
getFTPDebug()
Return the FTP debug flags
|
int |
getFTPPort()
Return the FTP server port to use for incoming connections
|
String |
getFTPRootPath()
Return the FTP root path
|
FTPSiteInterface |
getFTPSiteInterface()
Return the FTP SITE interface
|
int |
getFTPSrvSessionTimeout() |
char[] |
getKeyStorePassphrase()
Return the passphrase for the key store
|
String |
getKeyStorePath()
Return the key store path
|
String |
getKeyStoreType()
Return the key store type
|
char[] |
getTrustStorePassphrase()
Return the passphrase for the trust store
|
String |
getTrustStorePath()
Return the trust store path
|
String |
getTrustStoreType()
Return the trust store type
|
boolean |
hasFTPDataPortRange()
Determine if a port range is set for FTP data sockets
|
boolean |
hasFTPRootPath()
Check if an FTP root path has been configured
|
boolean |
hasFTPSiteInterface()
Determine if the FTP SITE interface is enabled
|
boolean |
isFTPSEnabled()
Check if FTPS support is enabled
|
boolean |
requireSecureSession()
Detemrine if only secure sessions will be allowed to logon
|
int |
setAllowAnonymousFTP(boolean ena)
Enable/disable anonymous FTP access
|
int |
setAnonymousFTPAccount(String acc)
Set the anonymous FTP account name
|
int |
setAuthenticator(FTPAuthenticator auth)
Set the authenticator to be used to authenticate FTP users.
|
int |
setAuthenticator(String authClass,
org.springframework.extensions.config.ConfigElement params)
Set the authenticator to be used to authenticate FTP users.
|
int |
setFTPBindAddress(InetAddress addr)
Set the FTP server bind address, may be null to indicate bind to all available addresses
|
void |
setFTPCharacterSet(String charSet)
Set the FTP character set
|
int |
setFTPDataPortHigh(int port)
Set the FTP server data port range high value
|
int |
setFTPDataPortLow(int port)
Set the FTP server data port range low value
|
int |
setFTPDebug(int dbg)
Set the FTP debug flags
|
int |
setFTPPort(int port)
Set the FTP server port to use for incoming connections, -1 indicates disable the FTP server
|
int |
setFTPRootPath(String path)
Set the FTP root path
|
int |
setFTPSiteInterface(FTPSiteInterface siteInterface)
Set the FTP SITE interface to handle custom FTP commands
|
int |
setFTPSrvSessionTimeout(int timeout)
Set the FTP server session timeout
|
int |
setKeyStorePassphrase(String passphrase)
Set the key store passphrase
|
int |
setKeyStorePath(String path)
Set the key store path
|
int |
setKeyStoreType(String typ)
Set the key store type
|
int |
setRequireSecureSession(boolean reqSecureSess)
Set the require secure session flag
|
int |
setTrustStorePassphrase(String passphrase)
Set the trust store passphrase
|
int |
setTrustStorePath(String path)
Set the trust store path
|
int |
setTrustStoreType(String typ)
Set the trust store type
|
fireConfigurationChange, getSectionName, getServerConfiguration, isUpdated, setUpdated
public static final String SectionName
public static final String DefaultKeyStoreType
public static final String DefaultTrustStoreType
public FTPConfigSection(ServerConfiguration config)
config
- ServerConfigurationpublic final InetAddress getFTPBindAddress()
public final int getFTPPort()
public final int getFTPSrvSessionTimeout()
public final FTPAuthenticator getFTPAuthenticator()
public final boolean allowAnonymousFTP()
public final String getAnonymousFTPAccount()
public final int getFTPDebug()
public final boolean hasFTPRootPath()
public final String getFTPRootPath()
public final boolean hasFTPDataPortRange()
public final int getFTPDataPortLow()
public final int getFTPDataPortHigh()
public final boolean hasFTPSiteInterface()
public final FTPSiteInterface getFTPSiteInterface()
public final String getFTPCharacterSet()
public final boolean isFTPSEnabled()
public final String getKeyStorePath()
public final String getKeyStoreType()
public final String getTrustStorePath()
public final String getTrustStoreType()
public final char[] getKeyStorePassphrase()
public final char[] getTrustStorePassphrase()
public final boolean requireSecureSession()
public final void setFTPCharacterSet(String charSet)
charSet
- Stringpublic final int setFTPBindAddress(InetAddress addr) throws InvalidConfigurationException
addr
- InetAddressInvalidConfigurationException
public final int setFTPPort(int port) throws InvalidConfigurationException
port
- intInvalidConfigurationException
public final int setFTPSrvSessionTimeout(int timeout) throws InvalidConfigurationException
timeout
- intInvalidConfigurationException
public final int setFTPDataPortLow(int port) throws InvalidConfigurationException
port
- intInvalidConfigurationException
public final int setFTPDataPortHigh(int port) throws InvalidConfigurationException
port
- intInvalidConfigurationException
public final int setFTPRootPath(String path) throws InvalidConfigurationException
path
- StringInvalidConfigurationException
public final int setAllowAnonymousFTP(boolean ena) throws InvalidConfigurationException
ena
- booleanInvalidConfigurationException
public final int setAnonymousFTPAccount(String acc) throws InvalidConfigurationException
acc
- StringInvalidConfigurationException
public final int setFTPDebug(int dbg) throws InvalidConfigurationException
dbg
- intInvalidConfigurationException
public final int setFTPSiteInterface(FTPSiteInterface siteInterface) throws InvalidConfigurationException
siteInterface
- FTPSiteInterfaceInvalidConfigurationException
public final int setAuthenticator(String authClass, org.springframework.extensions.config.ConfigElement params) throws InvalidConfigurationException
authClass
- Stringparams
- ConfigElementInvalidConfigurationException
public final int setAuthenticator(FTPAuthenticator auth) throws InvalidConfigurationException
auth
- the authenticatorInvalidConfigurationException
public final int setKeyStorePath(String path) throws InvalidConfigurationException
path
- StringInvalidConfigurationException
public final int setKeyStoreType(String typ) throws InvalidConfigurationException
typ
- StringInvalidConfigurationException
public final int setTrustStorePath(String path) throws InvalidConfigurationException
path
- StringInvalidConfigurationException
public final int setTrustStoreType(String typ) throws InvalidConfigurationException
typ
- StringInvalidConfigurationException
public final int setKeyStorePassphrase(String passphrase) throws InvalidConfigurationException
passphrase
- StringInvalidConfigurationException
public final int setTrustStorePassphrase(String passphrase) throws InvalidConfigurationException
passphrase
- StringInvalidConfigurationException
public final int setRequireSecureSession(boolean reqSecureSess) throws InvalidConfigurationException
reqSecureSess
- booleanInvalidConfigurationException
public final void closeConfig()
closeConfig
in class ConfigSection
Copyright © 2005–2017 Alfresco Software. All rights reserved.