public class

FTPSConnector

extends Object
java.lang.Object
   ↳ org.mule.modules.ftps.FTPSConnector
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The FTPS Connector allows you to establish a secure FTP connection

Summary

Constants
String DEFAULT_FILE_EXT
Fields
private ConnectorConfiguration connectorConfig
private static final Logger logger
private MuleContext muleContext
Public Constructors
FTPSConnector()
Public Methods
ConnectorConfiguration getConnectorConfig()
void onStart()
void read(SourceCallback callback, String filePath, String fileName, String moveToDir, int pollingPeriod, String specId)
read processor
void setConnectorConfig(ConnectorConfiguration connectorConfig)
void setMuleContext(MuleContext muleContext)
String write(String filePath, String fileName, String specId, InputStream payload, MuleEvent event)
Write processor
[Expand]
Inherited Methods
From class java.lang.Object

Constants

private static final String DEFAULT_FILE_EXT

Constant Value: ".dat"

Fields

private ConnectorConfiguration connectorConfig

private static final Logger logger

private MuleContext muleContext

Public Constructors

public FTPSConnector ()

Public Methods

public ConnectorConfiguration getConnectorConfig ()

Returns
  • the connectorConfig

public void onStart ()

Throws
FTPSConnectorException

public void read (SourceCallback callback, String filePath, String fileName, String moveToDir, int pollingPeriod, String specId)

read processor

Parameters
callback Used to pass the payload of the read file to the next component in the flow
filePath The path to the file to be read from the server
fileName The filename to be read from the server (wildcards supported)
moveToDir Directory to move files to after they've been read. If no value is set, the file will be deleted
pollingPeriod The period to wait between checking the server for updates
specId FTPS Specification ID taken from the B2B system when in use
Throws
FTPSConnectorException Wraps any internal error that may occur

public void setConnectorConfig (ConnectorConfiguration connectorConfig)

Parameters
connectorConfig The connectorConfig to set

public void setMuleContext (MuleContext muleContext)

Parameters
muleContext

public String write (String filePath, String fileName, String specId, InputStream payload, MuleEvent event)

Write processor

Parameters
filePath The path to the file to be read from the server.
fileName Prefix for the new file to be created
specId FTPS Specification ID taken from the B2B system when in use.
payload Event where to read the payload from
event
Returns
  • the definitive filename stored on the server
Throws
FTPSConnectorException Wraps any internal error that may occur