Skip to content

Home

Introduction

Development

IDEs

Services

API Explorer

Releases

Release notes

Martini Runtime

Martini Desktop

Martini Online

Feature requests

Bug reports

FTP client endpoint

The FTP client endpoint enables developers to write services that react to changes occurring in a remote FTP/FTPS/SFTP directory. This may be applicable to scenarios where other systems manipulate files in a remote filesystem, which Martini then needs to process.

Properties

General configuration

Property Default Description
Name (required) The name of the endpoint.
Service (required) The service to execute when the endpoint is triggered.
Run As Anonymous The user to run the service in behalf of. This is logged to Tracker.
Document Type <Name of endpoint type> The document type to be used when adding documents to Tracker as this endpoint is triggered.
Auto Start true Whether or not to automatically start the endpoint upon package startup.
Log To Tracker false Flag determining whether executions should be logged to Tracker.

FTP client-specific configuration

Property Default Description
Username (required) The username used to login to the FTP server.
Password (required) The password used to login to the FTP server.
Host (required) The remote host to connect to.
Port (required) The server port.
Polling Interval (required) The interval in seconds, at which Martini checks for changes.
Directory (required) The remote directory to poll for changes.
Protocol (required) The protocol of the remote host. Possible values: FTP, FTPS, SFTP.
Passive false Flag determining whether the login should be in passive mode.
Events Addition The type of events this endpoint should monitor.

Service

When the endpoint is triggered, the following variables are exposed to the configured service:

General parameters

Name Type Description
internalId java.lang.String The Tracker document internal ID. If the endpoint was configured to not track, this value will be null.
$trackerId java.lang.String An alias for the internalId property.
martiniPackage MartiniPackage The Martini package that contains the endpoint.
parameters java.util.Map A map containing all the endpoint specific parameters.
properties java.util.Map A map containing containing all the properties associated with the endpoint.

FTP client-specific parameters

Name Type Description
context org.quartz.JobExecutionContext The Quartz context.
jobDataMap org.quartz.JobDataMap The Quartz job data map.
job org.quartz.Job The Quartz job.
file java.nio.file.Path The file whose change triggered the endpoint.
filename java.lang.String The absolute path of the file.
inputStream java.io.InputStream An open InputStream, pointing to the file. The stream is automatically closed after the service executes.
reader java.io.Reader An open Reader, pointing to the file. The reader is automatically closed after the service executes.
multipartFile org.springframework.web.multipart.MultipartFile A multipart file pointing to the file.
bytes byte[] Contains all file data. This variable is only created if your method has a parameter that matches the name (therefore scripts will never have this variable since they don't declare variables).
content java.lang.String Contains all file data. This variable is only created if your method has a parameter that matches the name (therefore scripts will never have this variable since they don't declare variables).

Examples

Gloop as service

Consider this application using Gloop that sends the file that triggered the endpoint to an remote FTP server:

File-sending service

(1) Retrieves the credentials of the FTP server from the package properties. (5) When the service is executed, this fetches the remote representation of the file matching filename from the input (provided by the endpoint):

File-sending service's inputs

(6) The value of bytes is then written to the remote representation of the file resolved by the previous line.

Want more examples?

The distribution ships with a Martini package called examples, which contains services (including the above example) demonstrating more use cases.

Groovy script as service

Consider this Groovy script that simply prints the available variables in the context:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
[
    'properties',
    'context',
    'jobDataMap',
    'job',
    'file',
    'filename',
    'inputStream',
    'reader',
    'multipartFile',
    'internalId' ].each {

    println "$it\t : " + this[it]
}

When the endpoint is triggered - the console will show logs similar to the following:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
properties   : [ <ommitted> ]
context  : JobExecutionContext: <ommitted>
jobDataMap   : [ <ommitted> ]
job  : io.toro.martini.core.endpoint.impl.vfs.VFSClientJobWrapper@5f10fee7
file     : /tmp/watch-me/whip.whip
filename     : /tmp/watch-me/whip.whip
inputStream  : java.io.FileInputStream@55c780af
reader  : java.io.InputStreamReader@23c45bd
multipartFile    : io.toro.martini.core.util.ESBMockMultipartFile@3a1fa99c
internalId   : null

Groovy method as service

By using a Groovy class method as the service configured to the endpoint, we get access to additional variables content and bytes. Consider the following script:

1
2
3
4
5
6
7
class Reporter {

    def sendFileAsEmailBody( String content ) {
        // smtps format is smtp[s]://<login>:<password>@<smtp-server>[:port]/<Subject>
        'smtps://myEmail:password@server/Daily Report'.send( [to: 'daily-reports@work.com'], content );
    }
}
This is invoked with the content of the file and sends it as an email body to daily-reports@work.com with subject Daily Report.

Use inputStream or file if reading large files

The use of content and bytes is suited only for cases where the expected size of the file is small. Otherwise, reading via the inputStream, or accessing the file directly is recommended.