FTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The FTPServer class provides server-side functionality for FTP and FTPS protocols.

Syntax

secureblackbox.FTPServer

Remarks

FTPServer supports FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations on the server over Transport Layer Security (TLS). TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Active Property (FTPServer Class)

Whether the server is active and can accept incoming connections.

Syntax

public boolean isActive();

Default Value

False

Remarks

This read-only property returns True if the FTPS server is running and listening for incoming connections, and False otherwise.

This property is read-only and not available at design time.

AllowAnonymous Property (FTPServer Class)

Allows and disallows anonymous connections.

Syntax

public boolean isAllowAnonymous();
public void setAllowAnonymous(boolean allowAnonymous);

Default Value

False

Remarks

Use this property to enable and disable support for anonymous connections.

ClientFileEntry Property (FTPServer Class)

A container for current file entry details.

Syntax

public FTPListEntry getClientFileEntry();
public void setClientFileEntry(FTPListEntry clientFileEntry);

Remarks

Use this object to specify file entry details for a file listing or attributes request, before committing them to the server with SetClientFileEntry method.

This property is not available at design time.

Please refer to the FTPListEntry type for a complete list of fields.

DataHost Property (FTPServer Class)

Host address for incoming data channel connections.

Syntax

public String getDataHost();
public void setDataHost(String dataHost);

Default Value

""

Remarks

Use this property to specify the address for incoming data channel connections, if it is different to Host.

In some network environments, in particular, where the server is behind a NAT, there may be a requirement to use a different host address for data connections.

DataPortRangeFrom Property (FTPServer Class)

Specifies the lower port range bound for passive mode data connections.

Syntax

public int getDataPortRangeFrom();
public void setDataPortRangeFrom(int dataPortRangeFrom);

Default Value

0

Remarks

Use this property in combination with DataPortRangeT to limit the port range for passive mode data connections. The value of 0 (zero) stands for no lower bound.

DataPortRangeTo Property (FTPServer Class)

Specifies the upper port range bound for passive mode data connections.

Syntax

public int getDataPortRangeTo();
public void setDataPortRangeTo(int dataPortRangeTo);

Default Value

0

Remarks

Use this property in combination with DataPortRangeFrom to limit the port range for passive mode data connections. The value of 0 (zero) stands for no upper bound.

ExternalCrypto Property (FTPServer Class)

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto getExternalCrypto();

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Please refer to the ExternalCrypto type for a complete list of fields.

FIPSMode Property (FTPServer Class)

Reserved.

Syntax

public boolean isFIPSMode();
public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

HandshakeTimeout Property (FTPServer Class)

Specifies the handshake timeout in milliseconds.

Syntax

public int getHandshakeTimeout();
public void setHandshakeTimeout(int handshakeTimeout);

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (FTPServer Class)

Specifies the server host.

Syntax

public String getHost();
public void setHost(String host);

Default Value

""

Remarks

Use this property to specify the IP address on which to listen for incoming FTP connections. Use Port to specify the listening port number.

ImplicitSSL Property (FTPServer Class)

Enables or disables implicit SSL mode.

Syntax

public boolean isImplicitSSL();
public void setImplicitSSL(boolean implicitSSL);

Default Value

False

Remarks

The server can only work in one mode, explicit or implicit. Explicit mode, also called AUTH TLS, supports both TLS and plain connections. Implicit mode, also called 'dedicated port mode,' only supports TLS connections.

PassiveModeHost Property (FTPServer Class)

The IP address of the passive mode host.

Syntax

public String getPassiveModeHost();
public void setPassiveModeHost(String passiveModeHost);

Default Value

""

Remarks

Use this property to specify the address on which to listen for passive mode connections.

PinnedClient Property (FTPServer Class)

Populates the pinned client details.

Syntax

public TLSConnectionInfo getPinnedClient();

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

This property is read-only and not available at design time.

Please refer to the TLSConnectionInfo type for a complete list of fields.

