FtpConsumerConfiguration (ikasan-ftp-endpoint 2.0.0-beta API)

java.lang.Object
- org.ikasan.component.endpoint.quartz.consumer.ScheduledConsumerConfiguration
- - org.ikasan.endpoint.ftp.consumer.FtpConsumerConfiguration

Direct Known Subclasses:

FtpConsumerAlternateConfiguration
```
public class FtpConsumerConfiguration
extends ScheduledConsumerConfiguration
```
FTP Consumer Configuration window.

Author:

Ikasan Development Team

Constructor Summary

Constructors
Constructor and Description

FtpConsumerConfiguration()

Constructors
Constructor and Description
`FtpConsumerConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getActive()`
`Integer`	`getAgeOfFiles()`
`Boolean`	`getChecksum()`
`Boolean`	`getChronological()`
`Boolean`	`getChunking()`
`Integer`	`getChunkSize()`
`Boolean`	`getCleanupJournalOnComplete()`
`String`	`getClientID()`
`Integer`	`getConnectionTimeout()`
`Integer`	`getDataTimeout()`
`Boolean`	`getDestructive()`
`String`	`getFilenamePattern()`
`Boolean`	`getFilterDuplicates()`
`Boolean`	`getFilterOnFilename()`
`Boolean`	`getFilterOnLastModifiedDate()`
`Boolean`	`getFtpsIsImplicit()`
`String`	`getFtpsKeyStoreFilePassword()`
`String`	`getFtpsKeyStoreFilePath()`
`Integer`	`getFtpsPort()`
`String`	`getFtpsProtocol()`
`Boolean`	`getIsFTPS()`
`Boolean`	`getIsRecursive()`
`Integer`	`getMaxRetryAttempts()`
`Integer`	`getMaxRows()`
`Long`	`getMinAge()`
`Boolean`	`getMoveOnSuccess()`
`String`	`getMoveOnSuccessNewPath()`
`String`	`getPassword()`
`String`	`getPasswordFilePath()`
`String`	`getRemoteHost()`
`Integer`	`getRemotePort()`
`Boolean`	`getRenameOnSuccess()`
`String`	`getRenameOnSuccessExtension()`
`Integer`	`getSocketTimeout()`
`String`	`getSourceDirectory()`
`DirectoryURLFactory`	`getSourceDirectoryURLFactory()`
`String`	`getSystemKey()`
`String`	`getUsername()`
`void`	`setActive(Boolean active)`
`void`	`setAgeOfFiles(Integer ageOfFiles)`
`void`	`setChecksum(Boolean checksum)`
`void`	`setChronological(Boolean chronological)`
`void`	`setChunking(Boolean chunking)`
`void`	`setChunkSize(Integer chunkSize)`
`void`	`setCleanupJournalOnComplete(Boolean cleanupJournalOnComplete)`
`void`	`setClientID(String clientID)`
`void`	`setConnectionTimeout(Integer connectionTimeout)`
`void`	`setDataTimeout(Integer dataTimeout)`
`void`	`setDestructive(Boolean destructive)`
`void`	`setFilenamePattern(String filenamePattern)`
`void`	`setFilterDuplicates(Boolean filterDuplicates)`
`void`	`setFilterOnFilename(Boolean filterOnFilename)`
`void`	`setFilterOnLastModifiedDate(Boolean filterOnLastModifiedDate)`
`void`	`setFtpsIsImplicit(Boolean ftpsIsImplicit)`
`void`	`setFtpsKeyStoreFilePassword(String ftpsKeyStoreFilePassword)`
`void`	`setFtpsKeyStoreFilePath(String ftpsKeyStoreFilePath)`
`void`	`setFtpsPort(Integer ftpsPort)`
`void`	`setFtpsProtocol(String ftpsProtocol)`
`void`	`setIsFTPS(Boolean isFTPS)`
`void`	`setIsRecursive(Boolean isRecursive)`
`void`	`setMaxRetryAttempts(Integer maxRetryAttempts)`
`void`	`setMaxRows(Integer maxRows)`
`void`	`setMinAge(Long minAge)`
`void`	`setMoveOnSuccess(Boolean moveOnSuccess)`
`void`	`setMoveOnSuccessNewPath(String moveOnSuccessNewPath)`
`void`	`setPassword(String password)`
`void`	`setPasswordFilePath(String passwordFilePath)`
`void`	`setRemoteHost(String remoteHost)`
`void`	`setRemotePort(Integer remotePort)`
`void`	`setRenameOnSuccess(Boolean renameOnSuccess)`
`void`	`setRenameOnSuccessExtension(String renameOnSuccessExtension)`
`void`	`setSocketTimeout(Integer socketTimeout)`
`void`	`setSourceDirectory(String sourceDirectory)`
`void`	`setSourceDirectoryURLFactory(DirectoryURLFactory sourceDirectoryURLFactory)`
`void`	`setSystemKey(String systemKey)`
`void`	`setUsername(String username)`
`void`	`validate()` Validate configured properties.

