Interface BoxEndpointBuilderFactory.BoxEndpointBuilder
- All Superinterfaces:
BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
,BoxEndpointBuilderFactory.BoxEndpointProducerBuilder
,org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- BoxEndpointBuilderFactory
public static interface BoxEndpointBuilderFactory.BoxEndpointBuilder
extends BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder, BoxEndpointBuilderFactory.BoxEndpointProducerBuilder
Builder for endpoint for the Box component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
authenticationType
(String authenticationType) The type of authentication for connection.Box application client ID.clientSecret
(String clientSecret) Box application client secret.enterpriseId
(String enterpriseId) The enterprise ID to use for an App Enterprise.Sets the name of a parameter to be passed in the exchange In Body.privateKeyFile
(String privateKeyFile) The private key for generating the JWT signature.privateKeyPassword
(String privateKeyPassword) The password for the private key.publicKeyId
(String publicKeyId) The ID for public key for validating the JWT signature.sslContextParameters
(String sslContextParameters) To configure security using SSLContextParameters.sslContextParameters
(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters.The user ID to use for an App User.Box user name, MUST be provided.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.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
- Specified by:
advanced
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
advanced
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
-
clientId
Box application client ID. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
clientId
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
clientId
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
clientId
- the value to set- Returns:
- the dsl builder
-
enterpriseId
The enterprise ID to use for an App Enterprise. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
enterpriseId
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
enterpriseId
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
enterpriseId
- the value to set- Returns:
- the dsl builder
-
inBody
Sets the name of a parameter to be passed in the exchange In Body. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
inBody
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
inBody
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
inBody
- the value to set- Returns:
- the dsl builder
-
userId
The user ID to use for an App User. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
userId
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
userId
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
userId
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
authenticationType
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
authenticationType
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
authenticationType
- the value to set- Returns:
- the dsl builder
-
clientSecret
Box application client secret. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
clientSecret
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
clientSecret
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
clientSecret
- the value to set- Returns:
- the dsl builder
-
privateKeyFile
The private key for generating the JWT signature. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
privateKeyFile
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
privateKeyFile
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
privateKeyFile
- the value to set- Returns:
- the dsl builder
-
privateKeyPassword
The password for the private key. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
privateKeyPassword
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
privateKeyPassword
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
privateKeyPassword
- the value to set- Returns:
- the dsl builder
-
publicKeyId
The ID for public key for validating the JWT signature. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
publicKeyId
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
publicKeyId
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
publicKeyId
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default BoxEndpointBuilderFactory.BoxEndpointBuilder 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- Specified by:
sslContextParameters
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
sslContextParameters
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default BoxEndpointBuilderFactory.BoxEndpointBuilder sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Specified by:
sslContextParameters
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
sslContextParameters
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
userName
Box user name, MUST be provided. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
userName
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
userName
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
userName
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
userPassword
in interfaceBoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
- Specified by:
userPassword
in interfaceBoxEndpointBuilderFactory.BoxEndpointProducerBuilder
- Parameters:
userPassword
- the value to set- Returns:
- the dsl builder
-