Package org.apache.ftpserver.ftplet

Class DefaultFtplet

java.lang.Object

org.apache.ftpserver.ftplet.DefaultFtplet

All Implemented Interfaces:

Ftplet

public class DefaultFtplet
extends Object
implements Ftplet

Default ftplet implementation. All the callback method returns null. It is just an empty implementation. You can derive your ftplet implementation from this class.

Author:

Apache MINA Project

Constructor Summary

Constructors

Constructor	Description
DefaultFtplet()	A default constructor that does nothing

Method Summary

Modifier and Type	Method	Description
FtpletResult	afterCommand(FtpSession session, FtpRequest request, FtpReply reply)	Called by the ftplet container after a command has been executed by the server.
FtpletResult	beforeCommand(FtpSession session, FtpRequest request)	Called by the ftplet container before a command is executed by the server.
void	destroy()	Called by the Ftplet container to indicate to a ftplet that the ftplet is being taken out of service.
void	init(FtpletContext ftpletContext)	Called by the ftplet container to indicate to a ftplet that the ftplet is being placed into service.
FtpletResult	onAppendEnd(FtpSession session, FtpRequest request)	Override this method to intercept file appends after completion
FtpletResult	onAppendStart(FtpSession session, FtpRequest request)	Override this method to intercept file appends
FtpletResult	onConnect(FtpSession session)	Client connect notification method.
FtpletResult	onDeleteEnd(FtpSession session, FtpRequest request)	Override this method to handle deletions after completion
FtpletResult	onDeleteStart(FtpSession session, FtpRequest request)	Override this method to intercept deletions
FtpletResult	onDisconnect(FtpSession session)	Client disconnect notification method.
FtpletResult	onDownloadEnd(FtpSession session, FtpRequest request)	Override this method to handle downloads after completion
FtpletResult	onDownloadStart(FtpSession session, FtpRequest request)	Override this method to intercept downloads
FtpletResult	onLogin(FtpSession session, FtpRequest request)	Override this method to intercept user logins
FtpletResult	onMkdirEnd(FtpSession session, FtpRequest request)	Override this method to handle creation of directories after completion
FtpletResult	onMkdirStart(FtpSession session, FtpRequest request)	Override this method to intercept creation of directories
FtpletResult	onRenameEnd(FtpSession session, FtpRequest request)	Override this method to handle renames after completion
FtpletResult	onRenameStart(FtpSession session, FtpRequest request)	Override this method to intercept renames
FtpletResult	onRmdirEnd(FtpSession session, FtpRequest request)	Override this method to handle deletion of directories after completion
FtpletResult	onRmdirStart(FtpSession session, FtpRequest request)	Override this method to intercept deletion of directories
FtpletResult	onSite(FtpSession session, FtpRequest request)	Override this method to intercept SITE commands
FtpletResult	onUploadEnd(FtpSession session, FtpRequest request)	Override this method to handle uploads after completion
FtpletResult	onUploadStart(FtpSession session, FtpRequest request)	Override this method to intercept uploads
FtpletResult	onUploadUniqueEnd(FtpSession session, FtpRequest request)	Override this method to handle unique uploads after completion
FtpletResult	onUploadUniqueStart(FtpSession session, FtpRequest request)	Override this method to intercept unique uploads

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultFtplet

public DefaultFtplet()

A default constructor that does nothing

Method Details

init

public void init(FtpletContext ftpletContext)
          throws FtpException

Called by the ftplet container to indicate to a ftplet that the ftplet is being placed into service. The ftplet container calls the init method exactly once after instantiating the ftplet. The init method must complete successfully before the ftplet can receive any requests.

Specified by:

init in interface Ftplet

Parameters:

ftpletContext - The current FtpletContext

Throws:

FtpException - If the initialization failed

destroy

public void destroy()

Called by the Ftplet container to indicate to a ftplet that the ftplet is being taken out of service. This method is only called once all threads within the ftplet's service method have exited. After the ftplet container calls this method, callback methods will not be executed. If the ftplet initialization method fails, this method will not be called.

Specified by:

destroy in interface Ftplet

onConnect

public FtpletResult onConnect(FtpSession session)
                       throws FtpException,
IOException

Client connect notification method.

Specified by:

onConnect in interface Ftplet

Parameters:

session - The current FtpSession

Returns:

The desired action to be performed by the server

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onDisconnect

public FtpletResult onDisconnect(FtpSession session)
                          throws FtpException,
IOException

Client disconnect notification method. This is the last callback method.

Specified by:

onDisconnect in interface Ftplet

Parameters:

session - The current FtpSession

Returns:

The desired action to be performed by the server

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

beforeCommand

public FtpletResult beforeCommand(FtpSession session,
 FtpRequest request)
                           throws FtpException,
IOException

Called by the ftplet container before a command is executed by the server. The implementation should return based on the desired action to be taken by the server:

• FtpletResult.DEFAULT: The server continues as normal and executes the command
• FtpletResult.NO_FTPLET: The server does not call any more Ftplets before this command but continues execution of the command as usual
• FtpletResult.SKIP: The server skips over execution of the command. Note that the Ftplet is responsible for returning the appropriate reply to the client, or the client might deadlock.
• FtpletResult.DISCONNECT: The server will immediately disconnect the client.
• Ftplet throws exception: Same as FtpletResult.DISCONNECT

Specified by:

beforeCommand in interface Ftplet

Parameters:

session - The current session

request - The current request

Returns:

The desired action to be performed by the server

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

afterCommand

public FtpletResult afterCommand(FtpSession session,
 FtpRequest request,
 FtpReply reply)
                          throws FtpException,
IOException

Called by the ftplet container after a command has been executed by the server. The implementation should return based on the desired action to be taken by the server:

• FtpletResult.DEFAULT: The server continues as normal
• FtpletResult.NO_FTPLET: The server does not call any more Ftplets before this command but continues as normal
• FtpletResult.SKIP: Same as FtpletResult.DEFAULT
• FtpletResult.DISCONNECT: The server will immediately disconnect the client.
• Ftplet throws exception: Same as FtpletResult.DISCONNECT

Specified by:

afterCommand in interface Ftplet

Parameters:

session - The current session

request - The current request

reply - the reply that was sent for this command. Implementations can use this to check the reply code and thus determine if the command was successfully processed or not.

Returns:

The desired action to be performed by the server

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onLogin

public FtpletResult onLogin(FtpSession session,
 FtpRequest request)
                     throws FtpException,
IOException

Override this method to intercept user logins

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onDeleteStart

public FtpletResult onDeleteStart(FtpSession session,
 FtpRequest request)
                           throws FtpException,
IOException

Override this method to intercept deletions

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onDeleteEnd

public FtpletResult onDeleteEnd(FtpSession session,
 FtpRequest request)
                         throws FtpException,
IOException

Override this method to handle deletions after completion

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onUploadStart

public FtpletResult onUploadStart(FtpSession session,
 FtpRequest request)
                           throws FtpException,
IOException

Override this method to intercept uploads

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onUploadEnd

public FtpletResult onUploadEnd(FtpSession session,
 FtpRequest request)
                         throws FtpException,
IOException

Override this method to handle uploads after completion

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onDownloadStart

public FtpletResult onDownloadStart(FtpSession session,
 FtpRequest request)
                             throws FtpException,
IOException

Override this method to intercept downloads

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onDownloadEnd

public FtpletResult onDownloadEnd(FtpSession session,
 FtpRequest request)
                           throws FtpException,
IOException

Override this method to handle downloads after completion

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onRmdirStart

public FtpletResult onRmdirStart(FtpSession session,
 FtpRequest request)
                          throws FtpException,
IOException

Override this method to intercept deletion of directories

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onRmdirEnd

public FtpletResult onRmdirEnd(FtpSession session,
 FtpRequest request)
                        throws FtpException,
IOException

Override this method to handle deletion of directories after completion

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onMkdirStart

public FtpletResult onMkdirStart(FtpSession session,
 FtpRequest request)
                          throws FtpException,
IOException

Override this method to intercept creation of directories

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onMkdirEnd

public FtpletResult onMkdirEnd(FtpSession session,
 FtpRequest request)
                        throws FtpException,
IOException

Override this method to handle creation of directories after completion

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onAppendStart

public FtpletResult onAppendStart(FtpSession session,
 FtpRequest request)
                           throws FtpException,
IOException

Override this method to intercept file appends

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onAppendEnd

public FtpletResult onAppendEnd(FtpSession session,
 FtpRequest request)
                         throws FtpException,
IOException

Override this method to intercept file appends after completion

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onUploadUniqueStart

public FtpletResult onUploadUniqueStart(FtpSession session,
 FtpRequest request)
                                 throws FtpException,
IOException

Override this method to intercept unique uploads

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onUploadUniqueEnd

public FtpletResult onUploadUniqueEnd(FtpSession session,
 FtpRequest request)
                               throws FtpException,
IOException

Override this method to handle unique uploads after completion

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onRenameStart

public FtpletResult onRenameStart(FtpSession session,
 FtpRequest request)
                           throws FtpException,
IOException

Override this method to intercept renames

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onRenameEnd

public FtpletResult onRenameEnd(FtpSession session,
 FtpRequest request)
                         throws FtpException,
IOException

Override this method to handle renames after completion

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred

onSite

public FtpletResult onSite(FtpSession session,
 FtpRequest request)
                    throws FtpException,
IOException

Override this method to intercept SITE commands

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

The action for the container to take

Throws:

FtpException - If a FTP error occurred

IOException - If an IO error occurred