PinnedClientChain Property (FTPServer Class)

Contains the certificate chain of the pinned client.

Syntax

public CertificateList getPinnedClientChain();

Remarks

Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.

This property is read-only and not available at design time.

Please refer to the Certificate type for a complete list of fields.

Port Property (FTPServer Class)

The port number to listen for incoming connections on.

Syntax

public int getPort();
public void setPort(int port);

Default Value

21

Remarks

Use this property to specify the port number to listen for incoming connections on.

ReadOnly Property (FTPServer Class)

Makes the server's file system read-only for all users.

Syntax

public boolean isReadOnly();
public void setReadOnly(boolean readOnly);

Default Value

False

Remarks

Set this property to true to present the server's file system as read-only for all connecting users.

RootDirectory Property (FTPServer Class)

Specifies the server's root directory.

Syntax

public String getRootDirectory();
public void setRootDirectory(String rootDirectory);

Default Value

""

Remarks

Use this property to specify the shared root directory for all client sessions.

SecurityOptions Property (FTPServer Class)

Various options of the secure connection.

Syntax

public int getSecurityOptions();
public void setSecurityOptions(int securityOptions);

Default Value

63

Remarks

Various options of the secure connection:

SessionTimeout Property (FTPServer Class)

Specifies the session timeout in milliseconds.

Syntax

public int getSessionTimeout();
public void setSessionTimeout(int sessionTimeout);

Default Value

360000

Remarks

Specifies the maximum inactivity time (in milliseconds) after which the session will be forcebly closed.

SocketSettings Property (FTPServer Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Please refer to the SocketSettings type for a complete list of fields.

TLSServerChain Property (FTPServer Class)

The server's TLS certificates.

Syntax

public CertificateList getTLSServerChain();
public void setTLSServerChain(CertificateList TLSServerChain);

Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

TLSSettings Property (FTPServer Class)

Manages TLS layer settings.

Syntax

public TLSSettings getTLSSettings();

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Please refer to the TLSSettings type for a complete list of fields.

Users Property (FTPServer Class)

Provides a list of registered users.

Syntax

public UserAccountList getUsers();
public void setUsers(UserAccountList users);

Remarks

Assign a list of 'known' users to this property to automate authentication handling by the class.

This property is not available at design time.

Please refer to the UserAccount type for a complete list of fields.

UseUTF8 Property (FTPServer Class)

Enables or disables UTF8 file name conversions.

Syntax

public boolean isUseUTF8();
public void setUseUTF8(boolean useUTF8);

Default Value

True

Remarks

Use this property to enable and disable UTF8 file name conversion. The server typically adjusts to the right setting automatically, but you may use this property to enforce the needed behaviour.

Cleanup Method (FTPServer Class)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

public void cleanup();

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

Config Method (FTPServer Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (FTPServer Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

DropClient Method (FTPServer Class)

Terminates a client connection.

Syntax

public void dropClient(long connectionId, boolean forced);

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

GetClientBuffer Method (FTPServer Class)

Obtains a pending connection buffer.

Syntax

public byte[] getClientBuffer(long connectionID);

Remarks

Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.

ListClients Method (FTPServer Class)

Enumerates the connected clients.

Syntax

public String listClients();

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (FTPServer Class)

Takes a snapshot of the connection's properties.

Syntax

public void pinClient(long connectionId);

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

Reset Method (FTPServer Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

SetClientBuffer Method (FTPServer Class)

Commits a data buffer to the connection.

Syntax

public void setClientBuffer(long connectionID, byte[] value);

Remarks

Use this method from your ReadFile event handler to commit a chunk of file data to the server component.

SetClientFileEntry Method (FTPServer Class)

Commits a file entry to the connection.

Syntax

public void setClientFileEntry(long connectionID);

Remarks

Use this method to commit a file details entry provided in ClientFileEntry property to ConnectionID connection. This method is supposed to be used from a FindNext event handler.

Please note that events like FindNext may be invoked concurrently for several connection threads. Please make sure you use a locking mechanism to avoid mixing up details in ClientFileEntry.

Start Method (FTPServer Class)

Starts the server.

Syntax

public void start();

Remarks

Call this method to start listening for incoming connections on port Port. Call Stop to deactivate the server.

Stop Method (FTPServer Class)

Stops the server.

Syntax

public void stop();

Remarks

Call this method to terminate all active sessions and stop listening for new incoming connections.

Accept Event (FTPServer Class)

Reports an incoming connection.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void accept(FTPServerAcceptEvent e) {}
  ...
}

public class FTPServerAcceptEvent {
  public String remoteAddress;
  public int remotePort;
  public boolean accept; //read-write
}

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to Connect event to be notified of every connection that has been set up.

AfterChangeDirectory Event (FTPServer Class)

Signals the completion of a directory change operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void afterChangeDirectory(FTPServerAfterChangeDirectoryEvent e) {}
  ...
}

public class FTPServerAfterChangeDirectoryEvent {
  public long connectionID;
  public String directory;
  public int operationStatus; //read-write
}

Remarks

The class fires this event upon completion of a directory change operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCreateDirectory Event (FTPServer Class)

Signals the completion of a directory creation operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void afterCreateDirectory(FTPServerAfterCreateDirectoryEvent e) {}
  ...
}

public class FTPServerAfterCreateDirectoryEvent {
  public long connectionID;
  public String directory;
  public int operationStatus; //read-write
}

Remarks

The class fires this event upon completion of a directory creation operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRemoveDirectory Event (FTPServer Class)

Signals the completion of a directory removal operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void afterRemoveDirectory(FTPServerAfterRemoveDirectoryEvent e) {}
  ...
}

