FtpServerFactory (Apache FtpServer Core 1.1.1 API)

java.lang.Object
- org.apache.ftpserver.FtpServerFactory

```
public class FtpServerFactory
extends Object
```
This is the starting point of all the servers. Creates server instances based on the provided configuration.

Author:

Apache MINA Project

Constructor Summary

Constructors
Constructor and Description

FtpServerFactory()
Creates a server with the default configuration

Constructors
Constructor and Description
`FtpServerFactory()` Creates a server with the default configuration

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(String name, Listener listener)` Add a `Listener` to this factory
`FtpServer`	`createServer()` Create a `DefaultFtpServer` instance based on the provided configuration
`CommandFactory`	`getCommandFactory()` Retrieve the command factory used by servers created by this factory
`ConnectionConfig`	`getConnectionConfig()` Retrieve the connection configuration this server
`org.apache.ftpserver.ftplet.FileSystemFactory`	`getFileSystem()` Retrieve the file system used by servers created by this factory
`Map<String,org.apache.ftpserver.ftplet.Ftplet>`	`getFtplets()` Get all `Ftplet`s registered by servers created by this factory
`Listener`	`getListener(String name)` Get a specific `Listener` identified by its name
`Map<String,Listener>`	`getListeners()` Get all listeners available on servers created by this factory
`MessageResource`	`getMessageResource()` Retrieve the message resource used by servers created by this factory
`org.apache.ftpserver.ftplet.UserManager`	`getUserManager()` Retrieve the user manager used by servers created by this factory
`void`	`setCommandFactory(CommandFactory commandFactory)` Set the command factory to be used by servers created by this factory
`void`	`setConnectionConfig(ConnectionConfig connectionConfig)` Set the message resource to be used with this server
`void`	`setFileSystem(org.apache.ftpserver.ftplet.FileSystemFactory fileSystem)` Set the file system to be used by servers created by this factory
`void`	`setFtplets(Map<String,org.apache.ftpserver.ftplet.Ftplet> ftplets)` Set the `Ftplet`s to be active by servers created by this factory.
`void`	`setListeners(Map<String,Listener> listeners)` Set the listeners for servers created by this factory, replaces existing listeners
`void`	`setMessageResource(MessageResource messageResource)` Set the message resource to be used with by servers created by this factory
`void`	`setUserManager(org.apache.ftpserver.ftplet.UserManager userManager)` Set the user manager to be used by servers created by this factory

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FtpServerFactory
```
public FtpServerFactory()
```
    Creates a server with the default configuration
- Method Detail
  - createServer
```
public FtpServer createServer()
```
    Create a DefaultFtpServer instance based on the provided configuration
    
    Returns:
    
    The DefaultFtpServer instance
  - getListeners
```
public Map<String,Listener> getListeners()
```
    Get all listeners available on servers created by this factory
    
    Returns:
    
    The current listeners
  - getListener
```
public Listener getListener(String name)
```
    Get a specific Listener identified by its name
    
    Parameters:
    
    name - The name of the listener
    
    Returns:
    
    The Listener matching the provided name
  - addListener
```
public void addListener(String name,
                        Listener listener)
```
    Add a Listener to this factory
    
    Parameters:
    
    name - The name of the listener
    
    listener - The Listener
  - setListeners
```
public void setListeners(Map<String,Listener> listeners)
```
    Set the listeners for servers created by this factory, replaces existing listeners
    
    Parameters:
    
    listeners - The listeners to use for this server with the name as the key and the listener as the value
    
    Throws:
    
    IllegalStateException - If a custom server context has been set
  - getFtplets
```
public Map<String,org.apache.ftpserver.ftplet.Ftplet> getFtplets()
```
    Get all Ftplets registered by servers created by this factory
    
    Returns:
    
    All Ftplets
  - setFtplets
```
public void setFtplets(Map<String,org.apache.ftpserver.ftplet.Ftplet> ftplets)
```
    Set the Ftplets to be active by servers created by this factory. Replaces existing Ftplets
    
    Parameters:
    
    ftplets - Ftplets as a map with the name as the key and the Ftplet as the value. The Ftplet container will iterate over the map in the order provided by the Map. If invocation order of Ftplets is of importance, make sure to provide a ordered Map, for example LinkedHashMap.
    
    Throws:
    
    IllegalStateException - If a custom server context has been set
  - getUserManager
```
public org.apache.ftpserver.ftplet.UserManager getUserManager()
```
    Retrieve the user manager used by servers created by this factory
    
    Returns:
    
    The user manager
  - setUserManager
```
public void setUserManager(org.apache.ftpserver.ftplet.UserManager userManager)
```
    Set the user manager to be used by servers created by this factory
    
    Parameters:
    
    userManager - The UserManager
    
    Throws:
    
    IllegalStateException - If a custom server context has been set
  - getFileSystem
```
public org.apache.ftpserver.ftplet.FileSystemFactory getFileSystem()
```
    Retrieve the file system used by servers created by this factory
    
    Returns:
    
    The FileSystemFactory
  - setFileSystem
```
public void setFileSystem(org.apache.ftpserver.ftplet.FileSystemFactory fileSystem)
```
    Set the file system to be used by servers created by this factory
    
    Parameters:
    
    fileSystem - The FileSystemFactory
    
    Throws:
    
    IllegalStateException - If a custom server context has been set
  - getCommandFactory
```
public CommandFactory getCommandFactory()
```
    Retrieve the command factory used by servers created by this factory
    
    Returns:
    
    The CommandFactory
  - setCommandFactory
```
public void setCommandFactory(CommandFactory commandFactory)
```
    Set the command factory to be used by servers created by this factory
    
    Parameters:
    
    commandFactory - The CommandFactory
    
    Throws:
    
    IllegalStateException - If a custom server context has been set
  - getMessageResource
```
public MessageResource getMessageResource()
```
    Retrieve the message resource used by servers created by this factory
    
    Returns:
    
    The MessageResource
  - setMessageResource
```
public void setMessageResource(MessageResource messageResource)
```
    Set the message resource to be used with by servers created by this factory
    
    Parameters:
    
    messageResource - The MessageResource
    
    Throws:
    
    IllegalStateException - If a custom server context has been set
  - getConnectionConfig
```
public ConnectionConfig getConnectionConfig()
```
    Retrieve the connection configuration this server
    
    Returns:
    
    The MessageResource
  - setConnectionConfig
```
public void setConnectionConfig(ConnectionConfig connectionConfig)
```
    Set the message resource to be used with this server
    
    Parameters:
    
    connectionConfig - The ConnectionConfig to be used by servers created by this factory

Class FtpServerFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FtpServerFactory

Method Detail

createServer

getListeners

getListener

addListener

setListeners

getFtplets

setFtplets

getUserManager

setUserManager

getFileSystem

setFileSystem

getCommandFactory

setCommandFactory

getMessageResource

setMessageResource

getConnectionConfig

setConnectionConfig