com.modus.mule.modules.ftps

Class FTPSConnector

java.lang.Object

com.modus.mule.modules.ftps.FTPSConnector

@Connector(name="ftps",
           friendlyName="FTPS",
           minMuleVersion="3.6.0")
 @Summary(value="The FTPS Connector allows you to establish a secure FTP connection over TLS/SSL")
 @RequiresEnterpriseLicense(allowEval=true)
 @RequiresEntitlement(name="ftps")
public class FTPSConnector
extends Object

The FTPS Connector allows you to establish a secure FTP connection

Author:

Fer Troya

Constructor Summary

Constructors

Constructor and Description
FTPSConnector()

Method Summary

Modifier and Type	Method and Description
AbstractConfig	getConfig()
AbstractConfig	getConnectorConfig()
void	onStart()
void	predestroy()
void	read(org.mule.api.callback.SourceCallback callback, String filePath, String fileName, String moveToDir, String moveToFilename, long pollingInitialDelay, long pollingFrequency, long sizeCheckWaitTime, boolean zeroSizedIgnored, long zeroSizeCheckWaitTime, Integer zeroSizeCheckMaxRetries) Read processor
void	setConfig(AbstractConfig config)
void	setConnectorConfig(AbstractConfig connectorConfig)
void	setMuleContext(org.mule.api.MuleContext muleContext)
String	write(String filePath, String fileName, Boolean appendContents, String oHost, String oPort, FTPSTransferMode oTransferMode, FTPSSSLMode oSSLEncryptionMode, String oUsername, String oPassword, String oServerKeyStorePath, String oServerKeyStorePassword, Boolean oDisableServerCertificateValidation, String oUploadTmpDir, Boolean oStreaming, String oReportedIpAddress, Integer oMinActivePort, Integer oMaxActivePort, InputStream payload, org.mule.api.MuleEvent event) Write processor

Methods inherited from class java.lang.Object

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

Constructor Detail

FTPSConnector

public FTPSConnector()

Method Detail

read

@Source
 @ReconnectOn(exceptions={FTPSConnectorException.class,org.mule.api.ConnectionException.class})
public void read(org.mule.api.callback.SourceCallback callback,
                                                                                                                         @Summary(value="The path to the file to be read from the server") @Default(value="/") @Placement(group="General") @FriendlyName(value="Path")
                                                                                                                         String filePath,
                                                                                                                         @Summary(value="The filename to be read from the server (wildcards supported)") @Default(value="") @Placement(group="General") @FriendlyName(value="Filename")
                                                                                                                         String fileName,
                                                                                                                         @Summary(value="Directory to move files to after they\'ve been read. If no value is set, the file will be deleted") @Placement(group="Post-processing") @FriendlyName(value="Move to directory") @Optional
                                                                                                                         String moveToDir,
                                                                                                                         @Summary(value="New filename to use under the move to directory. If no value is set, the original filename will be used") @Placement(group="Post-processing") @FriendlyName(value="Move to filename") @Optional
                                                                                                                         String moveToFilename,
                                                                                                                         @Summary(value="The period to wait before checking the server for updates") @Default(value="1000") @Placement(group="Polling") @FriendlyName(value="Initial delay (ms)")
                                                                                                                         long pollingInitialDelay,
                                                                                                                         @Summary(value="The period to wait between each poll cycle") @Default(value="1000") @Placement(group="Polling") @FriendlyName(value="Polling frequency (ms)")
                                                                                                                         long pollingFrequency,
                                                                                                                         @Summary(value="The period to wait between file size change detection cycles") @Default(value="0") @Placement(group="Polling") @FriendlyName(value="File size change detection frequency (ms)")
                                                                                                                         long sizeCheckWaitTime,
                                                                                                                         @Summary(value="Ignore zero-sized files") @Default(value="false") @Placement(group="Zero-sized files") @FriendlyName(value="Ignore zero-sized files")
                                                                                                                         boolean zeroSizedIgnored,
                                                                                                                         @Summary(value="The period to wait between file size change detection cycles for zero-sized files") @Default(value="2000") @Placement(group="Zero-sized files") @FriendlyName(value="File size change detection frequency (ms)")
                                                                                                                         long zeroSizeCheckWaitTime,
                                                                                                                         @Summary(value="Maximum number of size check attempts for zero-sized files") @Default(value="10") @Placement(group="Zero-sized files") @FriendlyName(value="Maximum number of size check attempts")
                                                                                                                         Integer zeroSizeCheckMaxRetries)
                                                                                                                  throws FTPSConnectorException

Read processor

Parameters:

fileName - The filename to be read from the server (wildcards supported)

filePath - The path to the file to be read from the server

moveToDir - Directory to move files to after they've been read. If no value is set, the file will be deleted

moveToFilename - New filename to use under the move to directory. If no value is set, the original filename will be used

callback - used to pass the payload of the read file to the next component in the flow

pollingFrequency - The period to wait between checking the server for updates

pollingInitialDelay - The period to wait before checking the server for updates

sizeCheckWaitTime - The period to wait between file size change detection cycles

zeroSizedIgnored - ignore zero-sized files

zeroSizeCheckMaxRetries - Maximum number of size check attempts for zero-sized files

zeroSizeCheckWaitTime - The period to wait between file size change detection cycles for zero-sized files

Throws:

