Skip navigation links
A C D E F G I L M N O P R S U V 

A

AbstractCommand - Class in org.apache.ftpserver.command
Common base class recommended for Command implementations
AbstractCommand() - Constructor for class org.apache.ftpserver.command.AbstractCommand
 
accept(IoSession) - Method in class org.apache.ftpserver.ipfilter.RemoteIpFilter
 
accept(IoSession) - Method in interface org.apache.ftpserver.ipfilter.SessionFilter
Tells whether or not the given session is accepted by this filter.
add(String) - Method in class org.apache.ftpserver.ipfilter.RemoteIpFilter
Adds the given string representation of InetAddress or CIDR notation to this filter.
addCommand(String, Command) - Method in class org.apache.ftpserver.command.CommandFactoryFactory
Add or override a command.
addListener(String, Listener) - Method in class org.apache.ftpserver.FtpServerFactory
Add a Listener to this factory
AddUser - Class in org.apache.ftpserver.main
Used to add users to the user manager for a particular FtpServer configuration
AddUser() - Constructor for class org.apache.ftpserver.main.AddUser
Instance methods only used internaly
AnonymousAuthentication - Class in org.apache.ftpserver.usermanager
Class representing an anonymous authentication attempt
AnonymousAuthentication() - Constructor for class org.apache.ftpserver.usermanager.AnonymousAuthentication
Default constructor
AnonymousAuthentication(UserMetadata) - Constructor for class org.apache.ftpserver.usermanager.AnonymousAuthentication
Constructor with an additional user metadata parameter

C

ClearTextPasswordEncryptor - Class in org.apache.ftpserver.usermanager
Password encryptor that does no encryption, that is, keps the password in clear text
ClearTextPasswordEncryptor() - Constructor for class org.apache.ftpserver.usermanager.ClearTextPasswordEncryptor
 
ClientAuth - Enum in org.apache.ftpserver.ssl
Enumeration of possible levels of client authentication during an SSL session.
Command - Interface in org.apache.ftpserver.command
This interface encapsulates all the FTP commands.
CommandFactory - Interface in org.apache.ftpserver.command
Command factory interface.
CommandFactoryFactory - Class in org.apache.ftpserver.command
Factory for CommandFactory instances
CommandFactoryFactory() - Constructor for class org.apache.ftpserver.command.CommandFactoryFactory
 
CommandLine - Class in org.apache.ftpserver.main
This class is the starting point for the FtpServer when it is started using the command line mode.
CommandLine() - Constructor for class org.apache.ftpserver.main.CommandLine
The purpose of this class is to allow the final user to start the FtpServer application.
ConnectionConfig - Interface in org.apache.ftpserver
Interface for providing the configuration for the control socket connections.
ConnectionConfigFactory - Class in org.apache.ftpserver
Factory for creating connection configurations
ConnectionConfigFactory() - Constructor for class org.apache.ftpserver.ConnectionConfigFactory
 
createCommandFactory() - Method in class org.apache.ftpserver.command.CommandFactoryFactory
Create an CommandFactory based on the configuration on the factory.
createConnectionConfig() - Method in class org.apache.ftpserver.ConnectionConfigFactory
Create a connection configuration instances based on the configuration on this factory
createDataConnectionConfiguration() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Create a DataConnectionConfiguration instance based on the configuration on this factory
createFileSystemView(User) - Method in class org.apache.ftpserver.filesystem.nativefs.NativeFileSystemFactory
Create the appropriate user file system view.
createListener() - Method in class org.apache.ftpserver.listener.ListenerFactory
Create a listener based on the settings of this factory.
createMessageResource() - Method in class org.apache.ftpserver.message.MessageResourceFactory
Create an MessageResource based on the configuration on this factory
createServer() - Method in class org.apache.ftpserver.FtpServerFactory
Create a DefaultFtpServer instance based on the provided configuration
createSslConfiguration() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Create an instance of SslConfiguration based on the configuration of this factory.
createUser() - Method in class org.apache.ftpserver.usermanager.UserFactory
Creates a user based on the configuration set on the factory
createUserManager() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
 
createUserManager() - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Creates a PropertiesUserManager instance based on the provided configuration
createUserManager() - Method in interface org.apache.ftpserver.usermanager.UserManagerFactory
Create an UserManager instance based on the configuration on the factory

D

Daemon - Class in org.apache.ftpserver.main
Invokes FtpServer as a daemon, running in the background.
Daemon() - Constructor for class org.apache.ftpserver.main.Daemon
 
DataConnectionConfiguration - Interface in org.apache.ftpserver
Data connection configuration interface.
DataConnectionConfigurationFactory - Class in org.apache.ftpserver
Data connection factory
DataConnectionConfigurationFactory() - Constructor for class org.apache.ftpserver.DataConnectionConfigurationFactory
 
