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
int DEFAULT_EXPLICIT_FTPS_PORT
String DEFAULT_FILE_EXT
String PRIVATE
Fields
private B2BProvider b2b
private Boolean disableCertificateValidation Password for the FTPS Server
private String host Domain or IP address of the server
private String keyStorePassword Specify the password for SSL Certificate
private String keyStorePath Specify where the SSL Certificate is located
private static final Logger logger
private Integer maxActivePort Maximum port for Active data transfers
private Integer maxConcurrentReads If set, the connector will try to upload files to the temporary directory and move them to their final destination once the upload completes."
private Integer minActivePort Minimum port for Active data transfers
private MuleContext muleContext
private String password Password for the FTPS Server
private String port Port of the FTP server
private String reportedIpAddress Reportable IP address to be used in Active Mode
private FTPSSSLMode sslEncryptionMode Choose between implicit and explicit modes
private FTPSTransferMode transferMode Choose between active and passive modes
private String uploadTmpDir If set, the connector will try to upload files to the temporary directory and move them to their final destination once the upload completes."
private Boolean useB2BProvider Integrate with Anypoint B2B platform to manage your AS2 Connector and record AS2 transmissions.
private String username Username for the FTPS Server
Public Constructors
FTPSConnector()
Public Methods
B2BProvider getB2b()
Boolean getDisableCertificateValidation()
String getHost()
String getKeyStorePassword()
String getKeyStorePath()
int getMaxActivePort()
Integer getMaxConcurrentReads()
int getMinActivePort()
String getPassword()
String getPort()
String getReportedIpAddress()
FTPSSSLMode getSslEncryptionMode()
FTPSTransferMode getTransferMode()
String getUploadTmpDir()
Boolean getUseB2BProvider()
String getUsername()
void onStart()
void read(SourceCallback callback, String filePath, String fileName, String moveToDir, int pollingPeriod, String specId)
read processor
void setB2b(B2BProvider b2b)
void setDisableCertificateValidation(Boolean disableCertificateValidation)
void setHost(String host)
void setKeyStorePassword(String keyStorePassword)
void setKeyStorePath(String keyStorePath)
void setMaxActivePort(int maxActivePort)
void setMaxConcurrentReads(Integer maxConcurrentReads)
void setMinActivePort(int minActivePort)
void setMuleContext(MuleContext muleContext)
void setPassword(String password)
void setPort(String port)
void setReportedIpAddress(String reportedIpAddress)
void setSslEncryptionMode(FTPSSSLMode sslEncryptionMode)
void setTransferMode(FTPSTransferMode transferMode)
void setUploadTmpDir(String uploadTmpDir)
void setUseB2BProvider(Boolean useB2BProvider)
void setUsername(String username)
String write(String filePath, String fileName, String specId, MuleEvent muleEvent)
Write processor
[Expand]
Inherited Methods
From class java.lang.Object

Constants

private static final int DEFAULT_EXPLICIT_FTPS_PORT

Constant Value: 21 (0x00000015)

private static final String DEFAULT_FILE_EXT

Constant Value: ".dat"

private static final String PRIVATE

Constant Value: "P"

Fields

private B2BProvider b2b

private Boolean disableCertificateValidation

Password for the FTPS Server

private String host

Domain or IP address of the server

private String keyStorePassword

Specify the password for SSL Certificate

private String keyStorePath

Specify where the SSL Certificate is located

private static final Logger logger

private Integer maxActivePort

Maximum port for Active data transfers

private Integer maxConcurrentReads

If set, the connector will try to upload files to the temporary directory and move them to their final destination once the upload completes."

private Integer minActivePort

Minimum port for Active data transfers

private MuleContext muleContext

private String password

Password for the FTPS Server

private String port

Port of the FTP server

private String reportedIpAddress

Reportable IP address to be used in Active Mode

private FTPSSSLMode sslEncryptionMode

Choose between implicit and explicit modes

private FTPSTransferMode transferMode

Choose between active and passive modes

private String uploadTmpDir

If set, the connector will try to upload files to the temporary directory and move them to their final destination once the upload completes."

private Boolean useB2BProvider

Integrate with Anypoint B2B platform to manage your AS2 Connector and record AS2 transmissions. The B2B Connector must be set up before enabling this feature.

private String username

Username for the FTPS Server

Public Constructors

public FTPSConnector ()

Public Methods

public B2BProvider getB2b ()

Returns
  • the b2b

public Boolean getDisableCertificateValidation ()

Returns
  • the disableCertificateValidation

public String getHost ()

Returns
  • the host

public String getKeyStorePassword ()

Returns
  • the keyStorePassword

public String getKeyStorePath ()

Returns
  • the keyStorePath

public int getMaxActivePort ()

Returns
  • the maxActivePort

public Integer getMaxConcurrentReads ()

Returns
  • the maxConcurrentReads

public int getMinActivePort ()

Returns
  • the minActivePort

public String getPassword ()

Returns
  • the password

public String getPort ()

Returns
  • the port

public String getReportedIpAddress ()

Returns
  • the reportedIpAddress

public FTPSSSLMode getSslEncryptionMode ()

Returns
  • the sslEncryptionMode

public FTPSTransferMode getTransferMode ()

Returns
  • the transferMode

public String getUploadTmpDir ()

Returns
  • the uploadTmpDir

public Boolean getUseB2BProvider ()

Returns
  • the useB2BProvider

public String getUsername ()

Returns
  • the username

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 setB2b (B2BProvider b2b)

Parameters
b2b The b2b to set

public void setDisableCertificateValidation (Boolean disableCertificateValidation)

Parameters
disableCertificateValidation The disableCertificateValidation to set

public void setHost (String host)

Parameters
host The host to set

public void setKeyStorePassword (String keyStorePassword)

Parameters
keyStorePassword The keyStorePassword to set

public void setKeyStorePath (String keyStorePath)

Parameters
keyStorePath The keyStorePath to set

public void setMaxActivePort (int maxActivePort)

Parameters
maxActivePort The maxActivePort to set

public void setMaxConcurrentReads (Integer maxConcurrentReads)

Parameters
maxConcurrentReads The maxConcurrentReads to set

public void setMinActivePort (int minActivePort)

Parameters
minActivePort The minActivePort to set

public void setMuleContext (MuleContext muleContext)

Parameters
muleContext

public void setPassword (String password)

Parameters
password The password to set

public void setPort (String port)

Parameters
port The port to set

public void setReportedIpAddress (String reportedIpAddress)

Parameters
reportedIpAddress The reportedIpAddress to set

public void setSslEncryptionMode (FTPSSSLMode sslEncryptionMode)

Parameters
sslEncryptionMode The sslEncryptionMode to set

public void setTransferMode (FTPSTransferMode transferMode)

Parameters
transferMode The transferMode to set

public void setUploadTmpDir (String uploadTmpDir)

Parameters
uploadTmpDir The uploadTmpDir to set

public void setUseB2BProvider (Boolean useB2BProvider)

Parameters
useB2BProvider The useB2BProvider to set

public void setUsername (String username)

Parameters
username The username to set

public String write (String filePath, String fileName, String specId, MuleEvent muleEvent)

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.
muleEvent Event where to read the payload from
Returns
  • the definitive filename stored on the server
Throws
FTPSConnectorException Wraps any internal error that may occur