Package org.apache.camel.builder.component.dsl

Interface KeycloakComponentBuilderFactory.KeycloakComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.keycloak.KeycloakComponent>
All Known Implementing Classes:
KeycloakComponentBuilderFactory.KeycloakComponentBuilderImpl
Enclosing interface:
KeycloakComponentBuilderFactory
public static interface KeycloakComponentBuilderFactory.KeycloakComponentBuilder extends ComponentBuilder<org.apache.camel.component.keycloak.KeycloakComponent>
Builder for the Keycloak component.

  • Method Details

    • accessToken

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder accessToken(String 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: <code>java.lang.String</code> type. Group: common
      Parameters:
      accessToken - the value to set
      Returns:
      the dsl builder

    • authClient

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder authClient(String authClient)
      Filter admin events by authentication client ID. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      authClient - the value to set
      Returns:
      the dsl builder

    • authIpAddress

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder authIpAddress(String authIpAddress)
      Filter admin events by authentication IP address. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      authIpAddress - the value to set
      Returns:
      the dsl builder

    • authRealm

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder authRealm(String 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: <code>java.lang.String</code> type. Default: master Group: common
      Parameters:
      authRealm - the value to set
      Returns:
      the dsl builder

    • authRealmFilter

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder authRealmFilter(String authRealmFilter)
      Filter admin events by authentication realm. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      authRealmFilter - the value to set
      Returns:
      the dsl builder

    • authUser

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder authUser(String authUser)
      Filter admin events by authentication user ID. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      authUser - the value to set
      Returns:
      the dsl builder

    • client

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder client(String client)
      Filter events by client ID. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      client - the value to set
      Returns:
      the dsl builder

    • clientId

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder clientId(String clientId)
      Keycloak client ID. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      clientId - the value to set
      Returns:
      the dsl builder

    • clientSecret

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder clientSecret(String clientSecret)
      Keycloak client secret. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      clientSecret - the value to set
      Returns:
      the dsl builder

    • configuration

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder configuration(org.apache.camel.component.keycloak.KeycloakConfiguration configuration)
      Component configuration. The option is a: <code>org.apache.camel.component.keycloak.KeycloakConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • dateFrom

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder dateFrom(String dateFrom)
      Filter events by start date/time in milliseconds since epoch. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      dateFrom - the value to set
      Returns:
      the dsl builder

    • dateTo

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder dateTo(String dateTo)
      Filter events by end date/time in milliseconds since epoch. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      dateTo - the value to set
      Returns:
      the dsl builder

    • eventType

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder eventType(String eventType)
      Type of events to consume: events or admin-events. The option is a: <code>java.lang.String</code> type. Default: events Group: common
      Parameters:
      eventType - the value to set
      Returns:
      the dsl builder

    • first

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder first(int first)
      Offset for pagination (first result index). The option is a: <code>int</code> type. Group: common
      Parameters:
      first - the value to set
      Returns:
      the dsl builder

    • introspectionCacheEnabled

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder introspectionCacheEnabled(boolean introspectionCacheEnabled)
      Enable caching of token introspection results to reduce API calls to Keycloak. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      introspectionCacheEnabled - the value to set
      Returns:
      the dsl builder

    • introspectionCacheTtl

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder introspectionCacheTtl(long introspectionCacheTtl)
      Time-to-live for cached introspection results in seconds. The option is a: <code>long</code> type. Default: 60 Group: common
      Parameters:
      introspectionCacheTtl - the value to set
      Returns:
      the dsl builder

    • ipAddress

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder ipAddress(String ipAddress)
      Filter events by IP address. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      ipAddress - the value to set
      Returns:
      the dsl builder

    • keycloakClient

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder keycloakClient(org.keycloak.admin.client.Keycloak keycloakClient)
      To use an existing configured Keycloak admin client. The option is a: <code>org.keycloak.admin.client.Keycloak</code> type. Group: common
      Parameters:
      keycloakClient - the value to set
      Returns:
      the dsl builder

    • maxResults

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder maxResults(int maxResults)
      Maximum number of events to retrieve per poll. The option is a: <code>int</code> type. Default: 100 Group: common
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder

    • operation

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder operation(org.apache.camel.component.keycloak.KeycloakOperations operation)
      The operation to perform. The option is a: <code>org.apache.camel.component.keycloak.KeycloakOperations</code> type. Group: common
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • operationTypes

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

    • password

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder password(String password)
      Keycloak password. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • pojoRequest

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder pojoRequest(boolean pojoRequest)
      If we want to use a POJO request as body or not. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      pojoRequest - the value to set
      Returns:
      the dsl builder

    • realm

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder realm(String realm)
      Keycloak realm, the default is master because usually all the operations are done starting from the master realm. The option is a: <code>java.lang.String</code> type. Default: master Group: common
      Parameters:
      realm - the value to set
      Returns:
      the dsl builder

    • resourcePath

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder resourcePath(String resourcePath)
      Filter admin events by resource path. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      resourcePath - the value to set
      Returns:
      the dsl builder

    • serverUrl

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder serverUrl(String serverUrl)
      Keycloak server URL. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      serverUrl - the value to set
      Returns:
      the dsl builder

    • types

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

    • user

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder user(String user)
      Filter events by user ID. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      user - the value to set
      Returns:
      the dsl builder

    • username

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder username(String username)
      Keycloak username. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      username - the value to set
      Returns:
      the dsl builder

    • useTokenIntrospection

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder 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: <code>boolean</code> type. Default: false Group: common
      Parameters:
      useTokenIntrospection - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default KeycloakComponentBuilderFactory.KeycloakComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 KeycloakComponentBuilderFactory.KeycloakComponentBuilder 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 KeycloakComponentBuilderFactory.KeycloakComponentBuilder 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