generated from camel.apache.org/component
Update wiki Home page for dropbox
parent
fa55feddbd
commit
db910ee29f
51
Home.md
51
Home.md
@ -1,21 +1,44 @@
|
|||||||
# Deploy the Project on CamelX Platform
|
# Dropbox
|
||||||
|
|
||||||
Deploy on CamelX Platform in three steps
|
Upload, download and manage files, folders, groups, collaborations, etc on Dropbox.
|
||||||
|
|
||||||
## Step 1: Create a release
|
## Metadata
|
||||||
From the project space, click on **"Create a release"**
|
|
||||||
|
|
||||||
The new version is automatically available in the list
|
| Property | Value |
|
||||||
|
|----------|-------|
|
||||||
|
| Scheme | `dropbox` |
|
||||||
|
| Support Level | Stable |
|
||||||
|
| Labels | cloud,file,api |
|
||||||
|
| Version | 4.10.2 |
|
||||||
|
|
||||||
## Step 2: Deploy
|
## Maven Dependency
|
||||||
Click on **"Deploy"**
|
|
||||||
|
|
||||||
- **Version:** Select the desired release
|
```xml
|
||||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
<dependency>
|
||||||
- **Configuration:** Select the configuration source
|
<groupId>org.apache.camel</groupId>
|
||||||
- **Resources:** Set CPU and Memory
|
<artifactId>camel-dropbox</artifactId>
|
||||||
|
<version>4.10.2</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
## Step 3: Expose
|
## Endpoint Properties
|
||||||
Enable **"Expose"**
|
|
||||||
|
|
||||||
Choose an **API Gateway** (Internal, Public, etc.)
|
| Name | Type | Required | Default | Description |
|
||||||
|
|------|------|----------|---------|-------------|
|
||||||
|
| `operation` | object | ✓ | | The specific action (typically is a CRUD action) to perform on Dropbox remote folder. |
|
||||||
|
| `clientIdentifier` | string | | | Name of the app registered to make API requests |
|
||||||
|
| `query` | 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` | string | | | Original file or folder to move |
|
||||||
|
| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
|
||||||
|
| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
|
||||||
|
| `exchangePattern` | object | | | Sets the exchange pattern when the consumer creates an exchange. |
|
||||||
|
| `localPath` | string | | | Optional folder or file to upload on Dropbox from the local filesystem. If this option has not been configured then the message body is used as the content to upload. |
|
||||||
|
| `newRemotePath` | string | | | Destination file or folder |
|
||||||
|
| `uploadMode` | object | | | 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. |
|
||||||
|
| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
|
||||||
|
| `client` | object | | | To use an existing DbxClient instance as Dropbox client. |
|
||||||
|
| `accessToken` | string | ✓ | | The access token to make API requests for a specific Dropbox user |
|
||||||
|
| `apiKey` | string | ✓ | | The apiKey to make API requests for a specific Dropbox user |
|
||||||
|
| `apiSecret` | string | ✓ | | The apiSecret to make API requests for a specific Dropbox user |
|
||||||
|
| `expireIn` | integer | ✓ | | The expire time to access token for a specific Dropbox user |
|
||||||
|
| `refreshToken` | string | ✓ | | The refresh token to refresh the access token for a specific Dropbox user |
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user