Package org.ikasan.endpoint.ftp.consumer
Class FtpConsumerConfiguration
- java.lang.Object
-
- org.ikasan.component.endpoint.quartz.consumer.ScheduledConsumerConfiguration
-
- org.ikasan.endpoint.ftp.consumer.FtpConsumerConfiguration
-
- All Implemented Interfaces:
org.ikasan.spec.configuration.IsValidationAware
- Direct Known Subclasses:
FtpConsumerAlternateConfiguration
public class FtpConsumerConfiguration extends org.ikasan.component.endpoint.quartz.consumer.ScheduledConsumerConfiguration implements org.ikasan.spec.configuration.IsValidationAwareFTP Consumer Configuration window.- Author:
- Ikasan Development Team
-
-
Constructor Summary
Constructors Constructor Description FtpConsumerConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.BooleangetActive()java.lang.IntegergetAgeOfFiles()java.lang.BooleangetChecksum()java.lang.BooleangetChronological()java.lang.BooleangetChunking()java.lang.IntegergetChunkSize()java.lang.BooleangetCleanupJournalOnComplete()java.lang.StringgetClientID()java.lang.IntegergetConnectionTimeout()java.lang.IntegergetDataTimeout()java.lang.BooleangetDestructive()java.lang.StringgetFilenamePattern()java.lang.BooleangetFilterDuplicates()java.lang.BooleangetFilterOnFilename()java.lang.BooleangetFilterOnLastModifiedDate()java.lang.BooleangetFTPS()java.lang.BooleangetFtpsIsImplicit()java.lang.StringgetFtpsKeyStoreFilePassword()java.lang.StringgetFtpsKeyStoreFilePath()java.lang.IntegergetFtpsPort()java.lang.StringgetFtpsProtocol()java.lang.BooleangetIsRecursive()java.lang.IntegergetMaxRetryAttempts()java.lang.IntegergetMaxRows()java.lang.LonggetMinAge()java.lang.BooleangetMoveOnSuccess()java.lang.StringgetMoveOnSuccessNewPath()java.lang.StringgetPassword()java.lang.StringgetPasswordFilePath()java.lang.BooleangetProvideRelativePath()java.lang.StringgetRemoteHost()java.lang.IntegergetRemotePort()java.lang.BooleangetRenameOnSuccess()java.lang.StringgetRenameOnSuccessExtension()java.lang.IntegergetSocketTimeout()java.lang.StringgetSourceDirectory()org.ikasan.framework.factory.DirectoryURLFactorygetSourceDirectoryURLFactory()java.lang.StringgetSystemKey()java.lang.StringgetUsername()java.lang.BooleanisFTPS()voidsetActive(java.lang.Boolean active)voidsetAgeOfFiles(java.lang.Integer ageOfFiles)voidsetChecksum(java.lang.Boolean checksum)voidsetChronological(java.lang.Boolean chronological)voidsetChunking(java.lang.Boolean chunking)voidsetChunkSize(java.lang.Integer chunkSize)voidsetCleanupJournalOnComplete(java.lang.Boolean cleanupJournalOnComplete)voidsetClientID(java.lang.String clientID)voidsetConnectionTimeout(java.lang.Integer connectionTimeout)voidsetDataTimeout(java.lang.Integer dataTimeout)voidsetDestructive(java.lang.Boolean destructive)voidsetFilenamePattern(java.lang.String filenamePattern)voidsetFilterDuplicates(java.lang.Boolean filterDuplicates)voidsetFilterOnFilename(java.lang.Boolean filterOnFilename)voidsetFilterOnLastModifiedDate(java.lang.Boolean filterOnLastModifiedDate)voidsetFTPS(java.lang.Boolean FTPS)voidsetFtpsIsImplicit(java.lang.Boolean ftpsIsImplicit)voidsetFtpsKeyStoreFilePassword(java.lang.String ftpsKeyStoreFilePassword)voidsetFtpsKeyStoreFilePath(java.lang.String ftpsKeyStoreFilePath)voidsetFtpsPort(java.lang.Integer ftpsPort)voidsetFtpsProtocol(java.lang.String ftpsProtocol)voidsetIsRecursive(java.lang.Boolean isRecursive)voidsetMaxRetryAttempts(java.lang.Integer maxRetryAttempts)voidsetMaxRows(java.lang.Integer maxRows)voidsetMinAge(java.lang.Long minAge)voidsetMoveOnSuccess(java.lang.Boolean moveOnSuccess)voidsetMoveOnSuccessNewPath(java.lang.String moveOnSuccessNewPath)voidsetPassword(java.lang.String password)voidsetPasswordFilePath(java.lang.String passwordFilePath)voidsetProvideRelativePath(java.lang.Boolean provideRelativePath)voidsetRemoteHost(java.lang.String remoteHost)voidsetRemotePort(java.lang.Integer remotePort)voidsetRenameOnSuccess(java.lang.Boolean renameOnSuccess)voidsetRenameOnSuccessExtension(java.lang.String renameOnSuccessExtension)voidsetSocketTimeout(java.lang.Integer socketTimeout)voidsetSourceDirectory(java.lang.String sourceDirectory)voidsetSourceDirectoryURLFactory(org.ikasan.framework.factory.DirectoryURLFactory sourceDirectoryURLFactory)voidsetSystemKey(java.lang.String systemKey)voidsetUsername(java.lang.String username)voidvalidate()Validate configured properties.-
Methods inherited from class org.ikasan.component.endpoint.quartz.consumer.ScheduledConsumerConfiguration
getCronExpression, getDescription, getJobGroupName, getJobName, getMaxEagerCallbacks, getPassthroughProperties, getRecoveryTolerance, getTimezone, isEager, isIgnoreMisfire, isPersistentRecovery, setCronExpression, setDescription, setEager, setIgnoreMisfire, setJobGroupName, setJobName, setMaxEagerCallbacks, setPassthroughProperties, setPersistentRecovery, setRecoveryTolerance, setTimezone
-
-
-
-
Method Detail
-
validate
public void validate() throws org.ikasan.spec.configuration.InvalidConfigurationExceptionValidate configured properties.- Specified by:
validatein interfaceorg.ikasan.spec.configuration.IsValidationAware- Overrides:
validatein classorg.ikasan.component.endpoint.quartz.consumer.ScheduledConsumerConfiguration- Throws:
org.ikasan.spec.configuration.InvalidConfigurationException- if combination of configured properties is invalid
-
getSourceDirectory
public java.lang.String getSourceDirectory()
- Returns:
- the sourceDirectory
-
setSourceDirectory
public void setSourceDirectory(java.lang.String sourceDirectory)
- Parameters:
sourceDirectory- the sourceDirectory to set
-
getFilenamePattern
public java.lang.String getFilenamePattern()
- Returns:
- the filenamePattern
-
setFilenamePattern
public void setFilenamePattern(java.lang.String filenamePattern)
- Parameters:
filenamePattern- the filenamePattern to set
-
getSourceDirectoryURLFactory
public org.ikasan.framework.factory.DirectoryURLFactory getSourceDirectoryURLFactory()
- Returns:
- the sourceDirectoryURLFactory
-
setSourceDirectoryURLFactory
public void setSourceDirectoryURLFactory(org.ikasan.framework.factory.DirectoryURLFactory sourceDirectoryURLFactory)
- Parameters:
sourceDirectoryURLFactory- the sourceDirectoryURLFactory to set
-
getFilterDuplicates
public java.lang.Boolean getFilterDuplicates()
- Returns:
- the filterDuplicates
-
setFilterDuplicates
public void setFilterDuplicates(java.lang.Boolean filterDuplicates)
- Parameters:
filterDuplicates- the filterDuplicates to set
-
getFilterOnFilename
public java.lang.Boolean getFilterOnFilename()
- Returns:
- the filterOnFilename
-
setFilterOnFilename
public void setFilterOnFilename(java.lang.Boolean filterOnFilename)
- Parameters:
filterOnFilename- the filterOnFilename to set
-
getFilterOnLastModifiedDate
public java.lang.Boolean getFilterOnLastModifiedDate()
- Returns:
- the filterOnLastModifiedDate
-
setFilterOnLastModifiedDate
public void setFilterOnLastModifiedDate(java.lang.Boolean filterOnLastModifiedDate)
- Parameters:
filterOnLastModifiedDate- the filterOnLastModifiedDate to set
-
getRenameOnSuccess
public java.lang.Boolean getRenameOnSuccess()
- Returns:
- the renameOnSuccess
-
setRenameOnSuccess
public void setRenameOnSuccess(java.lang.Boolean renameOnSuccess)
- Parameters:
renameOnSuccess- the renameOnSuccess to set
-
getRenameOnSuccessExtension
public java.lang.String getRenameOnSuccessExtension()
- Returns:
- the renameOnSuccessExtension
-
setRenameOnSuccessExtension
public void setRenameOnSuccessExtension(java.lang.String renameOnSuccessExtension)
- Parameters:
renameOnSuccessExtension- the renameOnSuccessExtension to set
-
getMoveOnSuccess
public java.lang.Boolean getMoveOnSuccess()
- Returns:
- the moveOnSuccess
-
setMoveOnSuccess
public void setMoveOnSuccess(java.lang.Boolean moveOnSuccess)
- Parameters:
moveOnSuccess- the moveOnSuccess to set
-
getMoveOnSuccessNewPath
public java.lang.String getMoveOnSuccessNewPath()
- Returns:
- the moveOnSuccessNewPath
-
setMoveOnSuccessNewPath
public void setMoveOnSuccessNewPath(java.lang.String moveOnSuccessNewPath)
- Parameters:
moveOnSuccessNewPath- the moveOnSuccessNewPath to set
-
getChronological
public java.lang.Boolean getChronological()
- Returns:
- the chronological
-
setChronological
public void setChronological(java.lang.Boolean chronological)
- Parameters:
chronological- the chronological to set
-
getChunking
public java.lang.Boolean getChunking()
- Returns:
- the chunking
-
setChunking
public void setChunking(java.lang.Boolean chunking)
- Parameters:
chunking- the chunking to set
-
getIsRecursive
public java.lang.Boolean getIsRecursive()
- Returns:
- the isRecursive
-
setIsRecursive
public void setIsRecursive(java.lang.Boolean isRecursive)
- Parameters:
isRecursive- the isRecursive to set
-
getChunkSize
public java.lang.Integer getChunkSize()
- Returns:
- the chunkSize
-
setChunkSize
public void setChunkSize(java.lang.Integer chunkSize)
- Parameters:
chunkSize- the chunkSize to set
-
getChecksum
public java.lang.Boolean getChecksum()
- Returns:
- the checksum
-
setChecksum
public void setChecksum(java.lang.Boolean checksum)
- Parameters:
checksum- the checksum to set
-
getMinAge
public java.lang.Long getMinAge()
- Returns:
- the minAge
-
setMinAge
public void setMinAge(java.lang.Long minAge)
- Parameters:
minAge- the minAge to set
-
getDestructive
public java.lang.Boolean getDestructive()
- Returns:
- the destructive
-
setDestructive
public void setDestructive(java.lang.Boolean destructive)
- Parameters:
destructive- the destructive to set
-
getMaxRows
public java.lang.Integer getMaxRows()
- Returns:
- the maxRows
-
setMaxRows
public void setMaxRows(java.lang.Integer maxRows)
- Parameters:
maxRows- the maxRows to set
-
getAgeOfFiles
public java.lang.Integer getAgeOfFiles()
- Returns:
- the ageOfFiles
-
setAgeOfFiles
public void setAgeOfFiles(java.lang.Integer ageOfFiles)
- Parameters:
ageOfFiles- the ageOfFiles to set
-
getClientID
public java.lang.String getClientID()
- Returns:
- the clientID
-
setClientID
public void setClientID(java.lang.String clientID)
- Parameters:
clientID- the clientID to set
-
getCleanupJournalOnComplete
public java.lang.Boolean getCleanupJournalOnComplete()
- Returns:
- the cleanupJournalOnComplete
-
setCleanupJournalOnComplete
public void setCleanupJournalOnComplete(java.lang.Boolean cleanupJournalOnComplete)
- Parameters:
cleanupJournalOnComplete- the cleanupJournalOnComplete to set
-
getRemoteHost
public java.lang.String getRemoteHost()
- Returns:
- the remoteHost
-
setRemoteHost
public void setRemoteHost(java.lang.String remoteHost)
- Parameters:
remoteHost- the remoteHost to set
-
getRemotePort
public java.lang.Integer getRemotePort()
- Returns:
- the remotePort
-
setRemotePort
public void setRemotePort(java.lang.Integer remotePort)
- Parameters:
remotePort- the remotePort to set
-
getMaxRetryAttempts
public java.lang.Integer getMaxRetryAttempts()
- Returns:
- the maxRetryAttempts
-
setMaxRetryAttempts
public void setMaxRetryAttempts(java.lang.Integer maxRetryAttempts)
- Parameters:
maxRetryAttempts- the maxRetryAttempts to set
-
getUsername
public java.lang.String getUsername()
- Returns:
- the username
-
setUsername
public void setUsername(java.lang.String username)
- Parameters:
username- the username to set
-
getPassword
public java.lang.String getPassword()
- Returns:
- the password
-
setPassword
public void setPassword(java.lang.String password)
- Parameters:
password- the password to set
-
getActive
public java.lang.Boolean getActive()
- Returns:
- the active
-
setActive
public void setActive(java.lang.Boolean active)
- Parameters:
active- the active to set
-
getConnectionTimeout
public java.lang.Integer getConnectionTimeout()
- Returns:
- the connectionTimeout
-
setConnectionTimeout
public void setConnectionTimeout(java.lang.Integer connectionTimeout)
- Parameters:
connectionTimeout- the connectionTimeout to set
-
getDataTimeout
public java.lang.Integer getDataTimeout()
- Returns:
- the dataTimeout
-
setDataTimeout
public void setDataTimeout(java.lang.Integer dataTimeout)
- Parameters:
dataTimeout- the dataTimeout to set
-
getSocketTimeout
public java.lang.Integer getSocketTimeout()
- Returns:
- the socketTimeout
-
setSocketTimeout
public void setSocketTimeout(java.lang.Integer socketTimeout)
- Parameters:
socketTimeout- the socketTimeout to set
-
setSystemKey
public void setSystemKey(java.lang.String systemKey)
- Parameters:
systemKey- the systemKey to set
-
getSystemKey
public java.lang.String getSystemKey()
- Returns:
- the systemKey
-
getFTPS
public java.lang.Boolean getFTPS()
-
isFTPS
public java.lang.Boolean isFTPS()
-
setFTPS
public void setFTPS(java.lang.Boolean FTPS)
-
getFtpsPort
public java.lang.Integer getFtpsPort()
-
setFtpsPort
public void setFtpsPort(java.lang.Integer ftpsPort)
-
getFtpsProtocol
public java.lang.String getFtpsProtocol()
-
setFtpsProtocol
public void setFtpsProtocol(java.lang.String ftpsProtocol)
-
getFtpsIsImplicit
public java.lang.Boolean getFtpsIsImplicit()
-
setFtpsIsImplicit
public void setFtpsIsImplicit(java.lang.Boolean ftpsIsImplicit)
-
getFtpsKeyStoreFilePath
public java.lang.String getFtpsKeyStoreFilePath()
-
setFtpsKeyStoreFilePath
public void setFtpsKeyStoreFilePath(java.lang.String ftpsKeyStoreFilePath)
-
getFtpsKeyStoreFilePassword
public java.lang.String getFtpsKeyStoreFilePassword()
-
setFtpsKeyStoreFilePassword
public void setFtpsKeyStoreFilePassword(java.lang.String ftpsKeyStoreFilePassword)
-
getPasswordFilePath
public java.lang.String getPasswordFilePath()
- Returns:
- the passwordFilePath
-
setPasswordFilePath
public void setPasswordFilePath(java.lang.String passwordFilePath)
- Parameters:
passwordFilePath- the passwordFilePath to set
-
getProvideRelativePath
public java.lang.Boolean getProvideRelativePath()
- Returns:
- the provideRelativePath
-
setProvideRelativePath
public void setProvideRelativePath(java.lang.Boolean provideRelativePath)
- Parameters:
provideRelativePath- the provideRelativePath flag to set
-
-