Interface KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder
Enclosing interface:
KeycloakEndpointBuilderFactory

public static interface KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Keycloak component.
  • Method Details

    • advanced

    • accessToken

      Pre-obtained access token for authentication. When provided, this token will be used directly instead of obtaining one through username/password or client credentials flow. The option is a: java.lang.String type. Group: common
      Parameters:
      accessToken - the value to set
      Returns:
      the dsl builder
    • authClient

      Filter admin events by authentication client ID. The option is a: java.lang.String type. Group: common
      Parameters:
      authClient - the value to set
      Returns:
      the dsl builder
    • authIpAddress

      Filter admin events by authentication IP address. The option is a: java.lang.String type. Group: common
      Parameters:
      authIpAddress - the value to set
      Returns:
      the dsl builder
    • authRealm

      Keycloak realm to authenticate against. If not specified, the realm parameter is used for authentication. This is useful when you want to authenticate against one realm (e.g., master) but perform operations on another realm. The option is a: java.lang.String type. Default: master Group: common
      Parameters:
      authRealm - the value to set
      Returns:
      the dsl builder
    • authRealmFilter

      Filter admin events by authentication realm. The option is a: java.lang.String type. Group: common
      Parameters:
      authRealmFilter - the value to set
      Returns:
      the dsl builder
    • authUser

      Filter admin events by authentication user ID. The option is a: java.lang.String type. Group: common
      Parameters:
      authUser - the value to set
      Returns:
      the dsl builder
    • client

      Filter events by client ID. The option is a: java.lang.String type. Group: common
      Parameters:
      client - the value to set
      Returns:
      the dsl builder
    • clientId

      Keycloak client ID. The option is a: java.lang.String type. Group: common
      Parameters:
      clientId - the value to set
      Returns:
      the dsl builder
    • clientSecret

      Keycloak client secret. The option is a: java.lang.String type. Group: common
      Parameters:
      clientSecret - the value to set
      Returns:
      the dsl builder
    • dateFrom

      Filter events by start date/time in milliseconds since epoch. The option is a: java.lang.String type. Group: common
      Parameters:
      dateFrom - the value to set
      Returns:
      the dsl builder
    • dateTo

      Filter events by end date/time in milliseconds since epoch. The option is a: java.lang.String type. Group: common
      Parameters:
      dateTo - the value to set
      Returns:
      the dsl builder
    • eventType

      Type of events to consume: events or admin-events. The option is a: java.lang.String type. Default: events Group: common
      Parameters:
      eventType - the value to set
      Returns:
      the dsl builder
    • first

      Offset for pagination (first result index). The option is a: int type. Default: 0 Group: common
      Parameters:
      first - the value to set
      Returns:
      the dsl builder
    • first

      Offset for pagination (first result index). The option will be converted to a int type. Default: 0 Group: common
      Parameters:
      first - the value to set
      Returns:
      the dsl builder
    • introspectionCacheEnabled

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder introspectionCacheEnabled(boolean introspectionCacheEnabled)
      Enable caching of token introspection results to reduce API calls to Keycloak. The option is a: boolean type. Default: true Group: common
      Parameters:
      introspectionCacheEnabled - the value to set
      Returns:
      the dsl builder
    • introspectionCacheEnabled

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder introspectionCacheEnabled(String introspectionCacheEnabled)
      Enable caching of token introspection results to reduce API calls to Keycloak. The option will be converted to a boolean type. Default: true Group: common
      Parameters:
      introspectionCacheEnabled - the value to set
      Returns:
      the dsl builder
    • introspectionCacheTtl

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder introspectionCacheTtl(long introspectionCacheTtl)
      Time-to-live for cached introspection results in seconds. The option is a: long type. Default: 60 Group: common
      Parameters:
      introspectionCacheTtl - the value to set
      Returns:
      the dsl builder
    • introspectionCacheTtl

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder introspectionCacheTtl(String introspectionCacheTtl)
      Time-to-live for cached introspection results in seconds. The option will be converted to a long type. Default: 60 Group: common
      Parameters:
      introspectionCacheTtl - the value to set
      Returns:
      the dsl builder
    • ipAddress

      Filter events by IP address. The option is a: java.lang.String type. Group: common
      Parameters:
      ipAddress - the value to set
      Returns:
      the dsl builder
    • keycloakClient

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder keycloakClient(org.keycloak.admin.client.Keycloak keycloakClient)
      To use an existing configured Keycloak admin client. The option is a: org.keycloak.admin.client.Keycloak type. Group: common
      Parameters:
      keycloakClient - the value to set
      Returns:
      the dsl builder
    • keycloakClient

      To use an existing configured Keycloak admin client. The option will be converted to a org.keycloak.admin.client.Keycloak type. Group: common
      Parameters:
      keycloakClient - the value to set
      Returns:
      the dsl builder
    • maxResults

      Maximum number of events to retrieve per poll. The option is a: int type. Default: 100 Group: common
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder
    • maxResults

      Maximum number of events to retrieve per poll. The option will be converted to a int type. Default: 100 Group: common
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder
    • operation

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder operation(org.apache.camel.component.keycloak.KeycloakOperations operation)
      The operation to perform. The option is a: org.apache.camel.component.keycloak.KeycloakOperations type. Group: common
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder
    • operation

      The operation to perform. The option will be converted to a org.apache.camel.component.keycloak.KeycloakOperations type. Group: common
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder
    • operationTypes

      Filter admin events by operation types (comma-separated list, e.g., CREATE,UPDATE,DELETE). The option is a: java.lang.String type. Group: common
      Parameters:
      operationTypes - the value to set
      Returns:
      the dsl builder
    • password

      Keycloak password. The option is a: java.lang.String type. Group: common
      Parameters:
      password - the value to set
      Returns:
      the dsl builder
    • pojoRequest

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder pojoRequest(boolean pojoRequest)
      If we want to use a POJO request as body or not. The option is a: boolean type. Default: false Group: common
      Parameters:
      pojoRequest - the value to set
      Returns:
      the dsl builder
    • pojoRequest

      If we want to use a POJO request as body or not. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      pojoRequest - the value to set
      Returns:
      the dsl builder
    • realm

      Keycloak realm, the default is master because usually all the operations are done starting from the master realm. The option is a: java.lang.String type. Default: master Group: common
      Parameters:
      realm - the value to set
      Returns:
      the dsl builder
    • resourcePath

      Filter admin events by resource path. The option is a: java.lang.String type. Group: common
      Parameters:
      resourcePath - the value to set
      Returns:
      the dsl builder
    • serverUrl

      Keycloak server URL. The option is a: java.lang.String type. Group: common
      Parameters:
      serverUrl - the value to set
      Returns:
      the dsl builder
    • types

      Filter events by event types (comma-separated list, e.g., LOGIN,LOGOUT). The option is a: java.lang.String type. Group: common
      Parameters:
      types - the value to set
      Returns:
      the dsl builder
    • user

      Filter events by user ID. The option is a: java.lang.String type. Group: common
      Parameters:
      user - the value to set
      Returns:
      the dsl builder
    • username

      Keycloak username. The option is a: java.lang.String type. Group: common
      Parameters:
      username - the value to set
      Returns:
      the dsl builder
    • useTokenIntrospection

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder useTokenIntrospection(boolean useTokenIntrospection)
      Enable OAuth 2.0 token introspection for real-time token validation. When enabled, tokens are validated by calling Keycloak's introspection endpoint instead of local JWT parsing. This allows detecting revoked tokens before expiration. The option is a: boolean type. Default: false Group: common
      Parameters:
      useTokenIntrospection - the value to set
      Returns:
      the dsl builder
    • useTokenIntrospection

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder useTokenIntrospection(String useTokenIntrospection)
      Enable OAuth 2.0 token introspection for real-time token validation. When enabled, tokens are validated by calling Keycloak's introspection endpoint instead of local JWT parsing. This allows detecting revoked tokens before expiration. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      useTokenIntrospection - the value to set
      Returns:
      the dsl builder
    • sendEmptyMessageWhenIdle

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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
    • backoffErrorThreshold

      default KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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

      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

      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

      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

      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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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

      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

      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

      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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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

      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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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

      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

      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

      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: 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

      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: 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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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

      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

      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

      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 KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder 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

      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