Package org.bluezoo.gumdrop.ftp.file

Class SimpleFTPService

java.lang.Object

org.bluezoo.gumdrop.ftp.FTPService

org.bluezoo.gumdrop.ftp.file.SimpleFTPService

All Implemented Interfaces:

Service

public class SimpleFTPService
extends FTPService

FTP service for basic file-based access with optional realm authentication.

This service provides a simple FTP server that serves files from a configured root directory. When a Realm is set, users are authenticated against it; otherwise any non-empty password is accepted.

Configuration Example

 <service class="org.bluezoo.gumdrop.ftp.file.SimpleFTPService">
   <property name="root-directory">/var/ftp</property>
   <property name="read-only">false</property>
   <property name="realm" ref="#ftpRealm"/>
   <listener class="org.bluezoo.gumdrop.ftp.FTPListener" port="21"/>
 </service>
 

Author:

Chris Burdess

See Also:

• FTPService
• SimpleFTPHandler

Constructor Summary

Constructors

Constructor	Description
SimpleFTPService()

Method Summary

Modifier and Type	Method	Description
protected FTPConnectionHandler	createHandler(TCPListener endpoint)	Creates a new handler for an incoming FTP control connection on the given endpoint.
Path	getRootDirectory()
protected void	initService()	Initialises service resources before listeners are started.
boolean	isReadOnly()
void	setReadOnly(boolean readOnly)
void	setRootDirectory(String rootDirectory)
void	setRootDirectory(Path rootDirectory)

Methods inherited from class org.bluezoo.gumdrop.ftp.FTPService

addDynamicListener, addListener, destroyService, getListeners, getRealm, isRequireTLSForData, removeDynamicListener, setListeners, setRealm, setRequireTLSForData, start, stop

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleFTPService

public SimpleFTPService()

Method Details

getRootDirectory

public Path getRootDirectory()

setRootDirectory

public void setRootDirectory(Path rootDirectory)

setRootDirectory

public void setRootDirectory(String rootDirectory)

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

initService

protected void initService()

Description copied from class: FTPService

Initialises service resources before listeners are started.

The default implementation does nothing.

Overrides:

initService in class FTPService

createHandler

protected FTPConnectionHandler createHandler(TCPListener endpoint)

Description copied from class: FTPService

Creates a new handler for an incoming FTP control connection on the given endpoint.

Subclasses must implement this to provide connection-level FTP behaviour (authentication, file system access, etc.). The endpoint parameter identifies which control listener accepted the connection.

Specified by:

createHandler in class FTPService

Parameters:

endpoint - the endpoint that accepted the connection

Returns:

a handler for the new connection, or null for default