A B C D E F G H I L M N O P R S T U V W

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(InetAddress) - Method in class org.apache.ftpserver.ipfilter.DefaultIpFilter
 
accept(InetAddress) - Method in interface org.apache.ftpserver.ipfilter.IpFilter
Tells whether or not the given IP address is accepted by this filter.
add(String) - Method in class org.apache.ftpserver.ipfilter.DefaultIpFilter
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
afterCommand(FtpSession, FtpRequest, FtpReply) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
 
afterCommand(FtpSession, FtpRequest, FtpReply) - Method in interface org.apache.ftpserver.ftplet.Ftplet
Called by the ftplet container after a command has been executed by the server.
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
authenticate(Authentication) - Method in interface org.apache.ftpserver.ftplet.UserManager
Authenticate user
Authentication - Interface in org.apache.ftpserver.ftplet
Represents a type of authentication request, typically anonymous or a username and password combination
AuthenticationFailedException - Exception in org.apache.ftpserver.ftplet
Thrown if an authentication request fails
AuthenticationFailedException() - Constructor for exception org.apache.ftpserver.ftplet.AuthenticationFailedException
Default constructor.
AuthenticationFailedException(String) - Constructor for exception org.apache.ftpserver.ftplet.AuthenticationFailedException
Constructs a AuthenticationFailedException object with a message.
AuthenticationFailedException(Throwable) - Constructor for exception org.apache.ftpserver.ftplet.AuthenticationFailedException
Constructs a AuthenticationFailedException object with a Throwable cause.
AuthenticationFailedException(String, Throwable) - Constructor for exception org.apache.ftpserver.ftplet.AuthenticationFailedException
Constructs a AuthenticationFailedException object with a Throwable cause.
Authority - Interface in org.apache.ftpserver.ftplet
Interface for an authority granted to the user, typical example is write access or the number of concurrent logins
AuthorizationRequest - Interface in org.apache.ftpserver.ftplet
A request for authorization for a specific task, for example write access.
authorize(AuthorizationRequest) - Method in interface org.apache.ftpserver.ftplet.Authority
Authorize an AuthorizationRequest.
authorize(AuthorizationRequest) - Method in interface org.apache.ftpserver.ftplet.User
Authorize a AuthorizationRequest for this user

B