public class FTPServerAfterRemoveDirectoryEvent {
  public long connectionID;
  public String directory;
  public int operationStatus; //read-write
}

Remarks

The class fires this event upon completion of a directory removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRemoveFile Event (FTPServer Class)

Signals the completion of a file removal operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void afterRemoveFile(FTPServerAfterRemoveFileEvent e) {}
  ...
}

public class FTPServerAfterRemoveFileEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

The class fires this event upon completion of a file removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRenameFile Event (FTPServer Class)

Signals the completion of a file renaming operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void afterRenameFile(FTPServerAfterRenameFileEvent e) {}
  ...
}

public class FTPServerAfterRenameFileEvent {
  public long connectionID;
  public String oldPath;
  public String newPath;
  public int operationStatus; //read-write
}

Remarks

The class fires this event upon completion of a file renaming operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRequestAttributes Event (FTPServer Class)

Signals the completion of an attribute request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void afterRequestAttributes(FTPServerAfterRequestAttributesEvent e) {}
  ...
}

public class FTPServerAfterRequestAttributesEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

The class fires this event upon completion of an attribute request. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AuthAttempt Event (FTPServer Class)

Fires when a connected client makes an authentication attempt.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void authAttempt(FTPServerAuthAttemptEvent e) {}
  ...
}

public class FTPServerAuthAttemptEvent {
  public long connectionID;
  public String username;
  public String password;
  public boolean allow; //read-write
  public String basePath; //read-write
}

Remarks

The class fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.

The BasePath parameter specifies the home directory that will be used for this client. This is taken from the client's record in Users, or from RootDirectory if the client is not present in the list. You can adjust it in the event handler if required.

ConnectionID contains the unique session identifier for that client, and Username and Password contain the professed credentials.

BeforeChangeDirectory Event (FTPServer Class)

Notifies about an incoming change directory request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void beforeChangeDirectory(FTPServerBeforeChangeDirectoryEvent e) {}
  ...
}

public class FTPServerBeforeChangeDirectoryEvent {
  public long connectionID;
  public String directory;
  public int action; //read-write
}

Remarks

The class fires this event to notify the application about a received directory change request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to ChangeDirectory to be notified when to perform the request. It is the ChangeDirectory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterChangeDirectory event will be fired.

