FhirComponentBuilderFactory.FhirComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.fhir.FhirComponent>

All Known Implementing Classes:

FhirComponentBuilderFactory.FhirComponentBuilderImpl

Enclosing interface:

FhirComponentBuilderFactory
```
public static interface FhirComponentBuilderFactory.FhirComponentBuilder
extends ComponentBuilder<org.apache.camel.component.fhir.FhirComponent>
```
Builder for the FHIR component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`accessToken(String accessToken)` OAuth access token.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`autowiredEnabled(boolean autowiredEnabled)` Whether autowiring is enabled.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`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 FhirComponentBuilderFactory.FhirComponentBuilder`	`client(ca.uhn.fhir.rest.client.api.IGenericClient client)` To use the custom client.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`clientFactory(ca.uhn.fhir.rest.client.api.IRestfulClientFactory clientFactory)` To use the custom client factory.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`compress(boolean compress)` Compresses outgoing (POST/PUT) contents to the GZIP format.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`configuration(org.apache.camel.component.fhir.FhirConfiguration configuration)` To use the shared configuration.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`connectionTimeout(Integer connectionTimeout)` How long to try and establish the initial TCP connection (in ms).
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`deferModelScanning(boolean deferModelScanning)` When this option is set, model classes will not be scanned for children until the child list for the given type is actually accessed.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`encoding(String encoding)` Encoding to use for all request.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`fhirContext(ca.uhn.fhir.context.FhirContext fhirContext)` FhirContext is an expensive object to create.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`fhirVersion(String fhirVersion)` The FHIR Version to use.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`forceConformanceCheck(boolean forceConformanceCheck)` Force conformance check.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`log(boolean log)` Will log every requests and responses.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`password(String password)` Username to use for basic authentication.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`prettyPrint(boolean prettyPrint)` Pretty print all request.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`proxyHost(String proxyHost)` The proxy host.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`proxyPassword(String proxyPassword)` The proxy password.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`proxyPort(Integer proxyPort)` The proxy port.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`proxyUser(String proxyUser)` The proxy username.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`serverUrl(String serverUrl)` The FHIR server base URL.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`sessionCookie(String sessionCookie)` HTTP session cookie to add to every request.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`socketTimeout(Integer socketTimeout)` How long to block for individual read/write operations (in ms).
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`summary(String summary)` Request that the server modify the response using the _summary param.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`username(String username)` Username to use for basic authentication.
`default FhirComponentBuilderFactory.FhirComponentBuilder`	`validationMode(String validationMode)` When should Camel validate the FHIR Server's conformance statement.

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

- Method Detail
  - encoding
```
default FhirComponentBuilderFactory.FhirComponentBuilder encoding(String encoding)
```
    Encoding to use for all request. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    encoding - the value to set
    
    Returns:
    
    the dsl builder
  - fhirVersion
```
default FhirComponentBuilderFactory.FhirComponentBuilder fhirVersion(String fhirVersion)
```
    The FHIR Version to use. The option is a: <code>java.lang.String</code> type. Default: R4 Group: common
    
    Parameters:
    
    fhirVersion - the value to set
    
    Returns:
    
    the dsl builder
  - log
```
default FhirComponentBuilderFactory.FhirComponentBuilder log(boolean log)
```
    Will log every requests and responses. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    log - the value to set
    
    Returns:
    
    the dsl builder
  - prettyPrint
```
default FhirComponentBuilderFactory.FhirComponentBuilder prettyPrint(boolean prettyPrint)
```
    Pretty print all request. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    prettyPrint - the value to set
    
    Returns:
    
    the dsl builder
  - serverUrl
```
default FhirComponentBuilderFactory.FhirComponentBuilder serverUrl(String serverUrl)
```
    The FHIR server base URL. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    serverUrl - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default FhirComponentBuilderFactory.FhirComponentBuilder 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 FhirComponentBuilderFactory.FhirComponentBuilder 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 FhirComponentBuilderFactory.FhirComponentBuilder 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
  - client
```
default FhirComponentBuilderFactory.FhirComponentBuilder client(ca.uhn.fhir.rest.client.api.IGenericClient client)
```
    To use the custom client. The option is a: <code>ca.uhn.fhir.rest.client.api.IGenericClient</code> type. Group: advanced
    
    Parameters:
    
    client - the value to set
    
    Returns:
    
    the dsl builder
  - clientFactory
```
default FhirComponentBuilderFactory.FhirComponentBuilder clientFactory(ca.uhn.fhir.rest.client.api.IRestfulClientFactory clientFactory)
```
    To use the custom client factory. The option is a: <code>ca.uhn.fhir.rest.client.api.IRestfulClientFactory</code> type. Group: advanced
    
    Parameters:
    
    clientFactory - the value to set
    
    Returns:
    
    the dsl builder
  - compress
```
default FhirComponentBuilderFactory.FhirComponentBuilder compress(boolean compress)
```
    Compresses outgoing (POST/PUT) contents to the GZIP format. The option is a: <code>boolean</code> type. Default: false Group: advanced
    
    Parameters:
    
    compress - the value to set
    
    Returns:
    
    the dsl builder
  - configuration
```
default FhirComponentBuilderFactory.FhirComponentBuilder configuration(org.apache.camel.component.fhir.FhirConfiguration configuration)
```
    To use the shared configuration. The option is a: <code>org.apache.camel.component.fhir.FhirConfiguration</code> type. Group: advanced
    
    Parameters:
    
    configuration - the value to set
    
    Returns:
    
    the dsl builder
  - connectionTimeout
