SalesforceComponentBuilderFactory.SalesforceComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.salesforce.SalesforceComponent>

All Known Implementing Classes:

SalesforceComponentBuilderFactory.SalesforceComponentBuilderImpl

Enclosing interface:

SalesforceComponentBuilderFactory
```
public static interface SalesforceComponentBuilderFactory.SalesforceComponentBuilder
extends ComponentBuilder<org.apache.camel.component.salesforce.SalesforceComponent>
```
Builder for the Salesforce component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`authenticationType(org.apache.camel.component.salesforce.AuthenticationType authenticationType)` Explicit authentication method to be used, one of USERNAME_PASSWORD, REFRESH_TOKEN or JWT.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`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 SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`clientId(String clientId)` OAuth Consumer Key of the connected app configured in the Salesforce instance setup.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`clientSecret(String clientSecret)` OAuth Consumer Secret of the connected app configured in the Salesforce instance setup.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`config(org.apache.camel.component.salesforce.SalesforceEndpointConfig config)` Global endpoint configuration - use to set values that are common to all endpoints.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpClientConnectionTimeout(long httpClientConnectionTimeout)` Connection timeout used by the HttpClient when connecting to the Salesforce server.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpClientIdleTimeout(long httpClientIdleTimeout)` Timeout used by the HttpClient when waiting for response from the Salesforce server.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpClientProperties(Map<String,Object> httpClientProperties)` Used to set any properties that can be configured on the underlying HTTP client.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpMaxContentLength(Integer httpMaxContentLength)` Max content length of an HTTP response.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpProxyAuthUri(String httpProxyAuthUri)` Used in authentication against the HTTP proxy server, needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpProxyExcludedAddresses(Set<String> httpProxyExcludedAddresses)` A list of addresses for which HTTP proxy server should not be used.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpProxyHost(String httpProxyHost)` Hostname of the HTTP proxy server to use.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpProxyIncludedAddresses(Set<String> httpProxyIncludedAddresses)` A list of addresses for which HTTP proxy server should be used.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpProxyPassword(String httpProxyPassword)` Password to use to authenticate against the HTTP proxy server.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpProxyPort(Integer httpProxyPort)` Port number of the HTTP proxy server to use.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpProxyRealm(String httpProxyRealm)` Realm of the proxy server, used in preemptive Basic/Digest authentication methods against the HTTP proxy server.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpProxyUseDigestAuth(boolean httpProxyUseDigestAuth)` If set to true Digest authentication will be used when authenticating to the HTTP proxy, otherwise Basic authorization method will be used.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`httpProxyUsername(String httpProxyUsername)` Username to use to authenticate against the HTTP proxy server.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`instanceUrl(String instanceUrl)` URL of the Salesforce instance used after authentication, by default received from Salesforce on successful authentication.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`isHttpProxySecure(boolean isHttpProxySecure)` If set to false disables the use of TLS when accessing the HTTP proxy.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`isHttpProxySocks4(boolean isHttpProxySocks4)` If set to true the configures the HTTP proxy to use as a SOCKS4 proxy.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`keystore(org.apache.camel.support.jsse.KeyStoreParameters keystore)` KeyStore parameters to use in OAuth JWT flow.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`lazyLogin(boolean lazyLogin)` If set to true prevents the component from authenticating to Salesforce with the start of the component.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`loginConfig(org.apache.camel.component.salesforce.SalesforceLoginConfig loginConfig)` All authentication configuration in one nested bean, all properties set there can be set directly on the component as well.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`loginUrl(String loginUrl)` URL of the Salesforce instance used for authentication, by default set to https://login.salesforce.com.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`longPollingTransportProperties(Map<String,Object> longPollingTransportProperties)` Used to set any properties that can be configured on the LongPollingTransport used by the BayeuxClient (CometD) used by the streaming api.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`packages(String[] packages)` In what packages are the generated DTO classes.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`password(String password)` Password used in OAuth flow to gain access to access token.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`refreshToken(String refreshToken)` Refresh token already obtained in the refresh token OAuth flow.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)` SSL parameters to use, see SSLContextParameters class for all available options.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`useGlobalSslContextParameters(boolean useGlobalSslContextParameters)` Enable usage of global SSL context parameters.
`default SalesforceComponentBuilderFactory.SalesforceComponentBuilder`	`userName(String userName)` Username used in OAuth flow to gain access to access token.

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