Choose Action as one of the following values:

BeforeCreateDirectory Event (FTPServer Class)

Notifies about an incoming create directory request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void beforeCreateDirectory(FTPServerBeforeCreateDirectoryEvent e) {}
  ...
}

public class FTPServerBeforeCreateDirectoryEvent {
  public long connectionID;
  public String directory;
  public int action; //read-write
}

Remarks

The class fires this event to notify the application about a received MKDIR request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to CreateDirectory to be notified when to perform the request. It is the CreateDirectory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterCreateDirectory event will be fired.

Choose Action as one of the following values:

BeforeDownloadFile Event (FTPServer Class)

Notifies about an incoming file download request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void beforeDownloadFile(FTPServerBeforeDownloadFileEvent e) {}
  ...
}

public class FTPServerBeforeDownloadFileEvent {
  public long connectionID;
  public String path;
  public long restartAt;
  public int action; //read-write
}

Remarks

The class fires this event to notify the application about a received download request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to DownloadFile to be notified when to perform the request. It is the DownloadFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the TransferCompleted event will be fired.

Choose Action as one of the following values:

BeforeFind Event (FTPServer Class)

Notifies about an incoming file listing request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void beforeFind(FTPServerBeforeFindEvent e) {}
  ...
}

public class FTPServerBeforeFindEvent {
  public long connectionID;
  public String directory;
  public int action; //read-write
}

Remarks

The class fires this event to notify the application about a received file listing request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to FindInit, FindNext, and FindClose to be notified when to perform the request. It is the FindInit and FindNext events handler where you should perform the overridden listing actions.

Upon completion of the request, either in manual or override mode, the FindClose event will be fired.

Choose Action as one of the following values:

BeforeRemoveDirectory Event (FTPServer Class)

Notifies about an incoming directory removal request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void beforeRemoveDirectory(FTPServerBeforeRemoveDirectoryEvent e) {}
  ...
}

public class FTPServerBeforeRemoveDirectoryEvent {
  public long connectionID;
  public String directory;
  public int action; //read-write
}

Remarks

The class fires this event to notify the application about a received directory removal request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RemoveDirectory to be notified when to perform the request. It is the RemoveDirectory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRemoveDirectory event will be fired.

Choose Action as one of the following values:

BeforeRemoveFile Event (FTPServer Class)

Notifies about an incoming file removal request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void beforeRemoveFile(FTPServerBeforeRemoveFileEvent e) {}
  ...
}

public class FTPServerBeforeRemoveFileEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

The class fires this event to notify the application about a received file deletion request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RemoveFile to be notified when to perform the request. It is the RemoveFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRemoveFile event will be fired.

Choose Action as one of the following values:

Note that you must subscribe to BeforeRequestAttributes and RequestAttributes events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the deletion procedure. In the virtualized case, you can confirm the existence of the file by returning its details from RequestAttributes call.

BeforeRenameFile Event (FTPServer Class)

Notifies about an incoming file rename request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void beforeRenameFile(FTPServerBeforeRenameFileEvent e) {}
  ...
}

public class FTPServerBeforeRenameFileEvent {
  public long connectionID;
  public String oldPath;
  public String newPath;
  public int action; //read-write
}

Remarks

The class fires this event to notify the application about a received file rename request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RenameFile to be notified when to perform the request. It is the RenameFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRenameFile event will be fired.

Choose Action as one of the following values:

Note that you must subscribe to BeforeRequestAttributes and RequestAttributes events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the renaming procedure. In the virtualized case, you can confirm the existence of the file by returning its details from RequestAttributes call.

BeforeRequestAttributes Event (FTPServer Class)

Notifies about an incoming attributes request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void beforeRequestAttributes(FTPServerBeforeRequestAttributesEvent e) {}
  ...
}

public class FTPServerBeforeRequestAttributesEvent {
  public long connectionID;
  public String path;
  public int action; //read-write
}

Remarks

