org.apache.ftpserver.impl

Class DefaultFtpServer

java.lang.Object

org.apache.ftpserver.impl.DefaultFtpServer

All Implemented Interfaces:

FtpServer

public class DefaultFtpServer
extends Object
implements FtpServer

Internal class, do not use directly. This is the starting point of all the servers. It invokes a new listener thread. Server implementation is used to create the server socket and handle client connection.

Author:

Apache MINA Project

Constructor Summary

Constructors

Constructor and Description
DefaultFtpServer(FtpServerContext serverContext) Internal constructor, do not use directly.

Method Summary

Modifier and Type	Method and Description
CommandFactory	getCommandFactory() Retrieve the command factory used with this server
ConnectionConfig	getConnectionConfig() Retrieve the connection configuration this server
org.apache.ftpserver.ftplet.FileSystemFactory	getFileSystem() Retrieve the file system used with this server
Map<String,org.apache.ftpserver.ftplet.Ftplet>	getFtplets() Get all Ftplets registered at this server
Listener	getListener(String name) Get a specific listener identified by its name
Map<String,Listener>	getListeners() Get all listeners available one this server
MessageResource	getMessageResource() Retrieve the message resource used with this server
FtpServerContext	getServerContext() Get the root server context.
org.apache.ftpserver.ftplet.UserManager	getUserManager() Retrieve the user manager used with this server
boolean	isStopped() Get the server status.
boolean	isSuspended() Is the server suspended
void	resume() Resume the server handler
void	start() Start the server.
void	stop() Stop the server.
void	suspend() Suspend further requests

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultFtpServer

public DefaultFtpServer(FtpServerContext serverContext)

Internal constructor, do not use directly. Use FtpServerFactory instead

Method Detail

start

public void start()
           throws org.apache.ftpserver.ftplet.FtpException

Start the server. Open a new listener thread.

Specified by:

start in interface FtpServer

Throws:

org.apache.ftpserver.ftplet.FtpException

stop

public void stop()

Stop the server. Stopping the server will close completely and it not supported to restart using start().

Specified by:

stop in interface FtpServer

isStopped

public boolean isStopped()

Get the server status.

Specified by:

isStopped in interface FtpServer

Returns:

true if the server is stopped

suspend

public void suspend()

Suspend further requests

Specified by:

suspend in interface FtpServer

resume

public void resume()

Resume the server handler

Specified by:

resume in interface FtpServer

isSuspended

public boolean isSuspended()

Is the server suspended

Specified by:

isSuspended in interface FtpServer

Returns:

true if the server is suspended

getServerContext

public FtpServerContext getServerContext()

Get the root server context.

getListeners

public Map<String,Listener> getListeners()

Get all listeners available one this server

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

getFtplets

public Map<String,org.apache.ftpserver.ftplet.Ftplet> getFtplets()

Get all Ftplets registered at this server

Returns:

All Ftplets

getUserManager

public org.apache.ftpserver.ftplet.UserManager getUserManager()

Retrieve the user manager used with this server

Returns:

The user manager

getFileSystem

public org.apache.ftpserver.ftplet.FileSystemFactory getFileSystem()

Retrieve the file system used with this server

Returns:

The FileSystemFactory

getCommandFactory

public CommandFactory getCommandFactory()

Retrieve the command factory used with this server

Returns:

The CommandFactory

getMessageResource

public MessageResource getMessageResource()

Retrieve the message resource used with this server

Returns:

The MessageResource

getConnectionConfig

public ConnectionConfig getConnectionConfig()

Retrieve the connection configuration this server

Returns:

The MessageResource