- Method Detail
  - httpClientConnectionTimeout
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpClientConnectionTimeout(long httpClientConnectionTimeout)
```
    Connection timeout used by the HttpClient when connecting to the Salesforce server. The option is a: long type. Default: 60000 Group: common
  - httpClientIdleTimeout
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpClientIdleTimeout(long httpClientIdleTimeout)
```
    Timeout used by the HttpClient when waiting for response from the Salesforce server. The option is a: long type. Default: 10000 Group: common
  - httpMaxContentLength
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpMaxContentLength(Integer httpMaxContentLength)
```
    Max content length of an HTTP response. The option is a: java.lang.Integer type. Group: common
  - packages
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder packages(String[] packages)
```
    In what packages are the generated DTO classes. Typically the classes would be generated using camel-salesforce-maven-plugin. Set it if using the generated DTOs to gain the benefit of using short SObject names in parameters/header values. The option is a: java.lang.String[] type. Group: common
  - config
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder config(org.apache.camel.component.salesforce.SalesforceEndpointConfig config)
```
    Global endpoint configuration - use to set values that are common to all endpoints. The option is a: org.apache.camel.component.salesforce.SalesforceEndpointConfig type. Group: common (advanced)
  - httpClientProperties
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpClientProperties(Map<String,Object> httpClientProperties)
```
    Used to set any properties that can be configured on the underlying HTTP client. Have a look at properties of SalesforceHttpClient and the Jetty HttpClient for all available options. The option is a: java.util.Map type. Group: common (advanced)
  - longPollingTransportProperties
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder longPollingTransportProperties(Map<String,Object> longPollingTransportProperties)
```
    Used to set any properties that can be configured on the LongPollingTransport used by the BayeuxClient (CometD) used by the streaming api. The option is a: java.util.Map type. Group: common (advanced)
  - bridgeErrorHandler
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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: boolean type. Default: false Group: consumer
  - lazyStartProducer
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder 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: boolean type. Default: false Group: producer
  - basicPropertyBinding
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - httpProxyExcludedAddresses
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyExcludedAddresses(Set<String> httpProxyExcludedAddresses)
```
    A list of addresses for which HTTP proxy server should not be used. The option is a: java.util.Set type. Group: proxy
  - httpProxyHost
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyHost(String httpProxyHost)
```
    Hostname of the HTTP proxy server to use. The option is a: java.lang.String type. Group: proxy
  - httpProxyIncludedAddresses
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyIncludedAddresses(Set<String> httpProxyIncludedAddresses)
```
    A list of addresses for which HTTP proxy server should be used. The option is a: java.util.Set type. Group: proxy
  - httpProxyPort
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyPort(Integer httpProxyPort)
```
    Port number of the HTTP proxy server to use. The option is a: java.lang.Integer type. Group: proxy
  - isHttpProxySocks4
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder isHttpProxySocks4(boolean isHttpProxySocks4)
```
    If set to true the configures the HTTP proxy to use as a SOCKS4 proxy. The option is a: boolean type. Default: false Group: proxy
  - authenticationType
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder authenticationType(org.apache.camel.component.salesforce.AuthenticationType authenticationType)
```
    Explicit authentication method to be used, one of USERNAME_PASSWORD, REFRESH_TOKEN or JWT. Salesforce component can auto-determine the authentication method to use from the properties set, set this property to eliminate any ambiguity. The option is a: org.apache.camel.component.salesforce.AuthenticationType type. Group: security
  - clientId
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder clientId(String clientId)
```
    OAuth Consumer Key of the connected app configured in the Salesforce instance setup. Typically a connected app needs to be configured but one can be provided by installing a package. The option is a: java.lang.String type. Group: security
  - clientSecret
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder clientSecret(String clientSecret)
```
    OAuth Consumer Secret of the connected app configured in the Salesforce instance setup. The option is a: java.lang.String type. Group: security
  - httpProxyAuthUri
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyAuthUri(String httpProxyAuthUri)
```
    Used in authentication against the HTTP proxy server, needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication. The option is a: java.lang.String type. Group: security
  - httpProxyPassword
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyPassword(String httpProxyPassword)
```
    Password to use to authenticate against the HTTP proxy server. The option is a: java.lang.String type. Group: security
  - httpProxyRealm
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyRealm(String httpProxyRealm)
```
    Realm of the proxy server, used in preemptive Basic/Digest authentication methods against the HTTP proxy server. The option is a: java.lang.String type. Group: security
  - httpProxyUseDigestAuth
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyUseDigestAuth(boolean httpProxyUseDigestAuth)
```
    If set to true Digest authentication will be used when authenticating to the HTTP proxy, otherwise Basic authorization method will be used. The option is a: boolean type. Default: false Group: security
  - httpProxyUsername
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder httpProxyUsername(String httpProxyUsername)
```
    Username to use to authenticate against the HTTP proxy server. The option is a: java.lang.String type. Group: security
  - instanceUrl
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder instanceUrl(String instanceUrl)
```
    URL of the Salesforce instance used after authentication, by default received from Salesforce on successful authentication. The option is a: java.lang.String type. Group: security
  - isHttpProxySecure
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder isHttpProxySecure(boolean isHttpProxySecure)
```
    If set to false disables the use of TLS when accessing the HTTP proxy. The option is a: boolean type. Default: true Group: security
  - keystore
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder keystore(org.apache.camel.support.jsse.KeyStoreParameters keystore)
```
    KeyStore parameters to use in OAuth JWT flow. The KeyStore should contain only one entry with private key and certificate. Salesforce does not verify the certificate chain, so this can easily be a selfsigned certificate. Make sure that you upload the certificate to the corresponding connected app. The option is a: org.apache.camel.support.jsse.KeyStoreParameters type. Group: security
  - lazyLogin
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder lazyLogin(boolean lazyLogin)
```
    If set to true prevents the component from authenticating to Salesforce with the start of the component. You would generally set this to the (default) false and authenticate early and be immediately aware of any authentication issues. The option is a: boolean type. Default: false Group: security
  - loginConfig
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder loginConfig(org.apache.camel.component.salesforce.SalesforceLoginConfig loginConfig)
```
    All authentication configuration in one nested bean, all properties set there can be set directly on the component as well. The option is a: org.apache.camel.component.salesforce.SalesforceLoginConfig type. Group: security
  - loginUrl
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder loginUrl(String loginUrl)
```
    URL of the Salesforce instance used for authentication, by default set to https://login.salesforce.com. The option is a: java.lang.String type. Default: https://login.salesforce.com Group: security
  - password
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder password(String password)
```
    Password used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. Make sure that you append security token to the end of the password if using one. The option is a: java.lang.String type. Group: security
  - refreshToken
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder refreshToken(String refreshToken)
```
    Refresh token already obtained in the refresh token OAuth flow. One needs to setup a web application and configure a callback URL to receive the refresh token, or configure using the builtin callback at https://login.salesforce.com/services/oauth2/success or https://test.salesforce.com/services/oauth2/success and then retrive the refresh_token from the URL at the end of the flow. Note that in development organizations Salesforce allows hosting the callback web application at localhost. The option is a: java.lang.String type. Group: security
  - sslContextParameters
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
```
    SSL parameters to use, see SSLContextParameters class for all available options. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
  - useGlobalSslContextParameters
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
```
    Enable usage of global SSL context parameters. The option is a: boolean type. Default: false Group: security
  - userName
```
default SalesforceComponentBuilderFactory.SalesforceComponentBuilder userName(String userName)
```
    Username used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. The option is a: java.lang.String type. Group: security

Interface SalesforceComponentBuilderFactory.SalesforceComponentBuilder

Method Summary

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

Method Detail

httpClientConnectionTimeout

httpClientIdleTimeout

httpMaxContentLength

packages

config

httpClientProperties

longPollingTransportProperties

bridgeErrorHandler

lazyStartProducer

basicPropertyBinding

httpProxyExcludedAddresses

httpProxyHost

httpProxyIncludedAddresses

httpProxyPort

isHttpProxySocks4

authenticationType

clientId

clientSecret

httpProxyAuthUri

httpProxyPassword

httpProxyRealm

httpProxyUseDigestAuth

httpProxyUsername

instanceUrl

isHttpProxySecure

keystore

lazyLogin

loginConfig

loginUrl

password

refreshToken

sslContextParameters

useGlobalSslContextParameters

userName