```
default FhirComponentBuilderFactory.FhirComponentBuilder connectionTimeout(Integer connectionTimeout)
```
    How long to try and establish the initial TCP connection (in ms). The option is a: <code>java.lang.Integer</code> type. Default: 10000 Group: advanced
    
    Parameters:
    
    connectionTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - deferModelScanning
```
default FhirComponentBuilderFactory.FhirComponentBuilder deferModelScanning(boolean deferModelScanning)
```
    When this option is set, model classes will not be scanned for children until the child list for the given type is actually accessed. The option is a: <code>boolean</code> type. Default: false Group: advanced
    
    Parameters:
    
    deferModelScanning - the value to set
    
    Returns:
    
    the dsl builder
  - fhirContext
```
default FhirComponentBuilderFactory.FhirComponentBuilder fhirContext(ca.uhn.fhir.context.FhirContext fhirContext)
```
    FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly. The option is a: <code>ca.uhn.fhir.context.FhirContext</code> type. Group: advanced
    
    Parameters:
    
    fhirContext - the value to set
    
    Returns:
    
    the dsl builder
  - forceConformanceCheck
```
default FhirComponentBuilderFactory.FhirComponentBuilder forceConformanceCheck(boolean forceConformanceCheck)
```
    Force conformance check. The option is a: <code>boolean</code> type. Default: false Group: advanced
    
    Parameters:
    
    forceConformanceCheck - the value to set
    
    Returns:
    
    the dsl builder
  - sessionCookie
```
default FhirComponentBuilderFactory.FhirComponentBuilder sessionCookie(String sessionCookie)
```
    HTTP session cookie to add to every request. The option is a: <code>java.lang.String</code> type. Group: advanced
    
    Parameters:
    
    sessionCookie - the value to set
    
    Returns:
    
    the dsl builder
  - socketTimeout
```
default FhirComponentBuilderFactory.FhirComponentBuilder socketTimeout(Integer socketTimeout)
```
    How long to block for individual read/write operations (in ms). The option is a: <code>java.lang.Integer</code> type. Default: 10000 Group: advanced
    
    Parameters:
    
    socketTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - summary
```
default FhirComponentBuilderFactory.FhirComponentBuilder summary(String summary)
```
    Request that the server modify the response using the _summary param. The option is a: <code>java.lang.String</code> type. Group: advanced
    
    Parameters:
    
    summary - the value to set
    
    Returns:
    
    the dsl builder
  - validationMode
```
default FhirComponentBuilderFactory.FhirComponentBuilder validationMode(String validationMode)
```
    When should Camel validate the FHIR Server's conformance statement. The option is a: <code>java.lang.String</code> type. Default: ONCE Group: advanced
    
    Parameters:
    
    validationMode - the value to set
    
    Returns:
    
    the dsl builder
  - proxyHost
```
default FhirComponentBuilderFactory.FhirComponentBuilder proxyHost(String proxyHost)
```
    The proxy host. The option is a: <code>java.lang.String</code> type. Group: proxy
    
    Parameters:
    
    proxyHost - the value to set
    
    Returns:
    
    the dsl builder
  - proxyPassword
```
default FhirComponentBuilderFactory.FhirComponentBuilder proxyPassword(String proxyPassword)
```
    The proxy password. The option is a: <code>java.lang.String</code> type. Group: proxy
    
    Parameters:
    
    proxyPassword - the value to set
    
    Returns:
    
    the dsl builder
  - proxyPort
```
default FhirComponentBuilderFactory.FhirComponentBuilder proxyPort(Integer proxyPort)
```
    The proxy port. The option is a: <code>java.lang.Integer</code> type. Group: proxy
    
    Parameters:
    
    proxyPort - the value to set
    
    Returns:
    
    the dsl builder
  - proxyUser
```
default FhirComponentBuilderFactory.FhirComponentBuilder proxyUser(String proxyUser)
```
    The proxy username. The option is a: <code>java.lang.String</code> type. Group: proxy
    
    Parameters:
    
    proxyUser - the value to set
    
    Returns:
    
    the dsl builder
  - accessToken
```
default FhirComponentBuilderFactory.FhirComponentBuilder accessToken(String accessToken)
```
    OAuth access token. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    accessToken - the value to set
    
    Returns:
    
    the dsl builder
  - password
```
default FhirComponentBuilderFactory.FhirComponentBuilder password(String password)
```
    Username to use for basic authentication. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    password - the value to set
    
    Returns:
    
    the dsl builder
  - username
```
default FhirComponentBuilderFactory.FhirComponentBuilder username(String username)
```
    Username to use for basic authentication. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    username - the value to set
    
    Returns:
    
    the dsl builder

Interface FhirComponentBuilderFactory.FhirComponentBuilder

Method Summary

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

Method Detail

encoding

fhirVersion

log

prettyPrint

serverUrl

bridgeErrorHandler

lazyStartProducer

autowiredEnabled

client

clientFactory

compress

configuration

connectionTimeout

deferModelScanning

fhirContext

forceConformanceCheck

sessionCookie

socketTimeout

summary

validationMode

proxyHost

proxyPassword

proxyPort

proxyUser

accessToken

password

username