Methods inherited from class org.ikasan.component.endpoint.quartz.consumer.ScheduledConsumerConfiguration
getCronExpression, getTimezone, isEager, isIgnoreMisfire, setCronExpression, setEager, setIgnoreMisfire, setTimezone

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FtpConsumerConfiguration
```
public FtpConsumerConfiguration()
```
- Method Detail
  - validate
```
public void validate()
              throws javax.resource.spi.InvalidPropertyException
```
    Validate configured properties.
    
    Throws:
    
    javax.resource.spi.InvalidPropertyException - if combination of configured properties is invalid
  - getSourceDirectory
```
public String getSourceDirectory()
```
    Returns:
    
    the sourceDirectory
  - setSourceDirectory
```
public void setSourceDirectory(String sourceDirectory)
```
    Parameters:
    
    sourceDirectory - the sourceDirectory to set
  - getFilenamePattern
```
public String getFilenamePattern()
```
    Returns:
    
    the filenamePattern
  - setFilenamePattern
```
public void setFilenamePattern(String filenamePattern)
```
    Parameters:
    
    filenamePattern - the filenamePattern to set
  - getSourceDirectoryURLFactory
```
public DirectoryURLFactory getSourceDirectoryURLFactory()
```
    Returns:
    
    the sourceDirectoryURLFactory
  - setSourceDirectoryURLFactory
```
public void setSourceDirectoryURLFactory(DirectoryURLFactory sourceDirectoryURLFactory)
```
    Parameters:
    
    sourceDirectoryURLFactory - the sourceDirectoryURLFactory to set
  - getFilterDuplicates
```
public Boolean getFilterDuplicates()
```
    Returns:
    
    the filterDuplicates
  - setFilterDuplicates
```
public void setFilterDuplicates(Boolean filterDuplicates)
```
    Parameters:
    
    filterDuplicates - the filterDuplicates to set
  - getFilterOnFilename
```
public Boolean getFilterOnFilename()
```
    Returns:
    
    the filterOnFilename
  - setFilterOnFilename
```
public void setFilterOnFilename(Boolean filterOnFilename)
```
    Parameters:
    
    filterOnFilename - the filterOnFilename to set
  - getFilterOnLastModifiedDate
```
public Boolean getFilterOnLastModifiedDate()
```
    Returns:
    
    the filterOnLastModifiedDate
  - setFilterOnLastModifiedDate
```
public void setFilterOnLastModifiedDate(Boolean filterOnLastModifiedDate)
```
    Parameters:
    
    filterOnLastModifiedDate - the filterOnLastModifiedDate to set
  - getRenameOnSuccess
```
public Boolean getRenameOnSuccess()
```
    Returns:
    
    the renameOnSuccess
  - setRenameOnSuccess
```
public void setRenameOnSuccess(Boolean renameOnSuccess)
```
    Parameters:
    
    renameOnSuccess - the renameOnSuccess to set
  - getRenameOnSuccessExtension
```
public String getRenameOnSuccessExtension()
```
    Returns:
    
    the renameOnSuccessExtension
  - setRenameOnSuccessExtension
```
public void setRenameOnSuccessExtension(String renameOnSuccessExtension)
```
    Parameters:
    
    renameOnSuccessExtension - the renameOnSuccessExtension to set
  - getMoveOnSuccess
```
public Boolean getMoveOnSuccess()
```
    Returns:
    
    the moveOnSuccess
  - setMoveOnSuccess
```
public void setMoveOnSuccess(Boolean moveOnSuccess)
```
    Parameters:
    
    moveOnSuccess - the moveOnSuccess to set
  - getMoveOnSuccessNewPath
```
public String getMoveOnSuccessNewPath()
```
    Returns:
    
    the moveOnSuccessNewPath
  - setMoveOnSuccessNewPath
