@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
Constructor and Description |
---|
FTPSConnector() |
Modifier and Type | Method and Description |
---|---|
AbstractConfig |
getConnectorConfig() |
void |
onStart() |
void |
predestroy() |
void |
read(org.mule.api.callback.SourceCallback callback,
String filePath,
String fileName,
String moveToDir,
int pollingFrequency)
read processor
|
void |
setConnectorConfig(AbstractConfig connectorConfig) |
void |
setMuleContext(org.mule.api.MuleContext muleContext) |
String |
write(String filePath,
String fileName,
InputStream payload,
org.mule.api.MuleEvent event)
Write processor
|
@Processor public String write(@Summary(value="The path to the file to be read from the server")@Placement(group="General options")@Default(value="/")@FriendlyName(value="Path") String filePath, @Summary(value="Filename on server")@Default(value="")@Placement(group="General options")@FriendlyName(value="Filename") String fileName, @Default(value="#[payload]") InputStream payload, org.mule.api.MuleEvent event) throws FTPSConnectorException
fileName
- Prefix for the new file to be createdpayload
- event where to read the payload fromfilePath
- The path to the file to be read from the server.FTPSConnectorException
- Wraps any internal error that may occur@PreDestroy public void predestroy()
@Source 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 options")@FriendlyName(value="Path") String filePath, @Summary(value="The filename to be read from the server (wildcards supported)")@Default(value="")@Placement(group="General options")@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="The period to wait between checking the server for updates")@Default(value="1000")@Placement(group="Polling")@FriendlyName(value="Polling Frequency (ms)") int pollingFrequency) throws FTPSConnectorException
fileName
- The filename to be read from the server (wildcards supported)filePath
- The path to the file to be read from the servercallback
- used to pass the payload of the read file to the next component in the flowpollingFrequency
- The period to wait between checking the server for updatesmoveToDir
- Directory to move files to after they've been read. If no value is set, the file will be deletedFTPSConnectorException
- Wraps any internal error that may occur@PostConstruct public void onStart() throws FTPSConnectorException, org.mule.api.registry.RegistrationException
FTPSConnectorException
org.mule.api.registry.RegistrationException
public void setMuleContext(org.mule.api.MuleContext muleContext)
public AbstractConfig getConnectorConfig()
public void setConnectorConfig(AbstractConfig connectorConfig)
connectorConfig
- the connectorConfig to setCopyright © 2010–2016. All rights reserved.