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
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Operation | Description |
|---|
del
| deletes files or directories on Dropbox | get
| download files from Dropbox | move
| move files from folders on Dropbox | put
| upload files on Dropbox | search
| search files on Dropbox based on string queries |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Operation || Description ||
| {{del}} | deletes files or directories on Dropbox|
| {{get}} | download files from Dropbox |
| {{move}} | move files from folders on Dropbox |
| {{put}} | upload files on Dropbox |
| {{search}} | search files on Dropbox based on string queries |
{div} |
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 |
|
| Wiki Markup |
|---|
| {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.
...
Below are listed the options for this operation:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Property | Mandatory | Description |
|---|
remotePath
| true
| Folder or file to delete on Dropbox |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Property || Mandatory || Description ||
| {{remotePath}} | {{true}} | Folder or file to delete on Dropbox |
{div} |
Samples
from("direct:start").to("dropbox://del?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1").to("mock:result");
...
The following headers are set on message result:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Property | Value |
|---|
DELETED_PATH
| name of the path deleted on dropbox |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Property || Value ||
| {{DELETED_PATH}} | name of the path deleted on dropbox |
{div} |
Result Message Body
The following objects are set on message body result:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Object type | Description |
|---|
String
| name of the path deleted on dropbox |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Object type || Description ||
| {{String}} | name of the path deleted on dropbox |
{div} |
Get (download) operation
Download files from Dropbox.
...
Below are listed the options for this operation:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Property | Mandatory | Description |
|---|
remotePath
| true
| Folder or file to download from Dropbox |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Property || Mandatory || Description ||
| {{remotePath}} | {{true}} | Folder or file to download from Dropbox |
{div} |
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");
...
The following headers are set on message result:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Property | Value |
|---|
DOWNLOADED_FILE
| in case of single file download, path of the remote file downloaded | DOWNLOADED_FILES
| in case of multiple files download, path of the remote files downloaded |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Property || Value ||
| {{DOWNLOADED_FILE}} | in case of single file download, path of the remote file downloaded |
| {{DOWNLOADED_FILES}} | in case of multiple files download, path of the remote files downloaded |
{div} |
Result Message Body
The following objects are set on message body result:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Object type | Description |
|---|
ByteArrayOutputStream
| in case of single file download, stream representing the file downloaded | Map<String, ByteArrayOutputStream>
| in case of multiple files download, a map with as key the path of the remote file downloaded and as value the stream representing the file downloaded |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Object type || Description ||
| {{ByteArrayOutputStream}} | in case of single file download, stream representing the file downloaded |
| {{Map<String, ByteArrayOutputStream>}} | in case of multiple files download, a map with as key the path of the remote file downloaded and as value the stream representing the file downloaded |
{div} |
Move operation
Move files on Dropbox between one folder to another.
...
Below are listed the options for this operation:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Property | Mandatory | Description |
|---|
remotePath
| true
| Original file or folder to move | newRemotePath
| true
| Destination file or folder |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Property || Mandatory || Description ||
| {{remotePath}} | {{true}} | Original file or folder to move |
| {{newRemotePath}} | {{true}} | Destination file or folder |
{div} |
Samples
from("direct:start").to("dropbox://move?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1&newRemotePath=/root/folder2").to("mock:result");
...
The following headers are set on message result:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Property | Value |
|---|
MOVED_PATH
| name of the path moved on dropbox |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Property || Value ||
| {{MOVED_PATH}} | name of the path moved on dropbox |
{div} |
Result Message Body
The following objects are set on message body result:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Object type | Description |
|---|
String
| name of the path moved on dropbox |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Object type || Description ||
| {{String}} | name of the path moved on dropbox |
{div} |
Put (upload) operation
Upload files on Dropbox.
...
Below are listed the options for this operation:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Property | Mandatory | Description |
|---|
uploadMode
| true
| add or force this option specifies how a file should be saved on dropbox:
in case of "add" the new file will be renamed if a file with the same name already exists on dropbox.
in case of "force" if a file with the same name already exists on dropbox, this will be overwritten. | localPath
| true
| Folder or file to upload on Dropbox from the local filesystem . | remotePath
| false
| Folder destination on Dropbox. If the property is not set, the component will upload the file on a remote path equal to the local path. Note: You can only omit remotePath if you are under Linux/Unix and only is localPath is absolute. With Windows or without an absolute
localPath you may run into an exception like the following: "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"" |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Property || Mandatory || Description ||
| {{uploadMode}} | {{true}} | add or force this option specifies how a file should be saved on dropbox:
in case of "add" the new file will be renamed if a file with the same name already exists on dropbox.
in case of "force" if a file with the same name already exists on dropbox, this will be overwritten.
| {{localPath}} | {{true}} | Folder or file to upload on Dropbox from the local filesystem .|
| {{remotePath}} | {{false}} | Folder destination on Dropbox. If the property is not set, the component will upload the file on a remote path equal to the local path. |
{div} |
Samples
from("direct:start").to("dropbox://put?accessToken=XXX&clientIdentifier=XXX&uploadMode=add&localPath=/root/folder1").to("mock:result");
...
The following headers are set on message result:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Property | Value |
|---|
UPLOADED_FILE
| in case of single file upload, path of the remote path uploaded | UPLOADED_FILES
| in case of multiple files upload, string with the remote paths uploaded |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Property || Value ||
| {{UPLOADED_FILE}} | in case of single file upload, path of the remote path uploaded |
| {{UPLOADED_FILES}} | in case of multiple files upload, string with the remote paths uploaded |
{div} |
Result Message Body
The following objects are set on message body result:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Object type | Description |
|---|
String
| in case of single file upload, result of the upload operation, OK or KO | Map<String, DropboxResultCode>
| in case of multiple files upload, a map with as key the path of the remote file uploaded and as value the result of the upload operation, OK or KO |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Object type || Description ||
| {{String}} | in case of single file upload, result of the upload operation, OK or KO |
| {{Map<String, DropboxResultCode>}} | in case of multiple files upload, a map with as key the path of the remote file uploaded and as value the result of the upload operation, OK or KO |
{div} |
Search operation
Search inside a remote Dropbox folder including its sub directories.
...
Below are listed the options for this operation:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Property | Mandatory | Description |
|---|
remotePath
| true
| Folder on Dropbox where to search in. | query
| false
| A space-separated list of substrings to search for. A file matches only if it contains all the substrings. If this option is not set, all files will be matched. |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Property || Mandatory || Description ||
| {{remotePath}} | {{true}} | Folder on Dropbox where to search in. |
| {{query}} | {{false}} | A space-separated list of substrings to search for. A file matches only if it contains all the substrings. If this option is not set, all files will be matched. |
{div} |
Samples
from("dropbox://search?accessToken=XXX&clientIdentifier=XXX&remotePath=/XXX&query=XXX").to("mock:result");
...
The following headers are set on message result:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
Property | Value |
|---|
FOUNDED_FILES
| list of file path founded |
|
| Wiki Markup |
|---|
| {div:class=confluenceTableSmall}
|| Property || Value ||
| {{FOUNDED_FILES}} | list of file path founded |
{div} |
Result Message Body
The following objects are set on message body result:
| Div |
|---|
| class | confluenceTableSmall |
|---|
|
| Wiki Markup |
|---|
{div:class=confluenceTableSmall}
|| Object type || Description ||
| {{List<DbxEntry>}} | list of file path founded. For more information on this object refer to Dropbox documentation, Object type | Description |
|---|
List<DbxEntry>
| list of file path founded. For more information on this object refer to Dropbox documentation, |
|