The class fires this event to notify the application about a received attributes request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RequestAttributes to be notified when to perform the request. It is the RequestAttributes event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRequestAttributes event will be fired.

Choose Action as one of the following values:

BeforeSendReply Event (FTPServer Class)

Notifies the application of a command reply being sent.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void beforeSendReply(FTPServerBeforeSendReplyEvent e) {}
  ...
}

public class FTPServerBeforeSendReplyEvent {
  public long connectionID;
  public int code; //read-write
  public String reply; //read-write
  public String command;
}

Remarks

The class fires this event to tell the application that a command reply is about to be sent. The Command parameter indicates the command that induced the reply, and Code and Reply indicate the pre-generated response.

You can alter the response parameters in your code to send bespoke replies.

BeforeUploadFile Event (FTPServer Class)

Notifies about an incoming file upload request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void beforeUploadFile(FTPServerBeforeUploadFileEvent e) {}
  ...
}

public class FTPServerBeforeUploadFileEvent {
  public long connectionID;
  public String path;
  public long restartAt;
  public boolean append;
  public int action; //read-write
}

Remarks

The class fires this event to notify the application about a received upload request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to UploadFile to be notified when to perform the request. It is the UploadFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the TransferCompleted event will be fired.

Choose Action as one of the following values:

ChangeDirectory Event (FTPServer Class)

An override for a directory change operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void changeDirectory(FTPServerChangeDirectoryEvent e) {}
  ...
}

public class FTPServerChangeDirectoryEvent {
  public long connectionID;
  public String directory; //read-write
  public int operationStatus; //read-write
}

Remarks

The class fires this event to let the application perform an overridden directory change operation.

This event only fires if Action = fraCustom was passed back from BeforeChangeDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterChangeDirectory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

CommandProcessed Event (FTPServer Class)

Signals that a command has been processed by the server.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void commandProcessed(FTPServerCommandProcessedEvent e) {}
  ...
}

public class FTPServerCommandProcessedEvent {
  public long connectionID;
  public String currentDirectory;
  public String command;
  public int replyCode;
}

Remarks

The class fires this event to signal that a command has been processed by the server, and a reply code has been generated.

You can adjust the reply code and the textual comment associated with it in BeforeSendReply event handler.

CommandReceived Event (FTPServer Class)

Signals that a command has been received from the client.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void commandReceived(FTPServerCommandReceivedEvent e) {}
  ...
}

public class FTPServerCommandReceivedEvent {
  public long connectionID;
  public String command;
  public String parameters;
  public boolean ignore; //read-write
}

Remarks

The class fires this event to notify the application of an incoming command. Set Ignore to True to stop the server from handling the command.

When the command has been processed, the server will report it via the CommandProcessed call.

Connect Event (FTPServer Class)

Reports an accepted connection.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void connect(FTPServerConnectEvent e) {}
  ...
}

public class FTPServerConnectEvent {
  public long connectionID;
  public String remoteAddress;
  public int port;
}

Remarks

The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as AuthAttempt or BeforeUploadFile.

CreateDirectory Event (FTPServer Class)

An override for a directory creation operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void createDirectory(FTPServerCreateDirectoryEvent e) {}
  ...
}

public class FTPServerCreateDirectoryEvent {
  public long connectionID;
  public String directory; //read-write
  public int operationStatus; //read-write
}

Remarks

The class fires this event to let the application perform an overridden directory creation operation.

This event only fires if Action = fraCustom was passed back from BeforeCreateDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterCreateDirectory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Disconnect Event (FTPServer Class)

Fires to report a disconnected client.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void disconnect(FTPServerDisconnectEvent e) {}
  ...
}

public class FTPServerDisconnectEvent {
  public long connectionID;
}

Remarks

The class fires this event when a connected client disconnects.

DownloadBegin Event (FTPServer Class)

The class fires this event to notify the application about the start of a file download.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void downloadBegin(FTPServerDownloadBeginEvent e) {}
  ...
}

public class FTPServerDownloadBeginEvent {
  public long connectionID;
  public String path;
}

Remarks

Subscribe to this event to get notified about the beginning of a file download operation. The requested file is specified via the Path property.

DownloadEnd Event (FTPServer Class)

Reports the completion of the download operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void downloadEnd(FTPServerDownloadEndEvent e) {}
  ...
}

public class FTPServerDownloadEndEvent {
  public long connectionID;
  public String path;
}

Remarks

Use this event to get notified about completion of the early initiated file download operation.

DownloadFile Event (FTPServer Class)

An override for a file download initiation operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void downloadFile(FTPServerDownloadFileEvent e) {}
  ...
}

public class FTPServerDownloadFileEvent {
  public long connectionID;
  public String path;
  public long restartAt;
  public int operationStatus; //read-write
}

Remarks

The class fires this event to let the application perform an overridden file download initiation operation.

This event only fires if Action = fraCustom was passed back from BeforeDownloadFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by a number of ReadFile calls, requesting the file data from your code, followed by a single TransferCompleted call.

Set OperationStatus to one of the following values:

DownloadProgress Event (FTPServer Class)

Reports the progress of an active download operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void downloadProgress(FTPServerDownloadProgressEvent e) {}
  ...
}

public class FTPServerDownloadProgressEvent {
  public long connectionID;
  public String path;
  public long progress;
  public long total;
}

Remarks

Subscribe to this event to be notified about the progress of an active download operation.

The Path parameter contains the path to the file being downloaded, and Progress and Total reflect the operation progress. Note that the Total parameter may be set to -1 if the size of the downloaded file is not known.

Error Event (FTPServer Class)

Information about errors during data delivery.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void error(FTPServerErrorEvent e) {}
  ...
}

public class FTPServerErrorEvent {
  public long connectionID;
  public int errorCode;
  public boolean fatal;
  public boolean remote;
  public String description;
}

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the FTP section.

ExternalSign Event (FTPServer Class)

Handles remote or external signing initiated by the server protocol.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void externalSign(FTPServerExternalSignEvent e) {}
  ...
}

public class FTPServerExternalSignEvent {
  public long connectionID;
  public String operationId;
  public String hashAlgorithm;
  public String pars;
  public String data;
  public String signedData; //read-write
}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

FindClose Event (FTPServer Class)

Signals the completion of a directory listing request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void findClose(FTPServerFindCloseEvent e) {}
  ...
}

public class FTPServerFindCloseEvent {
  public long connectionID;
  public int operationStatus; //read-write
}

Remarks

The class fires this event upon completion of a directory listing request. Check the operation status, and alter it, if needed, through the OperationStatus parameter.

FindInit Event (FTPServer Class)

An override for a directory listing initiation operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void findInit(FTPServerFindInitEvent e) {}
  ...
}

public class FTPServerFindInitEvent {
  public long connectionID;
  public String directory; //read-write
  public int operationStatus; //read-write
}

Remarks

The class fires this event to let the application prepare for directory listing retrieval.

This event only fires if Action = fraCustom was passed back from BeforeFind event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by a number of FindNext calls, requesting the directory listing entry by entry from your code, followed by a FindClose call.

Set OperationStatus to one of the following values:

FindNext Event (FTPServer Class)

An override for a directory listing entry request operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void findNext(FTPServerFindNextEvent e) {}
  ...
}

public class FTPServerFindNextEvent {
  public long connectionID;
  public int operationStatus; //read-write
}

Remarks

The class fires this event in a loop after calling FindInit to request one directory entry from the application.

This event only fires if Action = fraCustom was passed back from BeforeFind event. No default listing operation will be performed by the server component.

Inside the handler, pass the entry details to the server component by tuning up the ClientFileEntry object to contain the details of the requested entry, and committing those details to the component with SetClientFileEntry method.

Use the OperationStatus parameter to return the operation result back to the server. After submitting all the directory entries to the component, set OperationStatus to ostEOF to tell the components that no more entries are left.