FTPSConnectorException - Wraps any internal error that may occur

write

@Processor
public String write(@Summary(value="The path to the file to be read from the server") @Placement(group="General") @Default(value="/") @FriendlyName(value="Path")
                               String filePath,
                               @Summary(value="Filename on server") @Default(value="") @Placement(group="General") @FriendlyName(value="Filename")
                               String fileName,
                               @Summary(value="Append to existing file") @Default(value="false") @Placement(group="General") @FriendlyName(value="Append contents")
                               Boolean appendContents,
                               @Optional @Placement(tab="Advanced",group="Connection Settings (Override)") @FriendlyName(value="Host")
                               String oHost,
                               @Optional @Placement(tab="Advanced",group="Connection Settings (Override)") @FriendlyName(value="Port")
                               String oPort,
                               @Optional @Summary(value="Choose between active and passive modes. Fill in the Active Mode section inthe Advanced tab details if needed.") @Placement(tab="Advanced",group="Connection Settings (Override)") @FriendlyName(value="Transfer Mode")
                               FTPSTransferMode oTransferMode,
                               @Optional @Summary(value="Choose between implicit and explicit modes") @Placement(tab="Advanced",group="Connection Settings (Override)") @FriendlyName(value="Encryption mode")
                               FTPSSSLMode oSSLEncryptionMode,
                               @Optional @Summary(value="Username for the FTP server") @Placement(tab="Advanced",group="Security Credentials (Override)") @FriendlyName(value="Username")
                               String oUsername,
                               @Optional @Summary(value="Pass for the FTP server") @Placement(tab="Advanced",group="Security Credentials (Override)") @FriendlyName(value="Password") @Password
                               String oPassword,
                               @Optional @Summary(value="Path to the SSL certificate") @Placement(tab="Advanced",group="Security - Server Certificates (Override)") @FriendlyName(value="Keystore path") @Path
                               String oServerKeyStorePath,
                               @Optional @Summary(value="Pass for the SSL certificate") @Placement(tab="Advanced",group="Security - Server Certificates (Override)") @FriendlyName(value="Keystore password") @Password
                               String oServerKeyStorePassword,
                               @Optional @Summary(value="WARNING: usage of this option is not recommended") @Placement(tab="Advanced",group="Security - Server Certificates (Override)") @FriendlyName(value="Disable certificate validation")
                               Boolean oDisableServerCertificateValidation,
                               @Optional @Summary(value="If set, the connector will try to upload files to this temp directory on the server and move them to their final destination once the upload is completed.") @Placement(tab="Advanced",group="Pre-processing (Override)") @FriendlyName(value="Upload temp directory")
                               String oUploadTmpDir,
                               @Optional @Summary(value="Whether the payload content should be returned as a stream or a byte array. A stream is recommended for large files.") @Placement(tab="Advanced",group="Connection Settings (Override)") @FriendlyName(value="Streaming")
                               Boolean oStreaming,
                               @Optional @Summary(value="Reportable IP address to be used in Active Mode") @Placement(tab="Advanced",group="Active Mode Settings (Override)") @FriendlyName(value="Reported IP Address")
                               String oReportedIpAddress,
                               @Optional @Summary(value="Port range for tranfers in Active Mode") @Placement(tab="Advanced",group="Active Mode Settings (Override)") @FriendlyName(value="Minimum Port No.")
                               Integer oMinActivePort,
                               @Optional @Summary(value="Port range for tranfers in Active Mode") @Placement(tab="Advanced",group="Active Mode Settings (Override)") @FriendlyName(value="Maximum Port No.")
                               Integer oMaxActivePort,
                               @Default(value="#[payload]")
                               InputStream payload,
                               org.mule.api.MuleEvent event)
                        throws FTPSConnectorException

Write processor

Parameters:

filePath - The path to the file to be read from the server.

fileName - Prefix for the new file to be created

appendContents - whether to append contents to an existing file or override it (default).

oHost - host setting override

oPort - port setting override

oTransferMode - transfer mode setting override

oSSLEncryptionMode - SSL encryption mode setting override

oUsername - username setting override

oPassword - password setting override

oServerKeyStorePath - server keystore path setting override

oServerKeyStorePassword - server keystore password setting override

oDisableServerCertificateValidation - disable server certificate validation setting override

oUploadTmpDir - upload temp directory setting override

oStreaming - streaming setting override

oReportedIpAddress - reported IP address setting override for Active Mode

oMinActivePort - minimum client port setting override for Active Mode

oMaxActivePort - maximum client port setting override for Active Mode

payload - event where to read the payload from

event - the MuleEvent to pass transmission data to

Returns:

the definitive filename stored on the server

Throws:

FTPSConnectorException - Wraps any internal error that may occur

onStart

@PostConstruct
public void onStart()
                            throws FTPSConnectorException,
                                   org.mule.api.registry.RegistrationException

Throws:

FTPSConnectorException

org.mule.api.registry.RegistrationException

predestroy

@PreDestroy
public void predestroy()

setMuleContext

public void setMuleContext(org.mule.api.MuleContext muleContext)

getConfig

public AbstractConfig getConfig()

setConfig

public void setConfig(AbstractConfig config)

getConnectorConfig

public AbstractConfig getConnectorConfig()

setConnectorConfig

public void setConnectorConfig(AbstractConfig connectorConfig)