com.modus.mule.modules.ftps.config

Class BasicConfig

java.lang.Object

com.modus.mule.modules.ftps.config.AbstractConfig

com.modus.mule.modules.ftps.config.BasicConfig

@ConnectionManagement(configElementName="config",
                      friendlyName="Basic Configuration")
public class BasicConfig
extends AbstractConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BasicConfig.TestConnectionResult

Field Summary

Fields inherited from class com.modus.mule.modules.ftps.config.AbstractConfig

filePath, muleContext

Constructor Summary

Constructors

Constructor and Description
BasicConfig()

Method Summary

Modifier and Type	Method and Description
void	connect(String host, String port, String username, String password)
void	disconnect()
String	getClientKeyStorePassword()
String	getClientKeyStorePath()
FTPSClientConfig	getDefaultConnectionSetup(com.mulesoft.api.b2b.Direction direction) Sets up the internal ftps client config based on user configuration
Boolean	getDisableCertificateValidation()
Boolean	getDisableClientCertificateValidation()
String	getHost()
org.apache.commons.net.ftp.FTPSClient	getInboundConnection(FTPSClientConfig key)
String	getKeyStorePassword()
String	getKeyStorePath()
int	getMaxActivePort()
Integer	getMaxConcurrentReads()
int	getMinActivePort()
org.apache.commons.net.ftp.FTPSClient	getOutboundConnection(FTPSClientConfig localConfig)
String	getPassword()
String	getPort()
String	getReportedIpAddress()
FTPSSSLMode	getSslEncryptionMode()
Boolean	getStreaming()
FTPSTransferMode	getTransferMode()
String	getUploadTmpDir()
String	getUsername()
Boolean	isPartnerManager()
Object	recordTransmissionResults(FTPResult.FTPResultStatus status, com.mulesoft.api.b2b.Direction direction, org.apache.commons.net.ftp.FTPSClient client, String fileName, String errorMessage, org.mule.api.MuleEvent event)
void	setClientKeyStorePassword(String clientKeyStorePassword)
void	setClientKeyStorePath(String clientKeyStorePath)
void	setDisableCertificateValidation(Boolean disableCertificateValidation)
void	setDisableClientCertificateValidation(Boolean disableClientCertificateValidation)
void	setHost(String host)
void	setKeyStorePassword(String keyStorePassword)
void	setKeyStorePath(String keyStorePath)
void	setMaxActivePort(Integer maxActivePort)
void	setMaxConcurrentReads(Integer maxConcurrentReads)
void	setMinActivePort(Integer minActivePort)
void	setPassword(String password)
void	setPort(String port)
void	setReportedIpAddress(String reportedIpAddress)
void	setSslEncryptionMode(FTPSSSLMode sslEncryptionMode)
void	setStreaming(Boolean streaming)
void	setTransferMode(FTPSTransferMode transferMode)
void	setUploadTmpDir(String uploadTmpDir)
void	setUsername(String username)
void	testConnectivity(String host, String port, String username, String password)
boolean	validateConnection()

Methods inherited from class com.modus.mule.modules.ftps.config.AbstractConfig

clean, createMuleEvent, getFilename, getFilePath, getLockFactory, getMoveToDir, getMoveToFilename, getMuleContext, getPollingFrequency, getPollingInitialDelay, getPool, getSizeCheckWaitTime, getZeroSizeCheckMaxRetries, getZeroSizeCheckWaitTime, getZeroSizedIgnored, initializeInboundParameters, initializeOutboundParameters, isStreaming, overrideOutboundOperationSettings, parseMEL, parseMEL, preparePool, returnConnection, setFilename, setFilePath, setLockFactory, setMoveToDir, setMoveToFilename, setMuleContext, setPollingFrequency, setPollingInitialDelay, setSizeCheckWaitTime, setStreaming, setZeroSizeCheckMaxRetries, setZeroSizeCheckWaitTime, setZeroSizedIgnored, validateIncompatibleOutboundConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicConfig

public BasicConfig()

Method Detail

getDefaultConnectionSetup

public FTPSClientConfig getDefaultConnectionSetup(com.mulesoft.api.b2b.Direction direction)

Sets up the internal ftps client config based on user configuration

Specified by:

