Summer.Batch.Extra.FtpSupport.FtpGetTasklet Class Reference

Custom tasklet to do some ftp get NOTE : For now, sftp is UNsupported More...

Inheritance diagram for Summer.Batch.Extra.FtpSupport.FtpGetTasklet:
Summer.Batch.Core.Step.Tasklet.ITasklet Summer.Batch.Common.Factory.IInitializationPostOperations

Public Member Functions

RepeatStatus Execute (StepContribution contribution, ChunkContext chunkContext)
 Scan remote directory for files matching the given file name pattern and download them, if any, to the given local directory. More...
 
bool DoExecute ()
 Delegated. Simplifies unit testing. More...
 
void AfterPropertiesSet ()
 

Properties

string Host [get, set]
 Ftp server host property. More...
 
string Port [get, set]
 Ftp server port property. More...
 
string Username [get, set]
 Ftp server user property. More...
 
string Password [get, set]
 Ftp server password property. More...
 
string LocalDirectory [get, set]
 Ftp local directory property. More...
 
string FileNamePattern [get, set]
 File name pattern property (used for filtering). More...
 
string RemoteDirectory [get, set]
 Ftp remote directory property. More...
 
int DownloadFileAttempts [get, set]
 maximum download file attempts property. More...
 
bool AutoCreateLocalDirectory [get, set]
 Whether to create local directory automatically if required or not. More...
 
bool DeleteLocalFiles [get, set]
 Whether to delete local files automatically or not. More...
 
long RetryIntervalMilliseconds [get, set]
 Time in ms to wait for a retry. More...
 
bool RetryIfNotFound [get, set]
 Whether to retry if a file has not been found or not. More...
 

Detailed Description

Custom tasklet to do some ftp get NOTE : For now, sftp is UNsupported

Member Function Documentation

void Summer.Batch.Extra.FtpSupport.FtpGetTasklet.AfterPropertiesSet ( )

See also
IInitializationPostOperations::AfterPropertiesSet

Implements Summer.Batch.Common.Factory.IInitializationPostOperations.

bool Summer.Batch.Extra.FtpSupport.FtpGetTasklet.DoExecute ( )

Delegated. Simplifies unit testing.

Exceptions
Exception 
RepeatStatus Summer.Batch.Extra.FtpSupport.FtpGetTasklet.Execute ( StepContribution  contribution,
ChunkContext  chunkContext 
)

Scan remote directory for files matching the given file name pattern and download them, if any, to the given local directory.

See also
ITasklet::Execute
Parameters
contribution
chunkContext
Returns

Implements Summer.Batch.Core.Step.Tasklet.ITasklet.

Property Documentation

bool Summer.Batch.Extra.FtpSupport.FtpGetTasklet.AutoCreateLocalDirectory
getset

Whether to create local directory automatically if required or not.

bool Summer.Batch.Extra.FtpSupport.FtpGetTasklet.DeleteLocalFiles
getset

Whether to delete local files automatically or not.

int Summer.Batch.Extra.FtpSupport.FtpGetTasklet.DownloadFileAttempts
getset

maximum download file attempts property.

string Summer.Batch.Extra.FtpSupport.FtpGetTasklet.FileNamePattern
getset

File name pattern property (used for filtering).

string Summer.Batch.Extra.FtpSupport.FtpGetTasklet.Host
getset

Ftp server host property.

string Summer.Batch.Extra.FtpSupport.FtpGetTasklet.LocalDirectory
getset

Ftp local directory property.

string Summer.Batch.Extra.FtpSupport.FtpGetTasklet.Password
getset

Ftp server password property.

string Summer.Batch.Extra.FtpSupport.FtpGetTasklet.Port
getset

Ftp server port property.

string Summer.Batch.Extra.FtpSupport.FtpGetTasklet.RemoteDirectory
getset

Ftp remote directory property.

bool Summer.Batch.Extra.FtpSupport.FtpGetTasklet.RetryIfNotFound
getset

Whether to retry if a file has not been found or not.

long Summer.Batch.Extra.FtpSupport.FtpGetTasklet.RetryIntervalMilliseconds
getset

Time in ms to wait for a retry.

string Summer.Batch.Extra.FtpSupport.FtpGetTasklet.Username
getset

Ftp server user property.


The documentation for this class was generated from the following file:
  • Summer.Batch.Extra/FtpSupport/FtpGetTasklet.cs