generated from camel.apache.org/component
Update wiki Home page for box
parent
9b6877dd01
commit
ca26a6d9dc
55
Home.md
55
Home.md
@ -1,21 +1,48 @@
|
||||
# Deploy the Project on CamelX Platform
|
||||
# Box
|
||||
|
||||
Deploy on CamelX Platform in three steps
|
||||
Upload, download and manage files, folders, groups, collaborations, etc. on box.com.
|
||||
|
||||
## Step 1: Create a release
|
||||
From the project space, click on **"Create a release"**
|
||||
## Metadata
|
||||
|
||||
The new version is automatically available in the list
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Scheme | `box` |
|
||||
| Support Level | Stable |
|
||||
| Labels | cloud,file,api |
|
||||
| Version | 4.10.2 |
|
||||
|
||||
## Step 2: Deploy
|
||||
Click on **"Deploy"**
|
||||
## Maven Dependency
|
||||
|
||||
- **Version:** Select the desired release
|
||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
||||
- **Configuration:** Select the configuration source
|
||||
- **Resources:** Set CPU and Memory
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>org.apache.camel</groupId>
|
||||
<artifactId>camel-box</artifactId>
|
||||
<version>4.10.2</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
## Step 3: Expose
|
||||
Enable **"Expose"**
|
||||
## Endpoint Properties
|
||||
|
||||
Choose an **API Gateway** (Internal, Public, etc.)
|
||||
| Name | Type | Required | Default | Description |
|
||||
|------|------|----------|---------|-------------|
|
||||
| `apiName` | object | ✓ | | What kind of operation to perform |
|
||||
| `methodName` | string | ✓ | | What sub operation to use for the selected operation |
|
||||
| `clientId` | string | | | Box application client ID |
|
||||
| `enterpriseId` | string | | | The enterprise ID to use for an App Enterprise. |
|
||||
| `inBody` | string | | | Sets the name of a parameter to be passed in the exchange In Body |
|
||||
| `userId` | string | | | The user ID to use for an App User. |
|
||||
| `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. |
|
||||
| `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. |
|
||||
| `httpParams` | object | | | Custom HTTP params for settings like proxy host |
|
||||
| `authenticationType` | string | | `APP_USER_AUTHENTICATION` | The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens |
|
||||
| `accessTokenCache` | object | | | Custom Access Token Cache for storing and retrieving access tokens. |
|
||||
| `clientSecret` | string | | | Box application client secret |
|
||||
| `encryptionAlgorithm` | object | | `RSA_SHA_256` | The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 |
|
||||
| `maxCacheEntries` | integer | | `100` | The maximum number of access tokens in cache. |
|
||||
| `privateKeyFile` | string | | | The private key for generating the JWT signature. |
|
||||
| `privateKeyPassword` | string | | | The password for the private key. |
|
||||
| `publicKeyId` | string | | | The ID for public key for validating the JWT signature. |
|
||||
| `sslContextParameters` | object | | | To configure security using SSLContextParameters. |
|
||||
| `userName` | string | | | Box user name, MUST be provided |
|
||||
| `userPassword` | string | | | Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user