net.sf.hermesftp.server
Interface FtpServer

All Superinterfaces:

java.lang.Runnable

All Known Implementing Classes:

AbstractFtpServer, DefaultFtpServer, SecureFtpServer

public interface FtpServer
extends java.lang.Runnable

Contract for FTP server implementations.

Author:

Lars Behnke

Method Summary

void	abort() Halts the server.
void	addFtpEventListener(FtpEventListener lstnr) Adds an external listerner that wants to get informed about FTP events.
void	cleanUpSessions() Removes closed sessions from memory.
int	getConnectionCount() Returns the number of FTP connections currently active.
int	getConnectionCountHWMark() Maximum number of connections since server started.
java.util.Date	getConnectionCountHWMarkDate() Date when number of connections reached its maximum.
java.lang.String	getName() Returns the name of the FTP server.
FtpServerOptions	getOptions() Returns the application properties.
java.util.List<FtpSession>	getSessions() Returns the list of active sessions.
int	getStatus() Returns the server status.
UserManager	getUserManager() Returns the user manager implementation.

Methods inherited from interface java.lang.Runnable

run

Method Detail

getName

java.lang.String getName()

Returns the name of the FTP server.

Returns:

The name.

getConnectionCount

int getConnectionCount()

Returns the number of FTP connections currently active.

Returns:

The number of connections.

getConnectionCountHWMark

int getConnectionCountHWMark()

Maximum number of connections since server started.

Returns:

The high water mark.

getConnectionCountHWMarkDate

java.util.Date getConnectionCountHWMarkDate()

Date when number of connections reached its maximum.

Returns:

The high water mark date.

abort

void abort()

Halts the server.

getStatus

int getStatus()

Returns the server status.

Returns:

The status code (0 = undefined, 1 = initializing, 2 = ready).

getSessions

java.util.List<FtpSession> getSessions()

Returns the list of active sessions.

Returns:

The list.

cleanUpSessions

void cleanUpSessions()

Removes closed sessions from memory.

getOptions

FtpServerOptions getOptions()

Returns the application properties.

Returns:

The properties.

getUserManager

UserManager getUserManager()

Returns the user manager implementation.

Returns:

The user manager.

addFtpEventListener

void addFtpEventListener(FtpEventListener lstnr)

Adds an external listerner that wants to get informed about FTP events.

Parameters:

lstnr - The listener.