getDefaultConnectionSetup in class AbstractConfig

Returns:

an customized instance of FTPSClient

testConnectivity

@TestConnectivity
public void testConnectivity(String host,
                                               String port,
                                               String username,
                                               String password)
                                        throws org.mule.api.ConnectionException

Throws:

org.mule.api.ConnectionException

connect

@Connect
public void connect(@ConnectionKey
                             String host,
                             @ConnectionKey
                             String port,
                             @ConnectionKey
                             String username,
                             @Password @ConnectionKey
                             String password)
                      throws org.mule.api.ConnectionException

Throws:

org.mule.api.ConnectionException

validateConnection

@ValidateConnection
public boolean validateConnection()

disconnect

@Disconnect
public void disconnect()

getHost

public String getHost()

setHost

public void setHost(String host)

getKeyStorePath

public String getKeyStorePath()

setKeyStorePath

public void setKeyStorePath(String keyStorePath)

getKeyStorePassword

public String getKeyStorePassword()

setKeyStorePassword

public void setKeyStorePassword(String keyStorePassword)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getPort

public String getPort()

setPort

public void setPort(String port)

getMinActivePort

public int getMinActivePort()

setMinActivePort

public void setMinActivePort(Integer minActivePort)

getMaxActivePort

public int getMaxActivePort()

setMaxActivePort

public void setMaxActivePort(Integer maxActivePort)

setReportedIpAddress

public void setReportedIpAddress(String reportedIpAddress)

getReportedIpAddress

public String getReportedIpAddress()

getTransferMode

public FTPSTransferMode getTransferMode()

setTransferMode

public void setTransferMode(FTPSTransferMode transferMode)

getUploadTmpDir

public String getUploadTmpDir()

Overrides:

getUploadTmpDir in class AbstractConfig

setUploadTmpDir

public void setUploadTmpDir(String uploadTmpDir)

Overrides:

setUploadTmpDir in class AbstractConfig

getMaxConcurrentReads

public Integer getMaxConcurrentReads()

Overrides:

getMaxConcurrentReads in class AbstractConfig

setMaxConcurrentReads

public void setMaxConcurrentReads(Integer maxConcurrentReads)

Overrides:

setMaxConcurrentReads in class AbstractConfig

isPartnerManager

public Boolean isPartnerManager()

Specified by:

isPartnerManager in class AbstractConfig

getSslEncryptionMode

public FTPSSSLMode getSslEncryptionMode()

setSslEncryptionMode

public void setSslEncryptionMode(FTPSSSLMode sslEncryptionMode)

getStreaming

public Boolean getStreaming()

Specified by:

getStreaming in class AbstractConfig

setStreaming

public void setStreaming(Boolean streaming)

getDisableCertificateValidation

public Boolean getDisableCertificateValidation()

setDisableCertificateValidation

public void setDisableCertificateValidation(Boolean disableCertificateValidation)

getClientKeyStorePath

public String getClientKeyStorePath()

setClientKeyStorePath

public void setClientKeyStorePath(String clientKeyStorePath)

getClientKeyStorePassword

public String getClientKeyStorePassword()

setClientKeyStorePassword

public void setClientKeyStorePassword(String clientKeyStorePassword)

getDisableClientCertificateValidation

public Boolean getDisableClientCertificateValidation()

setDisableClientCertificateValidation

public void setDisableClientCertificateValidation(Boolean disableClientCertificateValidation)

getInboundConnection

public org.apache.commons.net.ftp.FTPSClient getInboundConnection(FTPSClientConfig key)
                                                           throws Exception

Specified by:

getInboundConnection in class AbstractConfig

Throws:

Exception

getOutboundConnection

public org.apache.commons.net.ftp.FTPSClient getOutboundConnection(FTPSClientConfig localConfig)
                                                            throws Exception

Specified by:

getOutboundConnection in class AbstractConfig

Throws:

Exception

recordTransmissionResults

public Object recordTransmissionResults(FTPResult.FTPResultStatus status,
                                        com.mulesoft.api.b2b.Direction direction,
                                        org.apache.commons.net.ftp.FTPSClient client,
                                        String fileName,
                                        String errorMessage,
                                        org.mule.api.MuleEvent event)

Specified by:

recordTransmissionResults in class AbstractConfig