beforeCommand(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
 
beforeCommand(FtpSession, FtpRequest) - Method in interface org.apache.ftpserver.ftplet.Ftplet
Called by the ftplet container before a command is executed by the server.

C

canAuthorize(AuthorizationRequest) - Method in interface org.apache.ftpserver.ftplet.Authority
Indicates weather this Authority can authorize a certain request
changeWorkingDirectory(String) - Method in interface org.apache.ftpserver.ftplet.FileSystemView
Change directory.
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.
closeDataConnection() - Method in interface org.apache.ftpserver.ftplet.DataConnectionFactory
Close data socket.
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.
createFileSystemView(User) - Method in interface org.apache.ftpserver.ftplet.FileSystemFactory
Create user specific file system view.
createInputStream(long) - Method in interface org.apache.ftpserver.ftplet.FtpFile
Create input stream for reading.
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
createOutputStream(long) - Method in interface org.apache.ftpserver.ftplet.FtpFile
Create output stream for writing.
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
 
DataConnection - Interface in org.apache.ftpserver.ftplet
 
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.
DataConnectionFactory - Interface in org.apache.ftpserver.ftplet
 
DataType - Enum in org.apache.ftpserver.ftplet
Type safe enum for describing the data type
DbUserManagerFactory - Class in org.apache.ftpserver.usermanager
Factory for database backed UserManager instances.
DbUserManagerFactory() - Constructor for class org.apache.ftpserver.usermanager.DbUserManagerFactory
 
DefaultFtplet - Class in org.apache.ftpserver.ftplet
Default ftplet implementation.
DefaultFtplet() - Constructor for class org.apache.ftpserver.ftplet.DefaultFtplet
 
DefaultFtpReply - Class in org.apache.ftpserver.ftplet
FTP reply object.
DefaultFtpReply(int, String) - Constructor for class org.apache.ftpserver.ftplet.DefaultFtpReply
Constructor for single-line messages
DefaultFtpReply(int, String[]) - Constructor for class org.apache.ftpserver.ftplet.DefaultFtpReply
Constructor for multi-line replies
DefaultIpFilter - Class in org.apache.ftpserver.ipfilter
Default implementation of the IpFilter interface, which uses specific IP addresses or ranges of IP addresses that can be blocked or allowed.
DefaultIpFilter(IpFilterType) - Constructor for class org.apache.ftpserver.ipfilter.DefaultIpFilter
Creates a new instance of DefaultIpFilter.
DefaultIpFilter(IpFilterType, Collection<? extends Subnet>) - Constructor for class org.apache.ftpserver.ipfilter.DefaultIpFilter
Creates a new instance of DefaultIpFilter.
DefaultIpFilter(IpFilterType, String) - Constructor for class org.apache.ftpserver.ipfilter.DefaultIpFilter
Creates a new instance of DefaultIpFilter.
delete() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Delete file.
delete(String) - Method in interface org.apache.ftpserver.ftplet.UserManager
Delete the user from the system.
destroy() - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
 
destroy() - Method in interface org.apache.ftpserver.ftplet.Ftplet
Called by the Ftplet container to indicate to a ftplet that the ftplet is being taken out of service.
dispose() - Method in interface org.apache.ftpserver.ftplet.FileSystemView
Dispose file system view.
doesExist() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Does this file exists?
doesExist(String) - Method in interface org.apache.ftpserver.ftplet.UserManager
Check if the user exists.

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

FileSystemFactory - Interface in org.apache.ftpserver.ftplet
Factory for file system implementations - it returns the file system view for user.
FileSystemView - Interface in org.apache.ftpserver.ftplet
This is an abstraction over the user file system view.
FtpException - Exception in org.apache.ftpserver.ftplet
Ftplet exception class.
FtpException() - Constructor for exception org.apache.ftpserver.ftplet.FtpException
Default constructor.
FtpException(String) - Constructor for exception org.apache.ftpserver.ftplet.FtpException
Constructs a FtpException object with a message.
FtpException(Throwable) - Constructor for exception org.apache.ftpserver.ftplet.FtpException
Constructs a FtpException object with a Throwable cause.
FtpException(String, Throwable) - Constructor for exception org.apache.ftpserver.ftplet.FtpException
Constructs a BaseException object with a Throwable cause.
FtpFile - Interface in org.apache.ftpserver.ftplet
This is the file abstraction used by the server.
Ftplet - Interface in org.apache.ftpserver.ftplet
Defines methods that all ftplets must implement.
FtpletContainer - Interface in org.apache.ftpserver.ftpletcontainer
Interface describing an Ftplet container.
FtpletContext - Interface in org.apache.ftpserver.ftplet
A ftplet configuration object used by a ftplet container used to pass information to a ftplet during initialization.
FtpletResult - Enum in org.apache.ftpserver.ftplet
This class encapsulates the return values of the ftplet methods.
FtpReply - Interface in org.apache.ftpserver.ftplet
Interface for a reply to an FTP request.
FtpRequest - Interface in org.apache.ftpserver.ftplet
One FtpRequest made by the client.
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
RuntimeException.RuntimeException()
FtpServerConfigurationException(String, Throwable) - Constructor for exception org.apache.ftpserver.FtpServerConfigurationException
RuntimeException.RuntimeException(String, Throwable)
FtpServerConfigurationException(String) - Constructor for exception org.apache.ftpserver.FtpServerConfigurationException
RuntimeException.RuntimeException(String)
FtpServerConfigurationException(Throwable) - Constructor for exception org.apache.ftpserver.FtpServerConfigurationException
RuntimeException.RuntimeException(Throwable)
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
FtpSession - Interface in org.apache.ftpserver.ftplet
Defines an client session with the FTP server.
FtpStatistics - Interface in org.apache.ftpserver.ftplet
This interface holds all the ftp server statistical information.

G

getAbsolutePath() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Get the full path from the base directory of the FileSystemView.
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 interface org.apache.ftpserver.ftplet.UserManager
Get admin user name
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.
getAllUserNames() - Method in interface org.apache.ftpserver.ftplet.UserManager
Get all user names in the system.
getArgument() - Method in interface org.apache.ftpserver.ftplet.FtpRequest
Get the ftp request argument.
getAttribute(String) - Method in interface org.apache.ftpserver.ftplet.FtpSession
Returns the value of the named attribute as an Object.
getAuthorities() - Method in interface org.apache.ftpserver.ftplet.User
Get all authorities granted to this user
getAuthorities(Class<? extends Authority>) - Method in interface org.apache.ftpserver.ftplet.User
Get authorities of the specified type granted to this user
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
getClientAddress() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Returns the IP address of the client that sent the request.
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
getClientCertificates() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Retrieve the certificates for the client, if running over SSL and with client authentication
getCode() - Method in class org.apache.ftpserver.ftplet.DefaultFtpReply
 
getCode() - Method in interface org.apache.ftpserver.ftplet.FtpReply
The reply code
getCommand(String) - Method in interface org.apache.ftpserver.command.CommandFactory
Get the command instance.
getCommand() - Method in interface org.apache.ftpserver.ftplet.FtpRequest
Returns the ftp request command.
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
getConnectionTime() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get connection time.
getCurrentAnonymousLoginNumber() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get current anonymous login number.
getCurrentConnectionNumber() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get current number of connections.
getCurrentLoginNumber() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get current login number
getCurrentUserLoginNumber(User) - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get the login number for the specific user
getCurrentUserLoginNumber(User, InetAddress) - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get the login number for the specific user from the ipAddress
getCustomMessageDirectory() - Method in class org.apache.ftpserver.message.MessageResourceFactory
The directory where custom message bundles can be located
getDataConnection() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get FTP data connection factory, used to transfer data to and from the client.
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
getDataType() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get the data type.
getEnabled() - Method in interface org.apache.ftpserver.ftplet.User
Get the user enable status.
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.
getFailedLogins() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get the number of failed logins.
getFile(String) - Method in interface org.apache.ftpserver.ftplet.FileSystemView
Get file object.
getFile() - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Retrieve the file used to load and store users
getFileOffset() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get file upload/download offset.
getFileSystem() - Method in class org.apache.ftpserver.FtpServerFactory
Retrieve the file system used by servers created by this factory
getFileSystemManager() - Method in interface org.apache.ftpserver.ftplet.FtpletContext
Get file system manager
getFileSystemView() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get user file system view.
getFtplet(String) - Method in interface org.apache.ftpserver.ftplet.FtpletContext
Get Ftplet.
getFtplet(String) - Method in interface org.apache.ftpserver.ftpletcontainer.FtpletContainer
Retrive 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
getFtpStatistics() - Method in interface org.apache.ftpserver.ftplet.FtpletContext
Get ftp statistics.
getGroupName() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Get owner group name.
getHomeDirectory() - Method in interface org.apache.ftpserver.ftplet.FileSystemView
Get the user home directory.
getHomeDirectory() - Method in interface org.apache.ftpserver.ftplet.User
Get the user home directory
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.
getIpFilter() - Method in interface org.apache.ftpserver.listener.Listener
Returns the IP filter associated with this listener.
getIpFilter() - Method in class org.apache.ftpserver.listener.ListenerFactory
Returns the currently configured IP filter, if any.
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()
getLanguage() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get the requested language.
getLanguages() - Method in class org.apache.ftpserver.message.MessageResourceFactory
The languages for which messages are available
getLastAccessTime() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get last access time.
getLastModified() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Get last modified time in UTC.
getLinkCount() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Get link count.
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.
getLoginTime() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get the login time.
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 interface org.apache.ftpserver.ftplet.FtpSession
Returns maximum idle time.
getMaxIdleTime() - Method in interface org.apache.ftpserver.ftplet.User
Get the maximum idle time in seconds.
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() - Method in class org.apache.ftpserver.ftplet.DefaultFtpReply
 
getMessage() - Method in interface org.apache.ftpserver.ftplet.FtpReply
The reply message, might be multiple lines
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 interface org.apache.ftpserver.ftplet.FtpFile
Get the file name of the file
getName() - Method in interface org.apache.ftpserver.ftplet.User
Get the user name.
getName() - Method in class org.apache.ftpserver.usermanager.UserFactory
Get the user name for users created by this factory
getOwnerName() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Get the owner name.
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 interface org.apache.ftpserver.ftplet.User
Get password.
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.
getRenameFrom() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get rename from file object.
getRequestLine() - Method in interface org.apache.ftpserver.ftplet.FtpRequest
Get the client request string.
getRootCause() - Method in exception org.apache.ftpserver.ftplet.FtpException
Deprecated. Use Throwable.getCause() instead
getServerAddress() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Returns the IP address of the server
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.
getSessionId() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get the unique ID for this session.
getSize() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Get file size.
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.
getStartTime() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get the server start time.
getStructure() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get structure.
getTotalAnonymousLoginNumber() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get total anonymous login number.
getTotalConnectionNumber() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get total number of connections
getTotalDeleteNumber() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get number of files deleted.
getTotalDirectoryCreated() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get total directory created.
getTotalDirectoryRemoved() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get total directory removed.
getTotalDownloadNumber() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get number of files downloaded.
getTotalDownloadSize() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get total number of bytes downloaded.
getTotalFailedLoginNumber() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get total failed login number.
getTotalLoginNumber() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get total login number.
getTotalUploadNumber() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get number of files uploaded.
getTotalUploadSize() - Method in interface org.apache.ftpserver.ftplet.FtpStatistics
Get total number of bytes uploaded.
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.DefaultIpFilter
Returns the type of this filter.
getUrl() - Method in class org.apache.ftpserver.usermanager.PropertiesUserManagerFactory
Retrieve the URL used to load and store users
getUser() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Get user object.
getUserArgument() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Returns user name entered in USER command
getUserByName(String) - Method in interface org.apache.ftpserver.ftplet.UserManager
Get user by name.
getUserManager() - Method in interface org.apache.ftpserver.ftplet.FtpletContext
Get the user manager.
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
getWorkingDirectory() - Method in interface org.apache.ftpserver.ftplet.FileSystemView
Get user current directory.

H

hasArgument() - Method in interface org.apache.ftpserver.ftplet.FtpRequest
Check if request contains an argument

I

init(FtpletContext) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
 
init(FtpletContext) - Method in interface org.apache.ftpserver.ftplet.Ftplet
Called by the ftplet container to indicate to a ftplet that the ftplet is being placed into service.
IpFilter - Interface in org.apache.ftpserver.ipfilter
The interface for filtering connections based on the client's IP address.
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?
isAdmin(String) - Method in interface org.apache.ftpserver.ftplet.UserManager
Check if the user is admin.
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
isDirectory() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Is it a directory?
isEnabled() - Method in class org.apache.ftpserver.usermanager.UserFactory
Get the enabled status for users created by this factory
isFile() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Is it a file?
isHidden() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Is the file hidden?
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
isLoggedIn() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Is the user logged in?
isRandomAccessible() - Method in interface org.apache.ftpserver.ftplet.FileSystemView
Does the file system support random file access?
isReadable() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Has read permission?
isRemovable() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Has delete permission?
isSecure() - Method in interface org.apache.ftpserver.ftplet.DataConnectionFactory
Indicates whether the data socket created by this factory will be secure that is, running over SSL/TLS.
isSecure() - Method in interface org.apache.ftpserver.ftplet.FtpSession
Indicates whether the control socket for this session is secure, that is, running over SSL/TLS
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?
isWritable() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Has write permission?

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.
listFiles() - Method in interface org.apache.ftpserver.ftplet.FtpFile
List file objects.

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
 
MinaIpFilter - Class in org.apache.ftpserver.ipfilter
An implementation of Mina Filter to filter clients based on the originating IP address.
MinaIpFilter(IpFilter) - Constructor for class org.apache.ftpserver.ipfilter.MinaIpFilter
Creates a new instance of MinaIpFilter.
mkdir() - Method in interface org.apache.ftpserver.ftplet.FtpFile
Create directory.
move(FtpFile) - Method in interface org.apache.ftpserver.ftplet.FtpFile
Move file.

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

onAppendEnd(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept file appends after completion
onAppendStart(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept file appends
onConnect(FtpSession) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
 
onConnect(FtpSession) - Method in interface org.apache.ftpserver.ftplet.Ftplet
Client connect notification method.
onDeleteEnd(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to handle deletions after completion
onDeleteStart(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept deletions
onDisconnect(FtpSession) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
 
onDisconnect(FtpSession) - Method in interface org.apache.ftpserver.ftplet.Ftplet
Client disconnect notification method.
onDownloadEnd(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to handle downloads after completion
onDownloadStart(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept downloads
onLogin(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept user logins
onMkdirEnd(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to handle creation of directories after completion
onMkdirStart(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept creation of directories
onRenameEnd(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to handle renames after completion
onRenameStart(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept renames
onRmdirEnd(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to handle deletion of directories after completion
onRmdirStart(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept deletion of directories
onSite(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept SITE commands
onUploadEnd(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to handle uploads after completion
onUploadStart(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept uploads
onUploadUniqueEnd(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to handle unique uploads after completion
onUploadUniqueStart(FtpSession, FtpRequest) - Method in class org.apache.ftpserver.ftplet.DefaultFtplet
Override this method to intercept unique uploads
openConnection() - Method in interface org.apache.ftpserver.ftplet.DataConnectionFactory
Open an active data connection
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.ftplet - package org.apache.ftpserver.ftplet
 
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.
parseArgument(char) - Static method in enum org.apache.ftpserver.ftplet.DataType
Parses the argument value from the TYPE command into the type safe class
parseArgument(char) - Static method in enum org.apache.ftpserver.ftplet.Structure
Parses the argument value from the STRU command into the type safe class
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
removeAttribute(String) - Method in interface org.apache.ftpserver.ftplet.FtpSession
Removes an attribute from this request.
REPLY_110_RESTART_MARKER_REPLY - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
110 Restart marker reply.
REPLY_120_SERVICE_READY_IN_NNN_MINUTES - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
120 Service ready in nnn minutes.
REPLY_125_DATA_CONNECTION_ALREADY_OPEN - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
125 Data connection already open; transfer starting.
REPLY_150_FILE_STATUS_OKAY - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
150 File status okay; about to open data connection.
REPLY_200_COMMAND_OKAY - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
200 Command okay.
REPLY_202_COMMAND_NOT_IMPLEMENTED - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
202 Command not implemented, superfluous at this site.
REPLY_211_SYSTEM_STATUS_REPLY - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
211 System status, or system help reply.
REPLY_212_DIRECTORY_STATUS - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
212 Directory status.
REPLY_213_FILE_STATUS - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
213 File status.
REPLY_214_HELP_MESSAGE - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
214 Help message.
REPLY_215_NAME_SYSTEM_TYPE - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
215 NAME system type.
REPLY_220_SERVICE_READY - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
220 Service ready for new user.
REPLY_221_CLOSING_CONTROL_CONNECTION - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
Service closing control connection.
REPLY_225_DATA_CONNECTION_OPEN_NO_TRANSFER_IN_PROGRESS - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
225 Data connection open; no transfer in progress.
REPLY_226_CLOSING_DATA_CONNECTION - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
Closing data connection.
REPLY_227_ENTERING_PASSIVE_MODE - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
227 Entering Passive Mode (h1,h2,h3,h4,p1,p2).
REPLY_230_USER_LOGGED_IN - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
230 User logged in, proceed.
REPLY_250_REQUESTED_FILE_ACTION_OKAY - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
250 Requested file action okay, completed.
REPLY_257_PATHNAME_CREATED - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
257 "PATHNAME" created.
REPLY_331_USER_NAME_OKAY_NEED_PASSWORD - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
331 User name okay, need password.
REPLY_332_NEED_ACCOUNT_FOR_LOGIN - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
332 Need account for login.
REPLY_350_REQUESTED_FILE_ACTION_PENDING_FURTHER_INFORMATION - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
350 Requested file action pending further information.
REPLY_421_SERVICE_NOT_AVAILABLE_CLOSING_CONTROL_CONNECTION - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
421 Service not available, closing control connection.
REPLY_425_CANT_OPEN_DATA_CONNECTION - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
425 Can't open data connection.
REPLY_426_CONNECTION_CLOSED_TRANSFER_ABORTED - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
426 Connection closed; transfer aborted.
REPLY_450_REQUESTED_FILE_ACTION_NOT_TAKEN - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
450 Requested file action not taken.
REPLY_451_REQUESTED_ACTION_ABORTED - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
451 Requested action aborted: local error in processing.
REPLY_452_REQUESTED_ACTION_NOT_TAKEN - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
452 Requested action not taken.
REPLY_500_SYNTAX_ERROR_COMMAND_UNRECOGNIZED - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
500 Syntax error, command unrecognized.
REPLY_501_SYNTAX_ERROR_IN_PARAMETERS_OR_ARGUMENTS - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
501 Syntax error in parameters or arguments.
REPLY_502_COMMAND_NOT_IMPLEMENTED - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
502 Command not implemented.
REPLY_503_BAD_SEQUENCE_OF_COMMANDS - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
503 Bad sequence of commands.
REPLY_504_COMMAND_NOT_IMPLEMENTED_FOR_THAT_PARAMETER - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
504 Command not implemented for that parameter.
REPLY_530_NOT_LOGGED_IN - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
530 Not logged in.
REPLY_532_NEED_ACCOUNT_FOR_STORING_FILES - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
532 Need account for storing files.
REPLY_550_REQUESTED_ACTION_NOT_TAKEN - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
550 Requested action not taken.
REPLY_551_REQUESTED_ACTION_ABORTED_PAGE_TYPE_UNKNOWN - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
551 Requested action aborted: page type unknown.
REPLY_552_REQUESTED_FILE_ACTION_ABORTED_EXCEEDED_STORAGE - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
552 Requested file action aborted.
REPLY_553_REQUESTED_ACTION_NOT_TAKEN_FILE_NAME_NOT_ALLOWED - Static variable in interface org.apache.ftpserver.ftplet.FtpReply
553 Requested action not taken.
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
 
save(User) - Method in interface org.apache.ftpserver.ftplet.UserManager
Save user.
sessionCreated(IoFilter.NextFilter, IoSession) - Method in class org.apache.ftpserver.ipfilter.MinaIpFilter
 
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
setAttribute(String, Object) - Method in interface org.apache.ftpserver.ftplet.FtpSession
Stores an attribute in this request.
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. Sets the Subnets that listeners created by this factory will block from connecting
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
setIpFilter(IpFilter) - Method in class org.apache.ftpserver.listener.ListenerFactory
Sets the IP filter to the given filter.
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
setLastModified(long) - Method in interface org.apache.ftpserver.ftplet.FtpFile
Set the last modified time stamp of a file
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 interface org.apache.ftpserver.ftplet.FtpSession
Set maximum idle time in seconds.
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.
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.
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.DefaultIpFilter
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.
Structure - Enum in org.apache.ftpserver.ftplet
Type safe enum for describing the structure
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.

T

toString() - Method in class org.apache.ftpserver.ftplet.DefaultFtpReply
 
toString() - Method in interface org.apache.ftpserver.ftplet.FtpReply
Must implement toString to format the reply as described in the RFC.
transferFromClient(FtpSession, OutputStream) - Method in interface org.apache.ftpserver.ftplet.DataConnection
Transfer data from the client (e.g.
transferToClient(FtpSession, InputStream) - Method in interface org.apache.ftpserver.ftplet.DataConnection
Transfer data to the client (e.g.
transferToClient(FtpSession, String) - Method in interface org.apache.ftpserver.ftplet.DataConnection
Transfer a string to the client, e.g.

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.
User - Interface in org.apache.ftpserver.ftplet
Basic user interface.
UserFactory - Class in org.apache.ftpserver.usermanager
Factory for User instances.
UserFactory() - Constructor for class org.apache.ftpserver.usermanager.UserFactory
 
UserManager - Interface in org.apache.ftpserver.ftplet
User manager interface.
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.ftplet.DataType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.ftpserver.ftplet.FtpletResult
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.ftpserver.ftplet.Structure
Returns the enum constant of this type with the specified name.
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.ftplet.DataType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.ftpserver.ftplet.FtpletResult
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.ftpserver.ftplet.Structure
Returns an array containing the constants of this enum type, in the order they are declared.
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.

W

write(FtpReply) - Method in interface org.apache.ftpserver.ftplet.FtpSession
Write a reply to the client

A B C D E F G H I L M N O P R S T U V W

Copyright © 2003-2010 The Apache Software Foundation. All Rights Reserved.