```
public void setMoveOnSuccessNewPath(String moveOnSuccessNewPath)
```
    Parameters:
    
    moveOnSuccessNewPath - the moveOnSuccessNewPath to set
  - getChronological
```
public Boolean getChronological()
```
    Returns:
    
    the chronological
  - setChronological
```
public void setChronological(Boolean chronological)
```
    Parameters:
    
    chronological - the chronological to set
  - getChunking
```
public Boolean getChunking()
```
    Returns:
    
    the chunking
  - setChunking
```
public void setChunking(Boolean chunking)
```
    Parameters:
    
    chunking - the chunking to set
  - getIsRecursive
```
public Boolean getIsRecursive()
```
    Returns:
    
    the isRecursive
  - setIsRecursive
```
public void setIsRecursive(Boolean isRecursive)
```
    Parameters:
    
    isRecursive - the isRecursive to set
  - getChunkSize
```
public Integer getChunkSize()
```
    Returns:
    
    the chunkSize
  - setChunkSize
```
public void setChunkSize(Integer chunkSize)
```
    Parameters:
    
    chunkSize - the chunkSize to set
  - getChecksum
```
public Boolean getChecksum()
```
    Returns:
    
    the checksum
  - setChecksum
```
public void setChecksum(Boolean checksum)
```
    Parameters:
    
    checksum - the checksum to set
  - getMinAge
```
public Long getMinAge()
```
    Returns:
    
    the minAge
  - setMinAge
```
public void setMinAge(Long minAge)
```
    Parameters:
    
    minAge - the minAge to set
  - getDestructive
```
public Boolean getDestructive()
```
    Returns:
    
    the destructive
  - setDestructive
```
public void setDestructive(Boolean destructive)
```
    Parameters:
    
    destructive - the destructive to set
  - getMaxRows
```
public Integer getMaxRows()
```
    Returns:
    
    the maxRows
  - setMaxRows
```
public void setMaxRows(Integer maxRows)
```
    Parameters:
    
    maxRows - the maxRows to set
  - getAgeOfFiles
```
public Integer getAgeOfFiles()
```
    Returns:
    
    the ageOfFiles
  - setAgeOfFiles
```
public void setAgeOfFiles(Integer ageOfFiles)
```
    Parameters:
    
    ageOfFiles - the ageOfFiles to set
  - getClientID
```
public String getClientID()
```
    Returns:
    
    the clientID
  - setClientID
```
public void setClientID(String clientID)
```
    Parameters:
    
    clientID - the clientID to set
  - getCleanupJournalOnComplete
```
public Boolean getCleanupJournalOnComplete()
```
    Returns:
    
    the cleanupJournalOnComplete
  - setCleanupJournalOnComplete
```
public void setCleanupJournalOnComplete(Boolean cleanupJournalOnComplete)
```
    Parameters:
    
    cleanupJournalOnComplete - the cleanupJournalOnComplete to set
  - getRemoteHost
```
public String getRemoteHost()
```
    Returns:
    
    the remoteHost
  - setRemoteHost
```
public void setRemoteHost(String remoteHost)
```
    Parameters:
    
    remoteHost - the remoteHost to set
  - getRemotePort
```
public Integer getRemotePort()
```
    Returns:
    
    the remotePort
  - setRemotePort
```
public void setRemotePort(Integer remotePort)
```
    Parameters:
    
    remotePort - the remotePort to set
  - getMaxRetryAttempts
```
public Integer getMaxRetryAttempts()
```
    Returns:
    
    the maxRetryAttempts
  - setMaxRetryAttempts
```
public void setMaxRetryAttempts(Integer maxRetryAttempts)
```
    Parameters:
    
    maxRetryAttempts - the maxRetryAttempts to set
  - getUsername
```
public String getUsername()
```
    Returns:
    
    the username
  - setUsername
```
public void setUsername(String username)
```
    Parameters:
    
    username - the username to set
  - getPassword
```
public String getPassword()
```
    Returns:
    
    the password
  - setPassword
```
public void setPassword(String password)
```
    Parameters:
    
    password - the password to set
  - getActive
```
public Boolean getActive()
```
    Returns:
    
    the active
  - setActive
```
public void setActive(Boolean active)
```
    Parameters:
    
    active - the active to set
  - getConnectionTimeout