DataConnectionException - Exception in org.apache.ftpserver
Thrown if a data connection can not be established
DataConnectionException() - Constructor for exception org.apache.ftpserver.DataConnectionException
Default constructor.
DataConnectionException(String) - Constructor for exception org.apache.ftpserver.DataConnectionException
Constructs a DataConnectionException object with a message.
DataConnectionException(Throwable) - Constructor for exception org.apache.ftpserver.DataConnectionException
Constructs a DataConnectionException object with a Throwable cause.
DataConnectionException(String, Throwable) - Constructor for exception org.apache.ftpserver.DataConnectionException
Constructs a DataConnectionException object with a Throwable cause.
DbUserManagerFactory - Class in org.apache.ftpserver.usermanager
Factory for database backed UserManager instances.
DbUserManagerFactory() - Constructor for class org.apache.ftpserver.usermanager.DbUserManagerFactory
 

E

encrypt(String) - Method in class org.apache.ftpserver.usermanager.ClearTextPasswordEncryptor
Returns the clear text password
encrypt(String) - Method in class org.apache.ftpserver.usermanager.Md5PasswordEncryptor
Hashes the password using MD5
encrypt(String) - Method in interface org.apache.ftpserver.usermanager.PasswordEncryptor
Encrypts the password
encrypt(String) - Method in class org.apache.ftpserver.usermanager.SaltedPasswordEncryptor
Encrypts the password using a salt concatenated with the password and a series of MD5 steps.
execute(FtpIoSession, FtpServerContext, FtpRequest) - Method in interface org.apache.ftpserver.command.Command
Execute command.
execute(FtpIoSession, FtpServerContext, FtpRequest) - Method in class org.apache.ftpserver.command.NotSupportedCommand
Execute command

F

FtpletContainer - Interface in org.apache.ftpserver.ftpletcontainer
Interface describing an Ftplet container.
FtpServer - Interface in org.apache.ftpserver
This is the starting point of all the servers.
FtpServerConfigurationException - Exception in org.apache.ftpserver
Exception used during startup to indicate that the configuration is not correct.
FtpServerConfigurationException() - Constructor for exception org.apache.ftpserver.FtpServerConfigurationException
FtpServerConfigurationException(String, Throwable) - Constructor for exception org.apache.ftpserver.FtpServerConfigurationException
FtpServerConfigurationException(String) - Constructor for exception org.apache.ftpserver.FtpServerConfigurationException
FtpServerConfigurationException(Throwable) - Constructor for exception org.apache.ftpserver.FtpServerConfigurationException
FtpServerFactory - Class in org.apache.ftpserver
This is the starting point of all the servers.
FtpServerFactory() - Constructor for class org.apache.ftpserver.FtpServerFactory
Creates a server with the default configuration

G