This event will be followed by FindClose call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Notification Event (FTPServer Class)

This event notifies the application about an underlying control flow event.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void notification(FTPServerNotificationEvent e) {}
  ...
}

public class FTPServerNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

ReadFile Event (FTPServer Class)

Requests a piece of file data from the application.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void readFile(FTPServerReadFileEvent e) {}
  ...
}

public class FTPServerReadFileEvent {
  public long connectionID;
  public int size;
  public int operationStatus; //read-write
}

Remarks

The class fires this event repeatedly during an overridden download operation to request file data from the application.

The handler of this event should read up to Size bytes from the downloaded file, and pass them to the component with a SetClientBuffer call.

Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ReadFile calls are needed.

Set OperationStatus to one of the following values:

RemoveDirectory Event (FTPServer Class)

An override for a directory removal operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void removeDirectory(FTPServerRemoveDirectoryEvent e) {}
  ...
}

public class FTPServerRemoveDirectoryEvent {
  public long connectionID;
  public String directory; //read-write
  public int operationStatus; //read-write
}

Remarks

The class fires this event to let the application perform an overridden directory removal operation.

This event only fires if Action = fraCustom was passed back from BeforeRemoveDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterRemoveDirectory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

RemoveFile Event (FTPServer Class)

An override for a file remove operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void removeFile(FTPServerRemoveFileEvent e) {}
  ...
}

public class FTPServerRemoveFileEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

The class fires this event to let the application perform an overridden file removal operation.

This event only fires if Action = fraCustom was passed back from BeforeRemoveFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterRemoveFile call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Please see a remark about virtualizing file removals in the BeforeRemoveFile topic.

RenameFile Event (FTPServer Class)

An override for a file rename operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void renameFile(FTPServerRenameFileEvent e) {}
  ...
}

public class FTPServerRenameFileEvent {
  public long connectionID;
  public String oldPath;
  public String newPath;
  public int operationStatus; //read-write
}

Remarks

The class fires this event to let the application perform an overridden file rename operation.

This event only fires if Action = fraCustom was passed back from BeforeRenameFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterRenameFile call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Please see a remark about virtualizing file renamings in the BeforeRenameFile topic.

RequestAttributes Event (FTPServer Class)

An override for an attribute request.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void requestAttributes(FTPServerRequestAttributesEvent e) {}
  ...
}

public class FTPServerRequestAttributesEvent {
  public long connectionID;
  public String path;
  public int operationStatus; //read-write
}

Remarks

The class fires this event to let the application handle an overridden attribute request operation.

This event only fires if Action = fraCustom was passed back from BeforeRequestAttributes event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterRequestAttributes call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

TLSCertValidate Event (FTPServer Class)

Fires when a client certificate needs to be validated.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void TLSCertValidate(FTPServerTLSCertValidateEvent e) {}
  ...
}

public class FTPServerTLSCertValidateEvent {
  public long connectionID;
  public boolean accept; //read-write
}

Remarks

The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (FTPServer Class)

Reports the setup of a TLS session.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void TLSEstablished(FTPServerTLSEstablishedEvent e) {}
  ...
}

public class FTPServerTLSEstablishedEvent {
  public long connectionID;
}

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (FTPServer Class)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void TLSHandshake(FTPServerTLSHandshakeEvent e) {}
  ...
}

public class FTPServerTLSHandshakeEvent {
  public long connectionID;
  public String serverName;
  public boolean abort; //read-write
}

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (FTPServer Class)

Requests a pre-shared key for TLS-PSK.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void TLSPSK(FTPServerTLSPSKEvent e) {}
  ...
}

public class FTPServerTLSPSKEvent {
  public long connectionID;
  public String identity;
  public String PSK; //read-write
  public String ciphersuite; //read-write
}

Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (FTPServer Class)

Reports closure of a TLS session.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void TLSShutdown(FTPServerTLSShutdownEvent e) {}
  ...
}

