ddf.catalog.ftp.ftplets

Class FtpRequestHandler

java.lang.Object

org.apache.ftpserver.ftplet.DefaultFtplet

ddf.catalog.ftp.ftplets.FtpRequestHandler

All Implemented Interfaces:

org.apache.ftpserver.ftplet.Ftplet

public class FtpRequestHandler
extends org.apache.ftpserver.ftplet.DefaultFtplet

Handler for incoming FTP requests from the client. Supports the PUT, MPUT, DELE, MKD, RETR, RMD, APPE, RNTO, STOU, and SITE operations. When PUTing a new file, it is not temporarily written to the file system. Instead, the new file's data stream is ingested directly into the catalog. If PUT submits a file that begins with a dot (eg. .foo), then the data is not immediately stored into the catalog. Instead, the system waits for a RNTO command for the dot-file and then stores the data in the catalog. Clients may PUT multiple dot-files and then execute multiple RNTO commands. Any dot-files that are not renamed at the end of the ftp session will be discarded and resources will be released. The CWD command always return a successful response. This is to support clients that use a MKDIR/CWD/PUT command sequence.

Constructor Summary

Constructors

Constructor and Description
FtpRequestHandler(CatalogFramework catalogFramework, MimeTypeMapper mimeTypeMapper, UuidGenerator uuidGenerator)

Method Summary