getActiveLocalAddress() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Get the active data connection local host.
getActiveLocalAddress() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Get the local address for active mode data transfer.
getActiveLocalPort() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Get the active data connection local port.
getActiveLocalPort() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Get the active local port number.
getActiveSessions() - Method in interface org.apache.ftpserver.listener.Listener
Returns the currently active sessions for this listener.
getAdminName() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Get the admin name.
getAdminName() - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Get the admin name.
getAuthorities() - Method in class org.apache.ftpserver.usermanager.UserFactory
Get the authorities for users created by this factory
getAvailableLanguages() - Method in interface org.apache.ftpserver.message.MessageResource
Get all the available languages.
getBlockedAddresses() - Method in interface org.apache.ftpserver.listener.Listener
Deprecated.
Replaced by IpFilter. Retrieves the InetAddress for which this listener blocks connections.
getBlockedAddresses() - Method in class org.apache.ftpserver.listener.ListenerFactory
Deprecated.
Replaced by the IpFilter. Retrieves the InetAddress for which listeners created by this factory blocks connections
getBlockedSubnets() - Method in interface org.apache.ftpserver.listener.Listener
Deprecated.
Replaced by IpFilter. Retrieves the Subnets for this listener blocks connections.
getBlockedSubnets() - Method in class org.apache.ftpserver.listener.ListenerFactory
Deprecated.
Replaced by the IpFilter. Retrives the Subnets for which listeners created by this factory blocks connections
getClientAuth() - Method in interface org.apache.ftpserver.ssl.SslConfiguration
Return the required client authentication setting
getClientAuth() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Return the required client authentication setting
getCommand(String) - Method in interface org.apache.ftpserver.command.CommandFactory
Get the command instance.
getCommandFactory() - Method in class org.apache.ftpserver.FtpServerFactory
Retrieve the command factory used by servers created by this factory
getCommandMap() - Method in class org.apache.ftpserver.command.CommandFactoryFactory
Get the installed commands
getConfiguration(String[]) - Method in class org.apache.ftpserver.main.CommandLine
Get the configuration object.
getConnectionConfig() - Method in class org.apache.ftpserver.FtpServerFactory
Retrieve the connection configuration this server
getCustomMessageDirectory() - Method in class org.apache.ftpserver.message.MessageResourceFactory
The directory where custom message bundles can be located
getDataConnectionConfiguration() - Method in interface org.apache.ftpserver.listener.Listener
Get configuration for data connections made within this listener
getDataConnectionConfiguration() - Method in class org.apache.ftpserver.listener.ListenerFactory
Get configuration for data connections made within listeners created by this factory
getDataSource() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Retrive the data source used by the user manager
getEnabledCipherSuites() - Method in interface org.apache.ftpserver.ssl.SslConfiguration
Returns the cipher suites that should be enabled for this connection.
getEnabledCipherSuites() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Returns the cipher suites that should be enabled for this connection.
getFile() - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Retrieve the file used to load and store users
getFileSystem() - Method in class org.apache.ftpserver.FtpServerFactory
Retrieve the file system used by servers created by this factory
getFtplet(String) - Method in interface org.apache.ftpserver.ftpletcontainer.FtpletContainer
Retrieve the Ftplet identified by the name (as provided in the #addFtplet(String, Ftplet) method.
getFtplets() - Method in interface org.apache.ftpserver.ftpletcontainer.FtpletContainer
Retrive all Ftplets registered with this container
getFtplets() - Method in class org.apache.ftpserver.FtpServerFactory
Get all Ftplets registered by servers created by this factory
getHomeDirectory() - Method in class org.apache.ftpserver.usermanager.UserFactory
Get the home directory for users created by this factory
getIdleTime() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Get the maximum idle time in seconds.
getIdleTime() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Get the maximum idle time in seconds.
getIdleTimeout() - Method in interface org.apache.ftpserver.listener.Listener
Get the number of seconds during which no network activity is allowed before a session is closed due to inactivity.
getIdleTimeout() - Method in class org.apache.ftpserver.listener.ListenerFactory
Get the number of seconds during which no network activity is allowed before a session is closed due to inactivity.
getKeyAlias() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Get the server key alias to be used for SSL communication
getKeyPassword() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
The password used to load the key
getKeystoreAlgorithm() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
The algorithm used to open the key store.
getKeystoreFile() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
The key store file used by this configuration
getKeystorePassword() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
The password used to load the key store
getKeystoreType() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
The key store type, defaults to @see KeyStore.getDefaultType()
getLanguages() - Method in class org.apache.ftpserver.message.MessageResourceFactory
The languages for which messages are available
getListener(String) - Method in class org.apache.ftpserver.FtpServerFactory
Get a specific Listener identified by its name
getListeners() - Method in class org.apache.ftpserver.FtpServerFactory
Get all listeners available on servers created by this factory
getLoginFailureDelay() - Method in interface org.apache.ftpserver.ConnectionConfig
The delay in number of milliseconds between login failures.
getLoginFailureDelay() - Method in class org.apache.ftpserver.ConnectionConfigFactory
The delay in number of milliseconds between login failures.
getMaxAnonymousLogins() - Method in interface org.apache.ftpserver.ConnectionConfig
The maximum number of time an anonymous user can fail to login before getting disconnected
getMaxAnonymousLogins() - Method in class org.apache.ftpserver.ConnectionConfigFactory
The maximum number of anonymous logins the server would allow at any given time
getMaxIdleTime() - Method in class org.apache.ftpserver.usermanager.UserFactory
Get the max idle time for users created by this factory
getMaxLoginFailures() - Method in interface org.apache.ftpserver.ConnectionConfig
The maximum number of time an user can fail to login before getting disconnected
getMaxLoginFailures() - Method in class org.apache.ftpserver.ConnectionConfigFactory
The maximum number of time an user can fail to login before getting disconnected
getMaxLogins() - Method in interface org.apache.ftpserver.ConnectionConfig
The maximum number of concurrently logged in users
getMaxLogins() - Method in class org.apache.ftpserver.ConnectionConfigFactory
The maximum number of concurrently logged in users
getMaxThreads() - Method in interface org.apache.ftpserver.ConnectionConfig
Returns the maximum number of threads the server is allowed to create for processing client requests.
getMaxThreads() - Method in class org.apache.ftpserver.ConnectionConfigFactory
Returns the maximum number of threads the server is allowed to create for processing client requests.
getMessage(int, String, String) - Method in interface org.apache.ftpserver.message.MessageResource
Get the message for the corresponding code and sub id.
getMessageResource() - Method in class org.apache.ftpserver.FtpServerFactory
Retrieve the message resource used by servers created by this factory
getMessages(String) - Method in interface org.apache.ftpserver.message.MessageResource
Get all the messages.
getName() - Method in class org.apache.ftpserver.usermanager.UserFactory
Get the user name for users created by this factory
getPassiveAddress() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Get passive server address.
getPassiveAddress() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Get passive host.
getPassiveExernalAddress() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Get the passive address that will be returned to clients on the PASV command.
getPassiveExternalAddress() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Get the passive address that will be returned to clients on the PASV command.
getPassivePorts() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Get the passive ports to be used for data connections.
getPassivePorts() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Retrieve the passive ports configured for this data connection
getPassword() - Method in class org.apache.ftpserver.usermanager.UserFactory
Get the password for users created by this factory
getPassword() - Method in class org.apache.ftpserver.usermanager.UsernamePasswordAuthentication
Retrive the password
getPasswordEncryptor() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Retrieve the password encryptor used for this user manager
getPasswordEncryptor() - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Retrieve the password encryptor used by user managers created by this factory
getPort() - Method in interface org.apache.ftpserver.listener.Listener
Get the port on which this listener is waiting for requests.
getPort() - Method in class org.apache.ftpserver.listener.ListenerFactory
Get the port on which listeners created by this factory is waiting for requests.
getServerAddress() - Method in interface org.apache.ftpserver.listener.Listener
Get the InetAddress used for binding the local socket.
getServerAddress() - Method in class org.apache.ftpserver.listener.ListenerFactory
Get the InetAddress used for binding the local socket.
getSessionFilter() - Method in interface org.apache.ftpserver.listener.Listener
Returns the SessionFilter associated with this listener.
getSessionFilter() - Method in class org.apache.ftpserver.listener.ListenerFactory
Returns the currently configured SessionFilter, if any.
getSocketFactory() - Method in interface org.apache.ftpserver.ssl.SslConfiguration
Returns the socket factory that can be used to create sockets using this SslConfiguration.
getSqlUserAdmin() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Get the SQL SELECT statement used to find whether an user is admin or not.
getSqlUserAuthenticate() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Get the SQL SELECT statement used to authenticate user.
getSqlUserDelete() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Get the SQL DELETE statement used to delete an existing user.
getSqlUserInsert() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Get the SQL INSERT statement used to add a new user.
getSqlUserSelect() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Get the SQL SELECT statement used to select an existing user.
getSqlUserSelectAll() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Get the SQL SELECT statement used to select all user ids.
getSqlUserUpdate() - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Get the SQL UPDATE statement used to update an existing user.
getSslConfiguration() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Get SSL configuration for this data connection.
getSslConfiguration() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Get the SslConfiguration to be used by data connections
getSslConfiguration() - Method in interface org.apache.ftpserver.listener.Listener
Get the SslConfiguration used for this listener
getSslConfiguration() - Method in class org.apache.ftpserver.listener.ListenerFactory
Get the SslConfiguration used for listeners created by this factory
getSSLContext() - Method in interface org.apache.ftpserver.ssl.SslConfiguration
Return the SSL context for this configuration
getSSLContext(String) - Method in interface org.apache.ftpserver.ssl.SslConfiguration
Return the SSL context for this configuration given the specified protocol
getSslProtocol() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
The SSL protocol used for this channel.
getTruststoreAlgorithm() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
The algorithm used to open the trust store.
getTruststoreFile() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Get the file used to load the truststore
getTruststorePassword() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
The password used to load the trust store
getTruststoreType() - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
The trust store type, defaults to @see KeyStore.getDefaultType()
getType() - Method in class org.apache.ftpserver.ipfilter.RemoteIpFilter
Returns the type of this filter.
getUrl() - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Retrieve the URL used to load and store users
getUserManager() - Method in class org.apache.ftpserver.FtpServerFactory
Retrieve the user manager used by servers created by this factory
getUserMetadata() - Method in class org.apache.ftpserver.usermanager.AnonymousAuthentication
Retrive the user metadata
getUserMetadata() - Method in class org.apache.ftpserver.usermanager.UsernamePasswordAuthentication
Retrive the user metadata
getUsername() - Method in class org.apache.ftpserver.usermanager.UsernamePasswordAuthentication
Retrive the user name
getVersion() - Static method in class org.apache.ftpserver.Version
Get the version of this FtpServer

I

IpFilterType - Enum in org.apache.ftpserver.ipfilter
Defines various types of IP Filters.
isActiveEnabled() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Is active data connection enabled?
isActiveEnabled() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Is PORT enabled?
isActiveIpCheck() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Check the PORT IP with the client IP?
isActiveIpCheck() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Check the PORT IP?
isAnonymousLoginEnabled() - Method in interface org.apache.ftpserver.ConnectionConfig
Is anonymous logins allowed at the server?
isAnonymousLoginEnabled() - Method in class org.apache.ftpserver.ConnectionConfigFactory
Is anonymous logins allowed at the server?
isCaseInsensitive() - Method in class org.apache.ftpserver.filesystem.nativefs.NativeFileSystemFactory
Is this file system case insensitive.
isCreateHome() - Method in class org.apache.ftpserver.filesystem.nativefs.NativeFileSystemFactory
Should the home directories be created automatically
isEnabled() - Method in class org.apache.ftpserver.usermanager.UserFactory
Get the enabled status for users created by this factory
isImplicitSsl() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
 
isImplicitSsl() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
 
isImplicitSsl() - Method in interface org.apache.ftpserver.listener.Listener
Is this listener in SSL mode automatically or must the client explicitly request to use SSL
isImplicitSsl() - Method in class org.apache.ftpserver.listener.ListenerFactory
Is listeners created by this factory in SSL mode automatically or must the client explicitly request to use SSL
isPassiveIpCheck() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Tells whether or not IP address check is performed when accepting a passive data connection.
isPassiveIpCheck() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Tells whether or not IP address check is performed when accepting a passive data connection.
isStopped() - Method in interface org.apache.ftpserver.FtpServer
Get the server status.
isStopped() - Method in interface org.apache.ftpserver.listener.Listener
Checks if the listener is currently started.
isSuspended() - Method in interface org.apache.ftpserver.FtpServer
Is the server suspended
isSuspended() - Method in interface org.apache.ftpserver.listener.Listener
Checks if the listener is currently suspended
isUseDefaultCommands() - Method in class org.apache.ftpserver.command.CommandFactoryFactory
Are default commands used?

L

Listener - Interface in org.apache.ftpserver.listener
Interface for the component responsible for waiting for incoming socket requests and kicking off FtpIoSessions
ListenerFactory - Class in org.apache.ftpserver.listener
Factory for listeners.
ListenerFactory() - Constructor for class org.apache.ftpserver.listener.ListenerFactory
Default constructor
ListenerFactory(Listener) - Constructor for class org.apache.ftpserver.listener.ListenerFactory
Copy constructor, will copy properties from the provided listener.

M

main(String[]) - Static method in class org.apache.ftpserver.main.AddUser
Used to add users to the user manager for a particular FtpServer configuration
main(String[]) - Static method in class org.apache.ftpserver.main.CommandLine
This method is the FtpServer starting point when running by using the command line mode.
main(String[]) - Static method in class org.apache.ftpserver.main.Daemon
Main entry point for the daemon
matches(String, String) - Method in class org.apache.ftpserver.usermanager.ClearTextPasswordEncryptor
Matches an encrypted password with that stored
matches(String, String) - Method in class org.apache.ftpserver.usermanager.Md5PasswordEncryptor
Matches an encrypted password with that stored
matches(String, String) - Method in interface org.apache.ftpserver.usermanager.PasswordEncryptor
Matches an encrypted password with that stored
matches(String, String) - Method in class org.apache.ftpserver.usermanager.SaltedPasswordEncryptor
Matches an encrypted password with that stored
Md5PasswordEncryptor - Class in org.apache.ftpserver.usermanager
Password encryptor that hashes the password using MD5.
Md5PasswordEncryptor() - Constructor for class org.apache.ftpserver.usermanager.Md5PasswordEncryptor
 
MessageResource - Interface in org.apache.ftpserver.message
This is message resource interface.
MessageResourceFactory - Class in org.apache.ftpserver.message
Factory for creating message resource implementation
MessageResourceFactory() - Constructor for class org.apache.ftpserver.message.MessageResourceFactory
 
MinaSessionFilter - Class in org.apache.ftpserver.ipfilter
A wrapper for SessionFilter so it can be added to the MINA filter chain.
MinaSessionFilter(SessionFilter) - Constructor for class org.apache.ftpserver.ipfilter.MinaSessionFilter
Creates a new instance of MinaSessionFilter.

N

NativeFileSystemFactory - Class in org.apache.ftpserver.filesystem.nativefs
Native file system factory.
NativeFileSystemFactory() - Constructor for class org.apache.ftpserver.filesystem.nativefs.NativeFileSystemFactory
 
NotSupportedCommand - Class in org.apache.ftpserver.command
A command used primarily for overriding already installed commands when one wants to disable the command.
NotSupportedCommand() - Constructor for class org.apache.ftpserver.command.NotSupportedCommand
 

O

org.apache.ftpserver - package org.apache.ftpserver
 
org.apache.ftpserver.command - package org.apache.ftpserver.command
 
org.apache.ftpserver.filesystem.nativefs - package org.apache.ftpserver.filesystem.nativefs
 
org.apache.ftpserver.ftpletcontainer - package org.apache.ftpserver.ftpletcontainer
 
org.apache.ftpserver.ipfilter - package org.apache.ftpserver.ipfilter
 
org.apache.ftpserver.listener - package org.apache.ftpserver.listener
 
org.apache.ftpserver.main - package org.apache.ftpserver.main
 
org.apache.ftpserver.message - package org.apache.ftpserver.message
 
org.apache.ftpserver.ssl - package org.apache.ftpserver.ssl
 
org.apache.ftpserver.usermanager - package org.apache.ftpserver.usermanager
 

P

parse(String) - Static method in enum org.apache.ftpserver.ipfilter.IpFilterType
Parses the given string into its equivalent enum.
PasswordEncryptor - Interface in org.apache.ftpserver.usermanager
Strategy used for encrypting and matching encrypted passwords.
PropertiesUserManagerFactory - Class in org.apache.ftpserver.usermanager
Factory for the properties file based UserManager implementation.
PropertiesUserManagerFactory() - Constructor for class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
 

R

releasePassivePort(int) - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Release passive port.
releasePassivePort(int) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Release data port
RemoteIpFilter - Class in org.apache.ftpserver.ipfilter
An implementation of the SessionFilter interface, to filter sessions based on the remote IP address.
RemoteIpFilter(IpFilterType) - Constructor for class org.apache.ftpserver.ipfilter.RemoteIpFilter
Creates a new instance of RemoteIpFilter.
RemoteIpFilter(IpFilterType, Collection<? extends Subnet>) - Constructor for class org.apache.ftpserver.ipfilter.RemoteIpFilter
Creates a new instance of RemoteIpFilter.
RemoteIpFilter(IpFilterType, String) - Constructor for class org.apache.ftpserver.ipfilter.RemoteIpFilter
Creates a new instance of RemoteIpFilter.
requestPassivePort() - Method in interface org.apache.ftpserver.DataConnectionConfiguration
Request a passive port.
requestPassivePort() - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Get passive data port.
resume() - Method in interface org.apache.ftpserver.FtpServer
Resume the server handler
resume() - Method in interface org.apache.ftpserver.listener.Listener
Resumes a suspended listener.

S

SaltedPasswordEncryptor - Class in org.apache.ftpserver.usermanager
Password encryptor that hashes a salt together with the password using MD5.
SaltedPasswordEncryptor() - Constructor for class org.apache.ftpserver.usermanager.SaltedPasswordEncryptor
 
sessionCreated(IoFilter.NextFilter, IoSession) - Method in class org.apache.ftpserver.ipfilter.MinaSessionFilter
 
SessionFilter - Interface in org.apache.ftpserver.ipfilter
The interface for filtering sessions based on various session attributes.
setActiveEnabled(boolean) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Set if active data connections are enabled
setActiveIpCheck(boolean) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Check the PORT IP with the client IP?
setActiveLocalAddress(String) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Set the active data connection local host.
setActiveLocalPort(int) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Set the active data connection local port.
setAdminName(String) - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Set the name to use as the administrator of the server.
setAdminName(String) - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Set the name to use as the administrator of the server.
setAnonymousLoginEnabled(boolean) - Method in class org.apache.ftpserver.ConnectionConfigFactory
Set if anonymous logins are allowed at the server
setAuthorities(List<Authority>) - Method in class org.apache.ftpserver.usermanager.UserFactory
Set the authorities for users created by this factory
setBlockedAddresses(List<InetAddress>) - Method in class org.apache.ftpserver.listener.ListenerFactory
Deprecated.
Replaced by the IpFilter. Sets the InetAddress that listeners created by this factory will block from connecting
setBlockedSubnets(List<Subnet>) - Method in class org.apache.ftpserver.listener.ListenerFactory
Deprecated.
Replaced by the IpFilter.
setCaseInsensitive(boolean) - Method in class org.apache.ftpserver.filesystem.nativefs.NativeFileSystemFactory
Should this file system be case insensitive.
setClientAuthentication(String) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set what client authentication level to use, supported values are "yes" or "true" for required authentication, "want" for wanted authentication and "false" or "none" for no authentication.
setCommandFactory(CommandFactory) - Method in class org.apache.ftpserver.FtpServerFactory
Set the command factory to be used by servers created by this factory
setCommandMap(Map<String, Command>) - Method in class org.apache.ftpserver.command.CommandFactoryFactory
Set commands to add or override to the default commands
setConnectionConfig(ConnectionConfig) - Method in class org.apache.ftpserver.FtpServerFactory
Set the message resource to be used with this server
setCreateHome(boolean) - Method in class org.apache.ftpserver.filesystem.nativefs.NativeFileSystemFactory
Set if the home directories be created automatically
setCustomMessageDirectory(File) - Method in class org.apache.ftpserver.message.MessageResourceFactory
Set the directory where custom message bundles can be located
setDataConnectionConfiguration(DataConnectionConfiguration) - Method in class org.apache.ftpserver.listener.ListenerFactory
Set configuration for data connections made within listeners created by this factory
setDataSource(DataSource) - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Set the data source to be used by the user manager
setEnabled(boolean) - Method in class org.apache.ftpserver.usermanager.UserFactory
Get the enabled status for users created by this factory
setEnabledCipherSuites(String[]) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set the allowed cipher suites, note that the exact list of supported cipher suites differs between JRE implementations.
setFile(File) - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Set the file used to store and read users.
setFileSystem(FileSystemFactory) - Method in class org.apache.ftpserver.FtpServerFactory
Set the file system to be used by servers created by this factory
setFtplets(Map<String, Ftplet>) - Method in class org.apache.ftpserver.FtpServerFactory
Set the Ftplets to be active by servers created by this factory.
setHomeDirectory(String) - Method in class org.apache.ftpserver.usermanager.UserFactory
Set the user name for users created by this factory
setIdleTime(int) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Set the maximum idle time in seconds.
setIdleTimeout(int) - Method in class org.apache.ftpserver.listener.ListenerFactory
Set the number of seconds during which no network activity is allowed before a session is closed due to inactivity.
setImplicitSsl(boolean) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Set whether ssl is required for the data connection
setImplicitSsl(boolean) - Method in class org.apache.ftpserver.listener.ListenerFactory
Should listeners created by this factory be in SSL mode automatically or must the client explicitly request to use SSL
setKeyAlias(String) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set the alias for the key to be used for SSL communication.
setKeyPassword(String) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set the password used to load the key
setKeystoreAlgorithm(String) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Override the key store algorithm used to open the key store
setKeystoreFile(File) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set the key store file to be used by this configuration
setKeystorePassword(String) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set the password used to load the key store
setKeystoreType(String) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set the key store type
setLanguages(List<String>) - Method in class org.apache.ftpserver.message.MessageResourceFactory
Set the languages for which messages are available
setListeners(Map<String, Listener>) - Method in class org.apache.ftpserver.FtpServerFactory
Set the listeners for servers created by this factory, replaces existing listeners
setLoginFailureDelay(int) - Method in class org.apache.ftpserver.ConnectionConfigFactory
Set the delay in number of milliseconds between login failures.
setMaxAnonymousLogins(int) - Method in class org.apache.ftpserver.ConnectionConfigFactory
Sets the maximum number of anonymous logins the server would allow at any given time
setMaxIdleTime(int) - Method in class org.apache.ftpserver.usermanager.UserFactory
Set the user name for users created by this factory
setMaxLoginFailures(int) - Method in class org.apache.ftpserver.ConnectionConfigFactory
Set the maximum number of time an user can fail to login before getting disconnected
setMaxLogins(int) - Method in class org.apache.ftpserver.ConnectionConfigFactory
Set she maximum number of concurrently logged in users
setMaxThreads(int) - Method in class org.apache.ftpserver.ConnectionConfigFactory
Sets the maximum number of threads the server is allowed to create for processing client requests.
setMessageResource(MessageResource) - Method in class org.apache.ftpserver.FtpServerFactory
Set the message resource to be used with by servers created by this factory
setName(String) - Method in class org.apache.ftpserver.usermanager.UserFactory
Set the user name for users created by this factory
setPassiveAddress(String) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Set the passive server address.
setPassiveExternalAddress(String) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Set the passive address that will be returned to clients on the PASV command.
setPassiveIpCheck(boolean) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Sets whether or not IP check is performed before accepting a passive data connection.
setPassivePorts(String) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Set the passive ports to be used for data connections.
setPassword(String) - Method in class org.apache.ftpserver.usermanager.UserFactory
Set the user name for users created by this factory
setPasswordEncryptor(PasswordEncryptor) - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Set the password encryptor to use for this user manager
setPasswordEncryptor(PasswordEncryptor) - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Set the password encryptor to use by user managers created by this factory
setPort(int) - Method in class org.apache.ftpserver.listener.ListenerFactory
Set the port on which listeners created by this factory will accept requests.
setServerAddress(String) - Method in class org.apache.ftpserver.listener.ListenerFactory
Set the InetAddress used for binding the local socket.
setSessionFilter(SessionFilter) - Method in class org.apache.ftpserver.listener.ListenerFactory
Sets the session filter to the given filter.
setSqlUserAdmin(String) - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Set the SQL SELECT statement used to find whether an user is admin or not.
setSqlUserAuthenticate(String) - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Set the SQL SELECT statement used to authenticate user.
setSqlUserDelete(String) - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Set the SQL DELETE statement used to delete an existing user.
setSqlUserInsert(String) - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Set the SQL INSERT statement used to add a new user.
setSqlUserSelect(String) - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Set the SQL SELECT statement used to select an existing user.
setSqlUserSelectAll(String) - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Set the SQL SELECT statement used to select all user ids.
setSqlUserUpdate(String) - Method in class org.apache.ftpserver.usermanager.DbUserManagerFactory
Set the SQL UPDATE statement used to update an existing user.
setSslConfiguration(SslConfiguration) - Method in class org.apache.ftpserver.DataConnectionConfigurationFactory
Set the SslConfiguration to be used by data connections
setSslConfiguration(SslConfiguration) - Method in class org.apache.ftpserver.listener.ListenerFactory
Set the SslConfiguration to use by listeners created by this factory
setSslProtocol(String) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set the SSL protocol used for this channel.
setTruststoreAlgorithm(String) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Override the trust store algorithm used to open the trust store
setTruststoreFile(File) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set the password used to load the trust store
setTruststorePassword(String) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set the password used to load the trust store
setTruststoreType(String) - Method in class org.apache.ftpserver.ssl.SslConfigurationFactory
Set the trust store type
setType(IpFilterType) - Method in class org.apache.ftpserver.ipfilter.RemoteIpFilter
Sets the type of this filter.
setUrl(URL) - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Set the URL used to store and read users.
setUseDefaultCommands(boolean) - Method in class org.apache.ftpserver.command.CommandFactoryFactory
Sets whether the default commands will be used.
setUserManager(UserManager) - Method in class org.apache.ftpserver.FtpServerFactory
Set the user manager to be used by servers created by this factory
SslConfiguration - Interface in org.apache.ftpserver.ssl
SSL configuration
SslConfigurationFactory - Class in org.apache.ftpserver.ssl
Used to configure the SSL settings for the control channel or the data channel.
SslConfigurationFactory() - Constructor for class org.apache.ftpserver.ssl.SslConfigurationFactory
 
start() - Method in interface org.apache.ftpserver.FtpServer
Start the server.
start(FtpServerContext) - Method in interface org.apache.ftpserver.listener.Listener
Start the listener, will initiate the listener waiting on the socket.
stop() - Method in interface org.apache.ftpserver.FtpServer
Stop the server.
stop() - Method in interface org.apache.ftpserver.listener.Listener
Stop the listener, it should no longer except socket requests.
suspend() - Method in interface org.apache.ftpserver.FtpServer
Suspend further requests
suspend() - Method in interface org.apache.ftpserver.listener.Listener
Temporarily stops the listener from accepting socket requests.

U

usage() - Method in class org.apache.ftpserver.main.AddUser
Print the usage message.
usage() - Method in class org.apache.ftpserver.main.CommandLine
Print the usage message.
UserFactory - Class in org.apache.ftpserver.usermanager
Factory for User instances.
UserFactory() - Constructor for class org.apache.ftpserver.usermanager.UserFactory
 
UserManagerFactory - Interface in org.apache.ftpserver.usermanager
Interface for user manager factories
UsernamePasswordAuthentication - Class in org.apache.ftpserver.usermanager
Class representing a normal authentication attempt using username and password
UsernamePasswordAuthentication(String, String) - Constructor for class org.apache.ftpserver.usermanager.UsernamePasswordAuthentication
Constructor with the minimal data for an authentication
UsernamePasswordAuthentication(String, String, UserMetadata) - Constructor for class org.apache.ftpserver.usermanager.UsernamePasswordAuthentication
Constructor with an additonal parameter for user metadata

V

valueOf(String) - Static method in enum org.apache.ftpserver.ipfilter.IpFilterType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.ftpserver.ssl.ClientAuth
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.ftpserver.ipfilter.IpFilterType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.ftpserver.ssl.ClientAuth
Returns an array containing the constants of this enum type, in the order they are declared.
Version - Class in org.apache.ftpserver
Provides the version of this release of FtpServer
Version() - Constructor for class org.apache.ftpserver.Version
 
A C D E F G I L M N O P R S U V 
Skip navigation links

Copyright © 2003–2017 The Apache Software Foundation. All rights reserved.