Package org.apache.camel.builder.endpoint.dsl

Interface FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
FhirEndpointBuilderFactory.FhirEndpointBuilder
Enclosing interface:
FhirEndpointBuilderFactory
public static interface FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the FHIR component.

  • Method Details

    • advanced

      default FhirEndpointBuilderFactory.AdvancedFhirEndpointConsumerBuilder advanced()

    • encoding

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder encoding(String encoding)
      Encoding to use for all request. The option is a: java.lang.String type. Group: common
      Parameters:
      encoding - the value to set
      Returns:
      the dsl builder

    • fhirVersion

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder fhirVersion(String fhirVersion)
      The FHIR Version to use. The option is a: java.lang.String type. Default: R4 Group: common
      Parameters:
      fhirVersion - the value to set
      Returns:
      the dsl builder

    • inBody

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder inBody(String inBody)
      Sets the name of a parameter to be passed in the exchange In Body. The option is a: java.lang.String type. Group: common
      Parameters:
      inBody - the value to set
      Returns:
      the dsl builder

    • log

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder log(boolean log)
      Will log every requests and responses. The option is a: boolean type. Default: false Group: common
      Parameters:
      log - the value to set
      Returns:
      the dsl builder

    • log

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder log(String log)
      Will log every requests and responses. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      log - the value to set
      Returns:
      the dsl builder

    • prettyPrint

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder prettyPrint(boolean prettyPrint)
      Pretty print all request. The option is a: boolean type. Default: false Group: common
      Parameters:
      prettyPrint - the value to set
      Returns:
      the dsl builder

    • prettyPrint

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder prettyPrint(String prettyPrint)
      Pretty print all request. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      prettyPrint - the value to set
      Returns:
      the dsl builder

    • serverUrl

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder serverUrl(String serverUrl)
      The FHIR server base URL. The option is a: java.lang.String type. Group: common
      Parameters:
      serverUrl - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder proxyHost(String proxyHost)
      The proxy host. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPassword

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder proxyPassword(String proxyPassword)
      The proxy password. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyPassword - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder proxyPort(Integer proxyPort)
      The proxy port. The option is a: java.lang.Integer type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder proxyPort(String proxyPort)
      The proxy port. The option will be converted to a java.lang.Integer type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyUser

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder proxyUser(String proxyUser)
      The proxy username. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyUser - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: int type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • delay

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder delay(long delay)
      Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • delay

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder delay(String delay)
      Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • greedy

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder greedy(boolean greedy)
      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • greedy

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder greedy(String greedy)
      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder initialDelay(long initialDelay)
      Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder initialDelay(String initialDelay)
      Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder repeatCount(long repeatCount)
      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: long type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder repeatCount(String repeatCount)
      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a long type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduler

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder scheduler(Object scheduler)
      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • scheduler

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder scheduler(String scheduler)
      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • schedulerProperties

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder schedulerProperties(String key, Object value)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • schedulerProperties

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder schedulerProperties(Map values)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • startScheduler

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder startScheduler(boolean startScheduler)
      Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • startScheduler

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder startScheduler(String startScheduler)
      Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
      Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder timeUnit(String timeUnit)
      Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: boolean type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder useFixedDelay(String useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • accessToken

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder accessToken(String accessToken)
      OAuth access token. The option is a: java.lang.String type. Group: security
      Parameters:
      accessToken - the value to set
      Returns:
      the dsl builder

    • password

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder password(String password)
      Password to use for basic authentication. The option is a: java.lang.String type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • username

      default FhirEndpointBuilderFactory.FhirEndpointConsumerBuilder username(String username)
      Username to use for basic authentication. The option is a: java.lang.String type. Group: security
      Parameters:
      username - the value to set
      Returns:
      the dsl builder