Modifier and Type	Method and Description
org.apache.ftpserver.ftplet.FtpletResult	beforeCommand(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onAppendEnd(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onAppendStart(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onConnect(org.apache.ftpserver.ftplet.FtpSession session)
org.apache.ftpserver.ftplet.FtpletResult	onDeleteEnd(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onDeleteStart(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onDisconnect(org.apache.ftpserver.ftplet.FtpSession session)
org.apache.ftpserver.ftplet.FtpletResult	onDownloadEnd(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onDownloadStart(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onLogin(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onMkdirEnd(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onMkdirStart(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onRenameEnd(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onRenameStart(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onRmdirEnd(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onRmdirStart(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onSite(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onUploadEnd(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onUploadStart(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onUploadUniqueEnd(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)
org.apache.ftpserver.ftplet.FtpletResult	onUploadUniqueStart(org.apache.ftpserver.ftplet.FtpSession session, org.apache.ftpserver.ftplet.FtpRequest request)

Methods inherited from class org.apache.ftpserver.ftplet.DefaultFtplet

afterCommand, destroy, init

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpRequestHandler

public FtpRequestHandler(CatalogFramework catalogFramework,
                         MimeTypeMapper mimeTypeMapper,
                         UuidGenerator uuidGenerator)

Method Detail

onConnect

public org.apache.ftpserver.ftplet.FtpletResult onConnect(org.apache.ftpserver.ftplet.FtpSession session)
                                                   throws org.apache.ftpserver.ftplet.FtpException,
                                                          IOException

Specified by:

onConnect in interface org.apache.ftpserver.ftplet.Ftplet

Overrides:

onConnect in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onDisconnect

public org.apache.ftpserver.ftplet.FtpletResult onDisconnect(org.apache.ftpserver.ftplet.FtpSession session)
                                                      throws org.apache.ftpserver.ftplet.FtpException,
                                                             IOException

Specified by:

onDisconnect in interface org.apache.ftpserver.ftplet.Ftplet

Overrides:

onDisconnect in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onLogin

public org.apache.ftpserver.ftplet.FtpletResult onLogin(org.apache.ftpserver.ftplet.FtpSession session,
                                                        org.apache.ftpserver.ftplet.FtpRequest request)
                                                 throws org.apache.ftpserver.ftplet.FtpException,
                                                        IOException

Overrides:

onLogin in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onUploadStart

public org.apache.ftpserver.ftplet.FtpletResult onUploadStart(org.apache.ftpserver.ftplet.FtpSession session,
                                                              org.apache.ftpserver.ftplet.FtpRequest request)
                                                       throws org.apache.ftpserver.ftplet.FtpException,
                                                              IOException

Overrides:

onUploadStart in class org.apache.ftpserver.ftplet.DefaultFtplet

Parameters:

session - The current FtpSession

request - The current FtpRequest

Returns:

FtpletResult.SKIP - signals successful ingest and to discontinue and further processing on the FTP request

Throws:

org.apache.ftpserver.ftplet.FtpException - general exception for Ftplets

IOException - thrown when there is an error fetching data from client

onUploadEnd

public org.apache.ftpserver.ftplet.FtpletResult onUploadEnd(org.apache.ftpserver.ftplet.FtpSession session,
                                                            org.apache.ftpserver.ftplet.FtpRequest request)

Overrides:

onUploadEnd in class org.apache.ftpserver.ftplet.DefaultFtplet

onDeleteStart

public org.apache.ftpserver.ftplet.FtpletResult onDeleteStart(org.apache.ftpserver.ftplet.FtpSession session,
                                                              org.apache.ftpserver.ftplet.FtpRequest request)
                                                       throws org.apache.ftpserver.ftplet.FtpException,
                                                              IOException

Overrides:

onDeleteStart in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onDeleteEnd

public org.apache.ftpserver.ftplet.FtpletResult onDeleteEnd(org.apache.ftpserver.ftplet.FtpSession session,
                                                            org.apache.ftpserver.ftplet.FtpRequest request)
                                                     throws org.apache.ftpserver.ftplet.FtpException,
                                                            IOException

Overrides:

onDeleteEnd in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onDownloadStart

public org.apache.ftpserver.ftplet.FtpletResult onDownloadStart(org.apache.ftpserver.ftplet.FtpSession session,
                                                                org.apache.ftpserver.ftplet.FtpRequest request)
                                                         throws org.apache.ftpserver.ftplet.FtpException,
                                                                IOException

Overrides:

onDownloadStart in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onDownloadEnd

public org.apache.ftpserver.ftplet.FtpletResult onDownloadEnd(org.apache.ftpserver.ftplet.FtpSession session,
                                                              org.apache.ftpserver.ftplet.FtpRequest request)
                                                       throws org.apache.ftpserver.ftplet.FtpException,
                                                              IOException

Overrides:

onDownloadEnd in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onRmdirStart

public org.apache.ftpserver.ftplet.FtpletResult onRmdirStart(org.apache.ftpserver.ftplet.FtpSession session,
                                                             org.apache.ftpserver.ftplet.FtpRequest request)
                                                      throws org.apache.ftpserver.ftplet.FtpException,
                                                             IOException

Overrides:

onRmdirStart in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onRmdirEnd

public org.apache.ftpserver.ftplet.FtpletResult onRmdirEnd(org.apache.ftpserver.ftplet.FtpSession session,
                                                           org.apache.ftpserver.ftplet.FtpRequest request)
                                                    throws org.apache.ftpserver.ftplet.FtpException,
                                                           IOException

Overrides:

onRmdirEnd in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onMkdirStart

public org.apache.ftpserver.ftplet.FtpletResult onMkdirStart(org.apache.ftpserver.ftplet.FtpSession session,
                                                             org.apache.ftpserver.ftplet.FtpRequest request)
                                                      throws org.apache.ftpserver.ftplet.FtpException,
                                                             IOException

Overrides:

onMkdirStart in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onMkdirEnd

public org.apache.ftpserver.ftplet.FtpletResult onMkdirEnd(org.apache.ftpserver.ftplet.FtpSession session,
                                                           org.apache.ftpserver.ftplet.FtpRequest request)
                                                    throws org.apache.ftpserver.ftplet.FtpException,
                                                           IOException

Overrides:

onMkdirEnd in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onAppendStart

public org.apache.ftpserver.ftplet.FtpletResult onAppendStart(org.apache.ftpserver.ftplet.FtpSession session,
                                                              org.apache.ftpserver.ftplet.FtpRequest request)
                                                       throws org.apache.ftpserver.ftplet.FtpException,
                                                              IOException

Overrides:

onAppendStart in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onAppendEnd

public org.apache.ftpserver.ftplet.FtpletResult onAppendEnd(org.apache.ftpserver.ftplet.FtpSession session,
                                                            org.apache.ftpserver.ftplet.FtpRequest request)
                                                     throws org.apache.ftpserver.ftplet.FtpException,
                                                            IOException

Overrides:

onAppendEnd in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onUploadUniqueStart

public org.apache.ftpserver.ftplet.FtpletResult onUploadUniqueStart(org.apache.ftpserver.ftplet.FtpSession session,
                                                                    org.apache.ftpserver.ftplet.FtpRequest request)
                                                             throws org.apache.ftpserver.ftplet.FtpException,
                                                                    IOException

Overrides:

onUploadUniqueStart in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onUploadUniqueEnd

public org.apache.ftpserver.ftplet.FtpletResult onUploadUniqueEnd(org.apache.ftpserver.ftplet.FtpSession session,
                                                                  org.apache.ftpserver.ftplet.FtpRequest request)
                                                           throws org.apache.ftpserver.ftplet.FtpException,
                                                                  IOException

Overrides:

onUploadUniqueEnd in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onRenameStart

public org.apache.ftpserver.ftplet.FtpletResult onRenameStart(org.apache.ftpserver.ftplet.FtpSession session,
                                                              org.apache.ftpserver.ftplet.FtpRequest request)
                                                       throws org.apache.ftpserver.ftplet.FtpException,
                                                              IOException

Overrides:

onRenameStart in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onRenameEnd

public org.apache.ftpserver.ftplet.FtpletResult onRenameEnd(org.apache.ftpserver.ftplet.FtpSession session,
                                                            org.apache.ftpserver.ftplet.FtpRequest request)
                                                     throws org.apache.ftpserver.ftplet.FtpException,
                                                            IOException

Overrides:

onRenameEnd in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

onSite

public org.apache.ftpserver.ftplet.FtpletResult onSite(org.apache.ftpserver.ftplet.FtpSession session,
                                                       org.apache.ftpserver.ftplet.FtpRequest request)
                                                throws org.apache.ftpserver.ftplet.FtpException,
                                                       IOException

Overrides:

onSite in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException

beforeCommand

public org.apache.ftpserver.ftplet.FtpletResult beforeCommand(org.apache.ftpserver.ftplet.FtpSession session,
                                                              org.apache.ftpserver.ftplet.FtpRequest request)
                                                       throws org.apache.ftpserver.ftplet.FtpException,
                                                              IOException

Specified by:

beforeCommand in interface org.apache.ftpserver.ftplet.Ftplet

Overrides:

beforeCommand in class org.apache.ftpserver.ftplet.DefaultFtplet

Throws:

org.apache.ftpserver.ftplet.FtpException

IOException