Interface KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder,org.apache.camel.EndpointConsumerResolver,org.apache.camel.builder.EndpointProducerBuilder,org.apache.camel.EndpointProducerResolver,KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder,KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder
- Enclosing interface:
KeycloakEndpointBuilderFactory
public static interface KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder
extends KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder, KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder
Builder for endpoint for the Keycloak component.
-
Method Summary
Modifier and TypeMethodDescriptionaccessToken(String accessToken) Pre-obtained access token for authentication.advanced()authClient(String authClient) Filter admin events by authentication client ID.authIpAddress(String authIpAddress) Filter admin events by authentication IP address.Keycloak realm to authenticate against.authRealmFilter(String authRealmFilter) Filter admin events by authentication realm.Filter admin events by authentication user ID.Filter events by client ID.Keycloak client ID.clientSecret(String clientSecret) Keycloak client secret.Filter events by start date/time in milliseconds since epoch.Filter events by end date/time in milliseconds since epoch.Type of events to consume: events or admin-events.first(int first) Offset for pagination (first result index).Offset for pagination (first result index).introspectionCacheEnabled(boolean introspectionCacheEnabled) Enable caching of token introspection results to reduce API calls to Keycloak.introspectionCacheEnabled(String introspectionCacheEnabled) Enable caching of token introspection results to reduce API calls to Keycloak.introspectionCacheTtl(long introspectionCacheTtl) Time-to-live for cached introspection results in seconds.introspectionCacheTtl(String introspectionCacheTtl) Time-to-live for cached introspection results in seconds.Filter events by IP address.keycloakClient(String keycloakClient) To use an existing configured Keycloak admin client.keycloakClient(org.keycloak.admin.client.Keycloak keycloakClient) To use an existing configured Keycloak admin client.maxResults(int maxResults) Maximum number of events to retrieve per poll.maxResults(String maxResults) Maximum number of events to retrieve per poll.The operation to perform.operation(org.apache.camel.component.keycloak.KeycloakOperations operation) The operation to perform.operationTypes(String operationTypes) Filter admin events by operation types (comma-separated list, e.g., CREATE,UPDATE,DELETE).Keycloak password.pojoRequest(boolean pojoRequest) If we want to use a POJO request as body or not.pojoRequest(String pojoRequest) If we want to use a POJO request as body or not.Keycloak realm, the default is master because usually all the operations are done starting from the master realm.resourcePath(String resourcePath) Filter admin events by resource path.Keycloak server URL.Filter events by event types (comma-separated list, e.g., LOGIN,LOGOUT).Filter events by user ID.Keycloak username.useTokenIntrospection(boolean useTokenIntrospection) Enable OAuth 2.0 token introspection for real-time token validation.useTokenIntrospection(String useTokenIntrospection) Enable OAuth 2.0 token introspection for real-time token validation.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUriMethods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolveMethods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUriMethods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolveMethods inherited from interface org.apache.camel.builder.endpoint.dsl.KeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder
backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, greedy, greedy, initialDelay, initialDelay, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay
-
Method Details
-
advanced
- Specified by:
advancedin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
advancedin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder
-
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.Stringtype. Group: common- Specified by:
accessTokenin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
accessTokenin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
accessToken- the value to set- Returns:
- the dsl builder
-
authClient
Filter admin events by authentication client ID. The option is a:java.lang.Stringtype. Group: common- Specified by:
authClientin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
authClientin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
authClient- the value to set- Returns:
- the dsl builder
-
authIpAddress
Filter admin events by authentication IP address. The option is a:java.lang.Stringtype. Group: common- Specified by:
authIpAddressin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
authIpAddressin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- 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.Stringtype. Default: master Group: common- Specified by:
authRealmin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
authRealmin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
authRealm- the value to set- Returns:
- the dsl builder
-
authRealmFilter
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder authRealmFilter(String authRealmFilter) Filter admin events by authentication realm. The option is a:java.lang.Stringtype. Group: common- Specified by:
authRealmFilterin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
authRealmFilterin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
authRealmFilter- the value to set- Returns:
- the dsl builder
-
authUser
Filter admin events by authentication user ID. The option is a:java.lang.Stringtype. Group: common- Specified by:
authUserin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
authUserin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
authUser- the value to set- Returns:
- the dsl builder
-
client
Filter events by client ID. The option is a:java.lang.Stringtype. Group: common- Specified by:
clientin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
clientin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
client- the value to set- Returns:
- the dsl builder
-
clientId
Keycloak client ID. The option is a:java.lang.Stringtype. Group: common- Specified by:
clientIdin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
clientIdin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
clientId- the value to set- Returns:
- the dsl builder
-
clientSecret
Keycloak client secret. The option is a:java.lang.Stringtype. Group: common- Specified by:
clientSecretin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
clientSecretin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- 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.Stringtype. Group: common- Specified by:
dateFromin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
dateFromin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- 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.Stringtype. Group: common- Specified by:
dateToin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
dateToin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- 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.Stringtype. Default: events Group: common- Specified by:
eventTypein interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
eventTypein interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
eventType- the value to set- Returns:
- the dsl builder
-
first
Offset for pagination (first result index). The option is a:inttype. Default: 0 Group: common- Specified by:
firstin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
firstin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
first- the value to set- Returns:
- the dsl builder
-
first
Offset for pagination (first result index). The option will be converted to ainttype. Default: 0 Group: common- Specified by:
firstin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
firstin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
first- the value to set- Returns:
- the dsl builder
-
introspectionCacheEnabled
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder introspectionCacheEnabled(boolean introspectionCacheEnabled) Enable caching of token introspection results to reduce API calls to Keycloak. The option is a:booleantype. Default: true Group: common- Specified by:
introspectionCacheEnabledin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
introspectionCacheEnabledin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
introspectionCacheEnabled- the value to set- Returns:
- the dsl builder
-
introspectionCacheEnabled
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder introspectionCacheEnabled(String introspectionCacheEnabled) Enable caching of token introspection results to reduce API calls to Keycloak. The option will be converted to abooleantype. Default: true Group: common- Specified by:
introspectionCacheEnabledin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
introspectionCacheEnabledin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
introspectionCacheEnabled- the value to set- Returns:
- the dsl builder
-
introspectionCacheTtl
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder introspectionCacheTtl(long introspectionCacheTtl) Time-to-live for cached introspection results in seconds. The option is a:longtype. Default: 60 Group: common- Specified by:
introspectionCacheTtlin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
introspectionCacheTtlin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
introspectionCacheTtl- the value to set- Returns:
- the dsl builder
-
introspectionCacheTtl
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder introspectionCacheTtl(String introspectionCacheTtl) Time-to-live for cached introspection results in seconds. The option will be converted to alongtype. Default: 60 Group: common- Specified by:
introspectionCacheTtlin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
introspectionCacheTtlin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
introspectionCacheTtl- the value to set- Returns:
- the dsl builder
-
ipAddress
Filter events by IP address. The option is a:java.lang.Stringtype. Group: common- Specified by:
ipAddressin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
ipAddressin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
ipAddress- the value to set- Returns:
- the dsl builder
-
keycloakClient
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder keycloakClient(org.keycloak.admin.client.Keycloak keycloakClient) To use an existing configured Keycloak admin client. The option is a:org.keycloak.admin.client.Keycloaktype. Group: common- Specified by:
keycloakClientin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
keycloakClientin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
keycloakClient- the value to set- Returns:
- the dsl builder
-
keycloakClient
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder keycloakClient(String keycloakClient) To use an existing configured Keycloak admin client. The option will be converted to aorg.keycloak.admin.client.Keycloaktype. Group: common- Specified by:
keycloakClientin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
keycloakClientin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
keycloakClient- the value to set- Returns:
- the dsl builder
-
maxResults
Maximum number of events to retrieve per poll. The option is a:inttype. Default: 100 Group: common- Specified by:
maxResultsin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
maxResultsin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- 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 ainttype. Default: 100 Group: common- Specified by:
maxResultsin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
maxResultsin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
maxResults- the value to set- Returns:
- the dsl builder
-
operation
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder operation(org.apache.camel.component.keycloak.KeycloakOperations operation) The operation to perform. The option is a:org.apache.camel.component.keycloak.KeycloakOperationstype. Group: common- Specified by:
operationin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
operationin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
operation- the value to set- Returns:
- the dsl builder
-
operation
The operation to perform. The option will be converted to aorg.apache.camel.component.keycloak.KeycloakOperationstype. Group: common- Specified by:
operationin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
operationin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
operation- the value to set- Returns:
- the dsl builder
-
operationTypes
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder operationTypes(String operationTypes) Filter admin events by operation types (comma-separated list, e.g., CREATE,UPDATE,DELETE). The option is a:java.lang.Stringtype. Group: common- Specified by:
operationTypesin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
operationTypesin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
operationTypes- the value to set- Returns:
- the dsl builder
-
password
Keycloak password. The option is a:java.lang.Stringtype. Group: common- Specified by:
passwordin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
passwordin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
password- the value to set- Returns:
- the dsl builder
-
pojoRequest
If we want to use a POJO request as body or not. The option is a:booleantype. Default: false Group: common- Specified by:
pojoRequestin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
pojoRequestin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- 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 abooleantype. Default: false Group: common- Specified by:
pojoRequestin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
pojoRequestin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- 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.Stringtype. Default: master Group: common- Specified by:
realmin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
realmin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
realm- the value to set- Returns:
- the dsl builder
-
resourcePath
Filter admin events by resource path. The option is a:java.lang.Stringtype. Group: common- Specified by:
resourcePathin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
resourcePathin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
resourcePath- the value to set- Returns:
- the dsl builder
-
serverUrl
Keycloak server URL. The option is a:java.lang.Stringtype. Group: common- Specified by:
serverUrlin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
serverUrlin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- 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.Stringtype. Group: common- Specified by:
typesin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
typesin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
types- the value to set- Returns:
- the dsl builder
-
user
Filter events by user ID. The option is a:java.lang.Stringtype. Group: common- Specified by:
userin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
userin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
user- the value to set- Returns:
- the dsl builder
-
username
Keycloak username. The option is a:java.lang.Stringtype. Group: common- Specified by:
usernamein interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
usernamein interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
username- the value to set- Returns:
- the dsl builder
-
useTokenIntrospection
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder 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:booleantype. Default: false Group: common- Specified by:
useTokenIntrospectionin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
useTokenIntrospectionin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
useTokenIntrospection- the value to set- Returns:
- the dsl builder
-
useTokenIntrospection
default KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder 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 abooleantype. Default: false Group: common- Specified by:
useTokenIntrospectionin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointConsumerBuilder- Specified by:
useTokenIntrospectionin interfaceKeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder- Parameters:
useTokenIntrospection- the value to set- Returns:
- the dsl builder
-