Box

Box

Scheme: box

Represents a Box endpoint.

Name Kind Type Required Deprecated Default Value Enum Values Description
apiName path org.apache.camel.component.box.internal.BoxApiName true false 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 java.lang.String true false What sub operation to use for the selected operation
clientId parameter java.lang.String false Box application client ID
clientSecret parameter java.lang.String false Box application client secret
authSecureStorage parameter com.box.boxjavalibv2.authorization.IAuthSecureStorage false 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.
userName parameter java.lang.String true false Box user name, MUST be provided
userPassword parameter java.lang.String false Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call
refreshListener parameter com.box.boxjavalibv2.authorization.OAuthRefreshListener false OAuth listener for token updates, if the Camel application needs to use the access token outside the route
revokeOnShutdown parameter boolean false 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 java.lang.String false Box shared link for shared endpoints, can be a link for a shared comment, file or folder
sharedPassword parameter java.lang.String false Password associated with the shared link, MUST be provided with sharedLink
boxConfig parameter com.box.boxjavalibv2.IBoxConfig false Custom Box SDK configuration, not required normally
connectionManagerBuilder parameter com.box.boxjavalibv2.BoxConnectionManagerBuilder false Custom Box connection manager builder, used to override default settings like max connections for underlying HttpClient.
httpParams parameter java.util.Map false Custom HTTP params for settings like proxy host
sslContextParameters parameter org.apache.camel.util.jsse.SSLContextParameters false To configure security using SSLContextParameters.
loginTimeout parameter int false 30 Amount of time the component will wait for a response from Box.com, default is 30 seconds
inBody parameter java.lang.String false Sets the name of a parameter to be passed in the exchange In Body
exchangePattern parameter org.apache.camel.ExchangePattern false InOnly InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter boolean false false Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

box consumer

The Box consumer.