Page History

Camel Dropbox component

Available as of Camel x2.xx14

The dropbox: component allows you to treat Dropbox remote folders as a producer or consumer of messages. Using the Dropbox Java Core API (reference version for this component is 1.7.x), this camel component has the following features:

...

Where operation is the specific action (typically is a CRUD action) to perform on Dropbox remote folder.

Operation 

Operations

Operations require additional options to work, some are mandatory for the specific operation.

...

In order to work with Dropbox API you need to obtain an accessToken and a clientIdentifier.
You can refer to the Dropbox documentation that expalins how to get them them.  

Below are listed the mandatory options for all operations:

{div:class=confluenceTableSmall}
|| Property || Mandatory || Description ||
| {{accessToken}} | {{true}} | The access token to make API requests for a specific Dropbox user |
| {{clientIdentifier}} | {{true}} | Name of the app registered to make API requests |
{div}

Del operation

Delete files on Dropbox.

Works only as Camel producer.

Below are listed the options for this operation:

Samples

from("direct:start").to("dropbox://del?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1").to("mock:result");

from("direct:start").to("dropbox://del?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1/file1.tar.gz").to("mock:result");

Result Message Headers

The following headers are set on exchanges during message transport.

{div:class=confluenceTableSmall}
|| Property || Value ||
| {{CouchDbDatabase}} | the database the message came from |
| {{CouchDbSeq}} | the couchdb changeset sequence number of the update / delete message |
| {{CouchDbId}} | the couchdb document id |
| {{CouchDbRev}} | the couchdb document revision |
| {{CouchDbMethod}} | the method (delete / update) |
{div}

Headers are set by the consumer once the message is received. The producer will also set the headers for downstream processors once the insert/update has taken place. Any headers set prior to the producer are ignored. That means for example, if you set CouchDbId as a header, it will not be used as the id for insertion, the id of the document will still be used.

Message Body

The component will use the message body as the document to be inserted. If the body is an instance of String, then it will be marshalled into a GSON object before insert. This means that the string must be valid JSON or the insert / update will fail. If the body is an instance of a com.google.gson.JsonElement then it will be inserted as is. Otherwise the producer will throw an exception of unsupported body type.

Samples

For example if you wish to consume all inserts, updates and deletes from a CouchDB instance running locally, on port 9999 then you could use the following:

from("couchdb:http://localhost:9999").process(someProcessor);

If you were only interested in deletes, then you could use the following

from("couchdb:http://localhost:9999?updates=false").process(someProcessor);

If you wanted to insert a message as a document, then the body of the exchange is used

result:

Result Message Body

The following objects are set on message body result:

Get (download) operation

Download files from Dropbox.

Works as Camel producer or Camel consumer.

Below are listed the options for this operation:

Samples

from("direct:start").to("dropbox://get?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1/file1.tar.gz").to("file:///home/kermit/?fileName=file1.tar.gz");

from("direct:start").to("dropbox://get?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1").to("mock:result");

from("dropbox://get?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1").to("file:///home/kermit/");

Result Message Headers

The following headers are set on message result:

Result Message Body

The following objects are set on message body result:

Move operation

Move files on Dropbox between one folder to another.

Works only as Camel producer.

Below are listed the options for this operation:

Samples

from("direct:start").to("dropbox://move?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1&newRemotePath=/root/folder2").to("mock:result");

Result Message Headers

The following headers are set on message result:

Result Message Body

The following objects are set on message body result:

Put (upload) operation

Upload files on Dropbox.

Works as Camel producer.

Below are listed the options for this operation:

"Caused by: java.lang.IllegalArgumentException: 'path': bad path: must start with "/": "C:/My/File" 
OR  

"Caused by: java.lang.IllegalArgumentException: 'path': bad path: must start with "/": "MyFile""

Samples

from("direct:start").to("dropbox://put?accessToken=XXX&clientIdentifier=XXX&uploadMode=add&localPath=/root/folder1").to("mock:result");

from("direct:start").to("dropbox://put?accessToken=XXX&clientIdentifier=XXX&uploadMode=add&localPath=/root/folder1&remotePath=/root/folder2").to("mock:result");

Result Message Headers

The following headers are set on message result:

Result Message Body

The following objects are set on message body result:

Search operation

Search inside a remote Dropbox folder including its sub directories.

Works as Camel producer and as Camel consumer.

Below are listed the options for this operation:

Samples

from("dropbox://search?accessToken=XXX&clientIdentifier=XXX&remotePath=/XXX&query=XXX").to("mock:result");

from("direct:start").to("dropbox://search?accessToken=XXX&clientIdentifier=XXX&remotePath=/XXX").to("mock:result");

Result Message Headers

The following headers are set on message result:

Result Message Body

The following objects are set on message body result: