--- apiVersion: v1 kind: List items: - apiVersion: v1 kind: ConfigMap metadata: labels: funktion.fabric8.io/kind: Connector provider: fabric8 project: connector-dropbox version: 1.1.23 group: io.fabric8.funktion.connector name: dropbox data: deployment.yml: | --- apiVersion: extensions/v1beta1 kind: Deployment metadata: labels: funktion.fabric8.io/kind: Subscription connector: dropbox spec: replicas: 1 template: metadata: labels: funktion.fabric8.io/kind: Subscription connector: dropbox spec: containers: - image: fabric8/connector-dropbox:1.1.23 name: connector schema.yml: | --- component: kind: component scheme: dropbox syntax: dropbox:operation title: Dropbox description: For uploading downloading and managing files folders groups collaborations etc on dropbox DOT com. label: api,file deprecated: false async: false javaType: org.apache.camel.component.dropbox.DropboxComponent groupId: org.apache.camel artifactId: camel-dropbox version: 2.18.1 componentProperties: {} properties: operation: kind: path group: common required: true type: string javaType: org.apache.camel.component.dropbox.util.DropboxOperation enum: - put - del - search - get - move deprecated: false secret: false description: The specific action (typically is a CRUD action) to perform on Dropbox remote folder. accessToken: kind: parameter group: common required: true type: string javaType: java.lang.String deprecated: false secret: false description: The access token to make API requests for a specific Dropbox user client: kind: parameter group: common type: object javaType: com.dropbox.core.DbxClient deprecated: false secret: false description: To use an existing DbxClient instance as DropBox client. clientIdentifier: kind: parameter group: common required: true type: string javaType: java.lang.String deprecated: false secret: false description: Name of the app registered to make API requests localPath: kind: parameter group: common type: string javaType: java.lang.String deprecated: false secret: false description: Folder or file to upload on Dropbox from the local filesystem. newRemotePath: kind: parameter group: common type: string javaType: java.lang.String deprecated: false secret: false description: Destination file or folder query: kind: parameter group: common type: string javaType: java.lang.String deprecated: false secret: false description: A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set all files will be matched. remotePath: kind: parameter group: common type: string javaType: java.lang.String deprecated: false secret: false description: Original file or folder to move uploadMode: kind: parameter group: common type: string javaType: org.apache.camel.component.dropbox.util.DropboxUploadMode enum: - add - force deprecated: false secret: false description: Which mode to upload. 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. bridgeErrorHandler: kind: parameter group: consumer label: consumer type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: false description: Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. exceptionHandler: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.spi.ExceptionHandler optionalPrefix: consumer. deprecated: false secret: false description: To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. exchangePattern: kind: parameter group: consumer (advanced) label: consumer,advanced type: string javaType: org.apache.camel.ExchangePattern enum: - InOnly - RobustInOnly - InOut - InOptionalOut - OutOnly - RobustOutOnly - OutIn - OutOptionalIn deprecated: false secret: false description: Sets the exchange pattern when the consumer creates an exchange. synchronous: kind: parameter group: advanced label: advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). documentation.adoc: | [[Dropbox-CamelDropboxcomponent]] Camel Dropbox component ~~~~~~~~~~~~~~~~~~~~~~~ *Available as of Camel 2.14* The *dropbox:* component allows you to treat https://www.dropbox.com[Dropbox]??remote folders as a producer or consumer of messages. Using the http://dropbox.github.io/dropbox-sdk-java/api-docs/v1.7.x/[Dropbox Java Core API] (reference version for this component is 1.7.x), this camel component has the following features: * As a consumer, download files and search files by queries * As a producer, download files, move files between remote directories, delete files/dir, upload files??and search files by queries Maven users will need to add the following dependency to their `pom.xml` for this component: [source,xml] ------------------------------------------------------------ org.apache.camel camel-dropbox x.x.x ------------------------------------------------------------ [[Dropbox-URIformat]] URI format ^^^^^^^^^^ [source,java] ------------------------------- dropbox://[operation]?[options] ------------------------------- Where *operation* is the specific action (typically is a CRUD action) to perform on Dropbox remote folder. [[Dropbox-Operations]] Operations ^^^^^^^^^^ [width="100%",cols="40%,60%",options="header",] |======================================================================= |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 |======================================================================= *Operations* require additional options to work, some are mandatory for the specific operation. [[Dropbox-Options]] Options ^^^^^^^ In order to work with Dropbox API you need to obtain an??*accessToken* and a *clientIdentifier.* + You can refer to the https://www.dropbox.com/developers/core/start/java[Dropbox documentation] that explains how to get them.???? // component options: START The Dropbox component has no options. // component options: END // endpoint options: START The Dropbox component supports 13 endpoint options which are listed below: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description | operation | common | | DropboxOperation | *Required* The specific action (typically is a CRUD action) to perform on Dropbox remote folder. | accessToken | common | | String | *Required* The access token to make API requests for a specific Dropbox user | client | common | | DbxClient | To use an existing DbxClient instance as DropBox client. | clientIdentifier | common | | String | *Required* Name of the app registered to make API requests | localPath | common | | String | Folder or file to upload on Dropbox from the local filesystem. | newRemotePath | common | | String | Destination file or folder | query | common | | String | A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set all files will be matched. | remotePath | common | | String | Original file or folder to move | uploadMode | common | | DropboxUploadMode | Which mode to upload. 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. | bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= {% endraw %} // endpoint options: END [[Dropbox-Deloperation]] Del operation ^^^^^^^^^^^^^ Delete files on Dropbox. Works only as Camel producer. Below are listed the options for this operation: [width="100%",cols="20%,20%,60%",options="header",] |======================================================================= |Property |Mandatory |Description |`remotePath` |`true` |Folder or file to delete on Dropbox |======================================================================= [[Dropbox-Samples]] Samples +++++++ [source,java] ------------------------------- 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"); ------------------------------- [[Dropbox-ResultMessageHeaders]] Result Message Headers ++++++++++++++++++++++ The following headers are set on message result: [width="100%",cols="50%,50%",options="header",] |======================================================================= |Property |Value |`DELETED_PATH` |name of the path deleted on dropbox |======================================================================= [[Dropbox-ResultMessageBody]] Result Message Body +++++++++++++++++++ The following objects are set on message body result: [width="100%",cols="50%,50%",options="header",] |======================================================================= |Object type |Description |`String` |name of the path deleted on dropbox |======================================================================= [[Dropbox-Getoperation]] Get (download) operation ^^^^^^^^^^^^^^^^^^^^^^^^ Download files from Dropbox. Works as Camel producer or Camel consumer. Below are listed the options for this operation: [width="100%",cols="20%,20%,60%",options="header",] |======================================================================= |Property |Mandatory |Description |`remotePath` |`true` |Folder or file to download from Dropbox |======================================================================= [[Dropbox-Samples.1]] Samples +++++++ [source,java] ------------------------------- 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/"); ------------------------------- [[Dropbox-ResultMessageHeaders.1]] Result Message Headers ++++++++++++++++++++++ The following headers are set on message result: [width="100%",cols="50%,50%",options="header",] |======================================================================= |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 |======================================================================= [[Dropbox-ResultMessageBody.1]] Result Message Body +++++++++++++++++++ The following objects are set on message body result: [width="100%",cols="50%,50%",options="header",] |======================================================================= |Object type |Description |`ByteArrayOutputStream` |in case of single file download, stream representing the file downloaded |`Map` |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 |======================================================================= [[Dropbox-Moveoperation]] Move operation ^^^^^^^^^^^^^^ Move files on Dropbox between one folder to another. Works only as Camel producer. Below are listed the options for this operation: [width="100%",cols="20%,20%,60%",options="header",] |======================================================================= |Property |Mandatory |Description |`remotePath` |`true` |Original file or folder to move |`newRemotePath` |`true` |Destination file or folder |======================================================================= [[Dropbox-Samples.2]] Samples +++++++ [source,java] ------------------------------- from("direct:start").to("dropbox://move?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1&newRemotePath=/root/folder2").to("mock:result"); ------------------------------- [[Dropbox-ResultMessageHeaders.2]] Result Message Headers ++++++++++++++++++++++ The following headers are set on message result: [width="100%",cols="50%,50%",options="header",] |======================================================================= |Property |Value |`MOVED_PATH` |name of the path moved on dropbox |======================================================================= [[Dropbox-ResultMessageBody.2]] Result Message Body +++++++++++++++++++ The following objects are set on message body result: [width="100%",cols="50%,50%",options="header",] |======================================================================= |Object type |Description |`String` |name of the path moved on dropbox |======================================================================= [[Dropbox-Putoperation]] Put (upload) operation ^^^^^^^^^^^^^^^^^^^^^^ Upload files on Dropbox. Works as Camel producer. Below are listed the options for this operation: [width="100%",cols="20%,20%,60%",options="header",] |======================================================================= |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. |======================================================================= [[Dropbox-Samples.3]] Samples +++++++ [source,java] ------------------------------- 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"); ------------------------------- [[Dropbox-ResultMessageHeaders.3]] Result Message Headers ++++++++++++++++++++++ The following headers are set on message result: [width="100%",cols="50%,50%",options="header",] |======================================================================= |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 |======================================================================= [[Dropbox-ResultMessageBody.3]] Result Message Body +++++++++++++++++++ The following objects are set on message body result: [width="100%",cols="50%,50%",options="header",] |======================================================================= |Object type |Description |`String` |in case of single file upload, result of the upload operation, OK or KO |`Map` |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 |======================================================================= [[Dropbox-Searchoperation]] 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: [width="100%",cols="20%,20%,60%",options="header",] |======================================================================= |Property |Mandatory |Description |`remotePath` |`true` |Folder on Dropbox where to search in. |`query` |`false` |A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set, all files will be matched. |======================================================================= [[Dropbox-Samples.4]] Samples +++++++ [source,java] ------------------------------- 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"); ------------------------------- [[Dropbox-ResultMessageHeaders.4]] Result Message Headers ++++++++++++++++++++++ The following headers are set on message result: [width="100%",cols="50%,50%",options="header",] |======================================================================= |Property |Value |`FOUNDED_FILES` |list of file path founded |======================================================================= [[Dropbox-ResultMessageBody.4]] Result Message Body +++++++++++++++++++ The following objects are set on message body result: [width="100%",cols="50%,50%",options="header",] |======================================================================= |Object type |Description |`List` |list of file path founded. For more information on this object refer to Dropbox documentation, |======================================================================= link:http://dropbox.github.io/dropbox-sdk-java/api-docs/v1.7.x/com/dropbox/core/DbxEntry.html[http://dropbox.github.io/dropbox-sdk-java/api-docs/v1.7.x/com/dropbox/core/DbxEntry.html] ??