```
public Integer getConnectionTimeout()
```
    Returns:
    
    the connectionTimeout
  - setConnectionTimeout
```
public void setConnectionTimeout(Integer connectionTimeout)
```
    Parameters:
    
    connectionTimeout - the connectionTimeout to set
  - getDataTimeout
```
public Integer getDataTimeout()
```
    Returns:
    
    the dataTimeout
  - setDataTimeout
```
public void setDataTimeout(Integer dataTimeout)
```
    Parameters:
    
    dataTimeout - the dataTimeout to set
  - getSocketTimeout
```
public Integer getSocketTimeout()
```
    Returns:
    
    the socketTimeout
  - setSocketTimeout
```
public void setSocketTimeout(Integer socketTimeout)
```
    Parameters:
    
    socketTimeout - the socketTimeout to set
  - setSystemKey
```
public void setSystemKey(String systemKey)
```
    Parameters:
    
    systemKey - the systemKey to set
  - getSystemKey
```
public String getSystemKey()
```
    Returns:
    
    the systemKey
  - getIsFTPS
```
public Boolean getIsFTPS()
```
  - setIsFTPS
```
public void setIsFTPS(Boolean isFTPS)
```
  - getFtpsPort
```
public Integer getFtpsPort()
```
  - setFtpsPort
```
public void setFtpsPort(Integer ftpsPort)
```
  - getFtpsProtocol
```
public String getFtpsProtocol()
```
  - setFtpsProtocol
```
public void setFtpsProtocol(String ftpsProtocol)
```
  - getFtpsIsImplicit
```
public Boolean getFtpsIsImplicit()
```
  - setFtpsIsImplicit
```
public void setFtpsIsImplicit(Boolean ftpsIsImplicit)
```
  - getFtpsKeyStoreFilePath
```
public String getFtpsKeyStoreFilePath()
```
  - setFtpsKeyStoreFilePath
```
public void setFtpsKeyStoreFilePath(String ftpsKeyStoreFilePath)
```
  - getFtpsKeyStoreFilePassword
```
public String getFtpsKeyStoreFilePassword()
```
  - setFtpsKeyStoreFilePassword
```
public void setFtpsKeyStoreFilePassword(String ftpsKeyStoreFilePassword)
```
  - getPasswordFilePath
```
public String getPasswordFilePath()
```
    Returns:
    
    the passwordFilePath
  - setPasswordFilePath
```
public void setPasswordFilePath(String passwordFilePath)
```
    Parameters:
    
    passwordFilePath - the passwordFilePath to set

Class FtpConsumerConfiguration

Constructor Summary

Method Summary

Methods inherited from class org.ikasan.component.endpoint.quartz.consumer.ScheduledConsumerConfiguration

Methods inherited from class java.lang.Object

Constructor Detail

FtpConsumerConfiguration

Method Detail

validate

getSourceDirectory

setSourceDirectory

getFilenamePattern

setFilenamePattern

getSourceDirectoryURLFactory

setSourceDirectoryURLFactory

getFilterDuplicates

setFilterDuplicates

getFilterOnFilename

setFilterOnFilename

getFilterOnLastModifiedDate

setFilterOnLastModifiedDate

getRenameOnSuccess

setRenameOnSuccess

getRenameOnSuccessExtension

setRenameOnSuccessExtension

getMoveOnSuccess

setMoveOnSuccess

getMoveOnSuccessNewPath

setMoveOnSuccessNewPath

getChronological

setChronological

getChunking

setChunking

getIsRecursive

setIsRecursive

getChunkSize

setChunkSize

getChecksum

setChecksum

getMinAge

setMinAge

getDestructive

setDestructive

getMaxRows

setMaxRows

getAgeOfFiles

setAgeOfFiles

getClientID

setClientID

getCleanupJournalOnComplete

setCleanupJournalOnComplete

getRemoteHost

setRemoteHost

getRemotePort

setRemotePort

getMaxRetryAttempts

setMaxRetryAttempts

getUsername

setUsername

getPassword

setPassword

getActive

setActive

getConnectionTimeout

setConnectionTimeout

getDataTimeout

setDataTimeout

getSocketTimeout

setSocketTimeout

setSystemKey

getSystemKey

getIsFTPS

setIsFTPS

getFtpsPort

setFtpsPort

getFtpsProtocol

setFtpsProtocol

getFtpsIsImplicit

setFtpsIsImplicit

getFtpsKeyStoreFilePath