Box

Box

Description: Represents the component that manages BoxEndpoint.
Scheme: box
Syntax: box:apiName/methodName
Maven: org.apache.camel/camel-box/2.16.1

Represents a Box endpoint.

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
authSecureStorage parameter common 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.
boxConfig parameter common com.box.boxjavalibv2.IBoxConfig Custom Box SDK configuration, not required normally
clientId parameter common java.lang.String Box application client ID
clientSecret parameter common java.lang.String Box application client secret
connectionManagerBuilder parameter common com.box.boxjavalibv2.BoxConnectionManagerBuilder Custom Box connection manager builder, used to override default settings like max connections for underlying HttpClient.
httpParams parameter common java.util.Map Custom HTTP params for settings like proxy host
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
refreshListener parameter common com.box.boxjavalibv2.authorization.OAuthRefreshListener OAuth listener for token updates, if the Camel application needs to use the access token outside the route
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
sslContextParameters parameter common org.apache.camel.util.jsse.SSLContextParameters To configure security using SSLContextParameters.
userName parameter common true java.lang.String Box user name, MUST be provided
userPassword parameter common java.lang.String Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call
exchangePattern parameter advanced InOnly org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

box consumer

The Box consumer.