org.apache.camel.builder.endpoint.dsl

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 Type	Method and Description
default BoxEndpointBuilderFactory.AdvancedBoxEndpointBuilder	advanced()
default BoxEndpointBuilderFactory.BoxEndpointBuilder	authenticationType(String authenticationType) The type of authentication for connection.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	clientId(String clientId) Box application client ID.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	clientSecret(String clientSecret) Box application client secret.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	enterpriseId(String enterpriseId) The enterprise ID to use for an App Enterprise.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	inBody(String inBody) Sets the name of a parameter to be passed in the exchange In Body.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	privateKeyFile(String privateKeyFile) The private key for generating the JWT signature.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	privateKeyPassword(String privateKeyPassword) The password for the private key.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	publicKeyId(String publicKeyId) The ID for public key for validating the JWT signature.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	sslContextParameters(Object sslContextParameters) To configure security using SSLContextParameters.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	userId(String userId) The user ID to use for an App User.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	userName(String userName) Box user name, MUST be provided.
default BoxEndpointBuilderFactory.BoxEndpointBuilder	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, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default BoxEndpointBuilderFactory.AdvancedBoxEndpointBuilder advanced()

Specified by:

advanced in interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

advanced in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

clientId

default BoxEndpointBuilderFactory.BoxEndpointBuilder clientId(String clientId)

Box application client ID. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

clientId in interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

clientId in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

clientId - the value to set

Returns:

the dsl builder

enterpriseId

default BoxEndpointBuilderFactory.BoxEndpointBuilder enterpriseId(String 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 interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

enterpriseId in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

enterpriseId - the value to set

Returns:

the dsl builder

inBody

default BoxEndpointBuilderFactory.BoxEndpointBuilder inBody(String 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 interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

inBody in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

inBody - the value to set

Returns:

the dsl builder

userId

default BoxEndpointBuilderFactory.BoxEndpointBuilder userId(String 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 interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

userId in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

userId - the value to set

Returns:

the dsl builder

authenticationType

default BoxEndpointBuilderFactory.BoxEndpointBuilder 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

Specified by:

authenticationType in interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

authenticationType in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

authenticationType - the value to set

Returns:

the dsl builder

clientSecret

default BoxEndpointBuilderFactory.BoxEndpointBuilder clientSecret(String clientSecret)

Box application client secret. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

clientSecret in interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

clientSecret in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

clientSecret - the value to set

Returns:

the dsl builder

privateKeyFile

default BoxEndpointBuilderFactory.BoxEndpointBuilder privateKeyFile(String 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 interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

privateKeyFile in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

privateKeyFile - the value to set

Returns:

the dsl builder

privateKeyPassword

default BoxEndpointBuilderFactory.BoxEndpointBuilder privateKeyPassword(String privateKeyPassword)

The password for the private key. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

privateKeyPassword in interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

privateKeyPassword in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

privateKeyPassword - the value to set

Returns:

the dsl builder

publicKeyId

default BoxEndpointBuilderFactory.BoxEndpointBuilder 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

Specified by:

publicKeyId in interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

publicKeyId in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

publicKeyId - the value to set

Returns:

the dsl builder

sslContextParameters

default BoxEndpointBuilderFactory.BoxEndpointBuilder sslContextParameters(Object 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 interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

sslContextParameters in interface BoxEndpointBuilderFactory.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 interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

sslContextParameters in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

userName

default BoxEndpointBuilderFactory.BoxEndpointBuilder userName(String userName)

Box user name, MUST be provided. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

userName in interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

userName in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

userName - the value to set

Returns:

the dsl builder

userPassword

default BoxEndpointBuilderFactory.BoxEndpointBuilder 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

Specified by:

userPassword in interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Specified by:

userPassword in interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

Parameters:

userPassword - the value to set

Returns:

the dsl builder