For uploading, downloading and managing files, folders, groups, collaborations, etc on box DOT com.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| apiName | path | common | true | org.apache.camel.component.box.internal.BoxApiName | COLLABORATIONS COMMENTS EVENTS FILES FOLDERS GROUPS POLL_EVENTS SEARCH SHARED_COMMENTS SHARED_FILES SHARED_FOLDERS SHARED_ITEMS USERS |
What kind of operation to perform | |
| methodName | path | common | true | java.lang.String | What sub operation to use for the selected operation | ||
| clientId | parameter | common | java.lang.String | Box application client ID | |||
| inBody | parameter | common | java.lang.String | Sets the name of a parameter to be passed in the exchange In Body | |||
| loginTimeout | parameter | common | 30 | int | Amount of time the component will wait for a response from Box.com, default is 30 seconds | ||
| revokeOnShutdown | parameter | common | boolean | Flag to revoke OAuth refresh token on route shutdown, default false. Will require a fresh refresh token on restart using either a custom IAuthSecureStorage or automatic component login by providing a user password | |||
| sharedLink | parameter | common | java.lang.String | Box shared link for shared endpoints, can be a link for a shared comment, file or folder | |||
| sharedPassword | parameter | common | java.lang.String | Password associated with the shared link, MUST be provided with sharedLink | |||
| bridgeErrorHandler | parameter | consumer | 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 | parameter | consumer (advanced) | org.apache.camel.spi.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 | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| boxConfig | parameter | advanced | com.box.boxjavalibv2.IBoxConfig | Custom Box SDK configuration, not required normally | |||
| connectionManagerBuilder | parameter | advanced | com.box.boxjavalibv2.BoxConnectionManagerBuilder | Custom Box connection manager builder, used to override default settings like max connections for underlying HttpClient. | |||
| httpParams | parameter | advanced | java.util.Map |
Custom HTTP params for settings like proxy host | |||
| refreshListener | parameter | advanced | com.box.boxjavalibv2.authorization.OAuthRefreshListener | OAuth listener for token updates, if the Camel application needs to use the access token outside the route | |||
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
| authSecureStorage | parameter | security | com.box.boxjavalibv2.authorization.IAuthSecureStorage | OAuth Secure Storage callback, can be used to provide and or save OAuth tokens. The callback may return null on first call to allow the component to login and authorize application and obtain an OAuth token, which can then be saved in the secure storage. For the component to be able to create a token automatically a user password must be provided. | |||
| clientSecret | parameter | security | java.lang.String | Box application client secret | |||
| sslContextParameters | parameter | security | org.apache.camel.util.jsse.SSLContextParameters | To configure security using SSLContextParameters. | |||
| userName | parameter | security | java.lang.String | Box user name, MUST be provided | |||
| userPassword | parameter | security | java.lang.String | Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call |
The Box consumer.