public class FTPServerTLSShutdownEvent {
  public long connectionID;
}

Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

TransferCompleted Event (FTPServer Class)

This event is fired when a customized upload or download operation completes.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void transferCompleted(FTPServerTransferCompletedEvent e) {}
  ...
}

public class FTPServerTransferCompletedEvent {
  public long connectionID;
  public int operationStatus; //read-write
}

Remarks

This event is fired when a customized transfer operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeUploadFile or BeforeDownloadFile event, and with Action parameter set to fraCustom.

The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.

UploadBegin Event (FTPServer Class)

The server fires this event to notify the application about the start of a file upload operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void uploadBegin(FTPServerUploadBeginEvent e) {}
  ...
}

public class FTPServerUploadBeginEvent {
  public long connectionID;
  public String path;
}

Remarks

Use this event to get notified about the beginning of a file upload operation. The file that is about to be uploaded is specified via the Path property.

UploadEnd Event (FTPServer Class)

Reports the completion of the upload operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void uploadEnd(FTPServerUploadEndEvent e) {}
  ...
}

public class FTPServerUploadEndEvent {
  public long connectionID;
  public String path;
}

Remarks

Use this event to receive notifications about completion of file upload operations.

UploadFile Event (FTPServer Class)

An override for a file upload initiation operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void uploadFile(FTPServerUploadFileEvent e) {}
  ...
}

public class FTPServerUploadFileEvent {
  public long connectionID;
  public String path;
  public long restartAt;
  public boolean append;
  public int operationStatus; //read-write
}

Remarks

The class fires this event to let the application perform an overridden file upload initiation operation.

This event only fires if Action = fraCustom was passed back from BeforeUploadFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by a number of WriteFile calls, passing the file data to your code, followed by a single TransferCompleted call.

Set OperationStatus to one of the following values:

UploadProgress Event (FTPServer Class)

Reports the progress of an active upload operation.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void uploadProgress(FTPServerUploadProgressEvent e) {}
  ...
}

public class FTPServerUploadProgressEvent {
  public long connectionID;
  public String path;
  public long progress;
  public long total;
}

Remarks

Subscribe to this event to be notified about the progress of an active upload operation.

The Path parameter specifies the path to the file being uploaded, and Progress and Total reflect the operation progress. The Total parameter may be set to -1 if the size of the uploaded file is not known.

WriteFile Event (FTPServer Class)

Hands a piece of file data to the application.

Syntax

public class DefaultFTPServerEventListener implements FTPServerEventListener {
  ...
  public void writeFile(FTPServerWriteFileEvent e) {}
  ...
}

public class FTPServerWriteFileEvent {
  public long connectionID;
  public int operationStatus; //read-write
}

Remarks

The class fires this event repeatedly during an overridden upload operation to pass file data to the application.

The handler of this event should retrieve the pending data buffer with a GetClientBuffer call, and write it to the end of the file that is being uploaded.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values:

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

public Certificate( bytes,  startIndex,  count,  password);

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

public Certificate( bytes,  startIndex,  count);

public Certificate( path,  password);

public Certificate( certPath,  keyPath,  password);

public Certificate( path);

public Certificate( stream);

public Certificate( stream,  password);

public Certificate( certStream,  keyStream,  password);

public Certificate();

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

public ExternalCrypto();

FTPListEntry Type

Represents a basic container for the remote file details.

Remarks

The class represents the details of a file entry returned by the FTP server.

Fields

Constructors

public FTPListEntry();

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public SocketSettings();

TLSConnectionInfo Type

Contains information about a network connection.

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

Fields

Constructors

public TLSConnectionInfo();

TLSSettings Type

A container for TLS connection settings.

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

Constructors

public TLSSettings();

UserAccount Type

A container for user account information.

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

Fields

Constructors

public UserAccount();

Config Settings (FTPServer Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

FTPServer Config Settings

Base Config Settings

Trappable Errors (FTPServer Class)

FTPServer Errors