Skip to content

Overview

Concepts and Principles

Development

Overview

IDEs

API Explorer

Releases

Release Notes

TORO Integrate

Coder Studio

Coder Cloud

Bug Reports

Search

Directory Watcher Endpoint

The Directory Watcher Endpoint enables developers to write integrations that react to changes occurring in a monitored directory in the server's local file system. This may be applicable to scenarios where other components write files which TORO Integrate needs to process.

Properties

Property Default Description
Directory (required) The directory to be monitored for changes
Service (required) The service to execute when the endpoint is triggered
Events (required) The type of events this endpoint should monitor. Options are: 'Addition', 'Modification', 'Deletion'
Recursive false Flag determining whether subdirectories are monitored for changes
Run As 'Anonymous' The user to run the service in behalf of. This is logged to tracker
Log To Tracker false Flag determining whether executions should be logged to the tracker
Document Type 'Directory Watcher' The document type to be registered to the tracker when this endpoint is triggered

Service

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

Name Type Description
parameters java.util.Map Contains all the variables below
esbPackage ESBPackage The Integrate Package that contains this endpoint
properties java.util.Map Contains all the properties associated with the endpoint
fileAction io.toro.integrate.core.event.FileEvent.Action The action that triggered this endpoint. Expected values are: ADDED, MODIFIED, DELETED
action java.lang.String String version of the fileAction
file java.io.File 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)
internalId java.lang.String Tracker internal ID. If the endpoint was configured to not track, this value will be null

Examples

Gloop as a Service

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

File-sending service

(1) Takes 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.

More Gloop

The distribution ships with an Integrate Package called examples, which contains services (including the above example) demonstrating more use cases.

Groovy Script as a 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
[ 
    'properties', 
    'fileAction',
    'action', 
    'file', 
    'filename', 
    'inputStream', 
    'reader',
    'multipartFile',
    'internalId' ].each {

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

When the endpoint is triggered - in this case, the file naenae.dance being added to /tmp/watch-me/ - the console prints accordingly:

1
2
3
4
5
6
7
8
9
properties   : [runAs:, documentType:Directory Watcher, track:false, directory:/tmp/watch-me, events:onAdd,onDelete,onModify, recursive:false]
fileAction  : ADDED
action   : ADDED
file     : /tmp/watch-me/naenae.dance
filename     : /tmp/watch-me/naenae.dance
inputStream  : java.io.FileInputStream@4b5fa778
reader  : java.io.InputStreamReader@5cffa221
multipartFile    : io.toro.integrate.core.util.ESBMockMultipartFile@30b7ae2b
internalId   : null

In combination with the Groovy extension modules, we can write scripts that address more advance use cases, such as:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
// get a groovy.sql.SQL object that points to the connection pool called 'customers'
int count = 0
'customers'.sql() {  sql ->
    def query = 'insert into my_customers ( id, first_name,  last_name, address1, address2, city, state, postcode ) values ( ?, ?, ?, ?, ?, ?, ?, ? )'
    sql.withBatch(1000, query) { ps ->
        // iterate over the csv file, skipping the first row
        file.eachRecord(1) { it ->
            ps.addBatch(it[0], it[1], it[2], it[3], it[4], it[5], it[6], it[7])
            count++
            if (count % 1000 == 0) println "processed ${count}"
        }
    }
}

This script iterates a comma-separated value (CSV) file and batch inserts the data in the database customers.

Groovy Method as a 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 loads up the content of the file and sends it as an email body to daily-reports@work.com.

Warning

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.