BoxComponentBuilderFactory.BoxComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.box.BoxComponent>

All Known Implementing Classes:

BoxComponentBuilderFactory.BoxComponentBuilderImpl

Enclosing interface:

BoxComponentBuilderFactory
```
public static interface BoxComponentBuilderFactory.BoxComponentBuilder
extends ComponentBuilder<org.apache.camel.component.box.BoxComponent>
```
Builder for the Box component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`accessTokenCache(com.box.sdk.IAccessTokenCache accessTokenCache)` Custom Access Token Cache for storing and retrieving access tokens.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`authenticationType(String authenticationType)` The type of authentication for connection.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`autowiredEnabled(boolean autowiredEnabled)` Whether autowiring is enabled.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` 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.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`clientId(String clientId)` Box application client ID.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`clientSecret(String clientSecret)` Box application client secret.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`configuration(org.apache.camel.component.box.BoxConfiguration configuration)` To use the shared configuration.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`encryptionAlgorithm(com.box.sdk.EncryptionAlgorithm encryptionAlgorithm)` The type of encryption algorithm for JWT.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`enterpriseId(String enterpriseId)` The enterprise ID to use for an App Enterprise.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`httpParams(Map<String,Object> httpParams)` Custom HTTP params for settings like proxy host.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`maxCacheEntries(int maxCacheEntries)` The maximum number of access tokens in cache.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`privateKeyFile(String privateKeyFile)` The private key for generating the JWT signature.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`privateKeyPassword(String privateKeyPassword)` The password for the private key.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`publicKeyId(String publicKeyId)` The ID for public key for validating the JWT signature.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)` To configure security using SSLContextParameters.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`userId(String userId)` The user ID to use for an App User.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`userName(String userName)` Box user name, MUST be provided.
`default BoxComponentBuilderFactory.BoxComponentBuilder`	`userPassword(String userPassword)` Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - clientId
```
default BoxComponentBuilderFactory.BoxComponentBuilder clientId(String clientId)
```
    Box application client ID. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    clientId - the value to set
    
    Returns:
    
    the dsl builder
  - configuration
```
default BoxComponentBuilderFactory.BoxComponentBuilder configuration(org.apache.camel.component.box.BoxConfiguration configuration)
```
    To use the shared configuration. The option is a: <code>org.apache.camel.component.box.BoxConfiguration</code> type. Group: common
    
    Parameters:
    
    configuration - the value to set
    
    Returns:
    
    the dsl builder
  - enterpriseId
```
default BoxComponentBuilderFactory.BoxComponentBuilder enterpriseId(String enterpriseId)
```
    The enterprise ID to use for an App Enterprise. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    enterpriseId - the value to set
    
    Returns:
    
    the dsl builder
  - userId
```
default BoxComponentBuilderFactory.BoxComponentBuilder userId(String userId)
```
    The user ID to use for an App User. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    userId - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default BoxComponentBuilderFactory.BoxComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    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 or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default BoxComponentBuilderFactory.BoxComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    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. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - autowiredEnabled
```
default BoxComponentBuilderFactory.BoxComponentBuilder autowiredEnabled(boolean autowiredEnabled)
```
    Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
    
    Parameters:
    
    autowiredEnabled - the value to set
    
    Returns:
    
    the dsl builder
  - httpParams
```
default BoxComponentBuilderFactory.BoxComponentBuilder httpParams(Map<String,Object> httpParams)
```
    Custom HTTP params for settings like proxy host. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. Group: advanced
    
    Parameters:
    
    httpParams - the value to set
    
    Returns:
    
    the dsl builder
  - authenticationType
```
default BoxComponentBuilderFactory.BoxComponentBuilder authenticationType(String authenticationType)
```
    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. The option is a: <code>java.lang.String</code> type. Default: APP_USER_AUTHENTICATION Group: authentication
    
    Parameters:
    
    authenticationType - the value to set
    
    Returns:
    
    the dsl builder
  - accessTokenCache
```
default BoxComponentBuilderFactory.BoxComponentBuilder accessTokenCache(com.box.sdk.IAccessTokenCache accessTokenCache)
```
    Custom Access Token Cache for storing and retrieving access tokens. The option is a: <code>com.box.sdk.IAccessTokenCache</code> type. Group: security
    
    Parameters:
    
    accessTokenCache - the value to set
    
    Returns:
    
    the dsl builder
  - clientSecret
```
default BoxComponentBuilderFactory.BoxComponentBuilder clientSecret(String clientSecret)
```
    Box application client secret. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    clientSecret - the value to set
    
    Returns:
    
    the dsl builder
  - encryptionAlgorithm
```
default BoxComponentBuilderFactory.BoxComponentBuilder encryptionAlgorithm(com.box.sdk.EncryptionAlgorithm encryptionAlgorithm)
```
    The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512. The option is a: <code>com.box.sdk.EncryptionAlgorithm</code> type. Default: RSA_SHA_256 Group: security
    
    Parameters:
    
    encryptionAlgorithm - the value to set
    
    Returns:
    
    the dsl builder
  - maxCacheEntries
```
default BoxComponentBuilderFactory.BoxComponentBuilder maxCacheEntries(int maxCacheEntries)
```
    The maximum number of access tokens in cache. The option is a: <code>int</code> type. Default: 100 Group: security
    
    Parameters:
    
    maxCacheEntries - the value to set
    
    Returns:
    
    the dsl builder
  - privateKeyFile
```
default BoxComponentBuilderFactory.BoxComponentBuilder privateKeyFile(String privateKeyFile)
```
    The private key for generating the JWT signature. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    privateKeyFile - the value to set
    
    Returns:
    
    the dsl builder
  - privateKeyPassword
```
default BoxComponentBuilderFactory.BoxComponentBuilder privateKeyPassword(String privateKeyPassword)
```
    The password for the private key. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    privateKeyPassword - the value to set
    
    Returns:
    
    the dsl builder
  - publicKeyId
```
default BoxComponentBuilderFactory.BoxComponentBuilder publicKeyId(String publicKeyId)
```
    The ID for public key for validating the JWT signature. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    publicKeyId - the value to set
    
    Returns:
    
    the dsl builder
  - sslContextParameters
```
default BoxComponentBuilderFactory.BoxComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
```
    To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
    
    Parameters:
    
    sslContextParameters - the value to set
    
    Returns:
    
    the dsl builder
  - userName
```
default BoxComponentBuilderFactory.BoxComponentBuilder userName(String userName)
```
    Box user name, MUST be provided. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    userName - the value to set
    
    Returns:
    
    the dsl builder
  - userPassword
```
default BoxComponentBuilderFactory.BoxComponentBuilder userPassword(String userPassword)
```
    Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    userPassword - the value to set
    
    Returns:
    
    the dsl builder

Interface BoxComponentBuilderFactory.BoxComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

clientId

configuration

enterpriseId

userId

bridgeErrorHandler

lazyStartProducer

autowiredEnabled

httpParams

authenticationType

accessTokenCache

clientSecret

encryptionAlgorithm

maxCacheEntries

privateKeyFile

privateKeyPassword

publicKeyId

sslContextParameters

userName

userPassword