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

Interface KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

KeycloakEndpointBuilderFactory.KeycloakEndpointBuilder

Enclosing interface:

KeycloakEndpointBuilderFactory

public static interface KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Keycloak component.

Method Summary

Modifier and Type	Method	Description
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	accessToken(String accessToken)	Pre-obtained access token for authentication.
default KeycloakEndpointBuilderFactory.AdvancedKeycloakEndpointProducerBuilder	advanced()
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	authClient(String authClient)	Filter admin events by authentication client ID.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	authIpAddress(String authIpAddress)	Filter admin events by authentication IP address.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	authRealm(String authRealm)	Keycloak realm to authenticate against.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	authRealmFilter(String authRealmFilter)	Filter admin events by authentication realm.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	authUser(String authUser)	Filter admin events by authentication user ID.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	client(String client)	Filter events by client ID.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	clientId(String clientId)	Keycloak client ID.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	clientSecret(String clientSecret)	Keycloak client secret.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	dateFrom(String dateFrom)	Filter events by start date/time in milliseconds since epoch.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	dateTo(String dateTo)	Filter events by end date/time in milliseconds since epoch.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	eventType(String eventType)	Type of events to consume: events or admin-events.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	first(int first)	Offset for pagination (first result index).
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	first(String first)	Offset for pagination (first result index).
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	introspectionCacheEnabled(boolean introspectionCacheEnabled)	Enable caching of token introspection results to reduce API calls to Keycloak.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	introspectionCacheEnabled(String introspectionCacheEnabled)	Enable caching of token introspection results to reduce API calls to Keycloak.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	introspectionCacheTtl(long introspectionCacheTtl)	Time-to-live for cached introspection results in seconds.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	introspectionCacheTtl(String introspectionCacheTtl)	Time-to-live for cached introspection results in seconds.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	ipAddress(String ipAddress)	Filter events by IP address.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	keycloakClient(String keycloakClient)	To use an existing configured Keycloak admin client.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	keycloakClient(org.keycloak.admin.client.Keycloak keycloakClient)	To use an existing configured Keycloak admin client.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	maxResults(int maxResults)	Maximum number of events to retrieve per poll.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	maxResults(String maxResults)	Maximum number of events to retrieve per poll.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	operation(String operation)	The operation to perform.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	operation(org.apache.camel.component.keycloak.KeycloakOperations operation)	The operation to perform.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	operationTypes(String operationTypes)	Filter admin events by operation types (comma-separated list, e.g., CREATE,UPDATE,DELETE).
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	password(String password)	Keycloak password.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	pojoRequest(boolean pojoRequest)	If we want to use a POJO request as body or not.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	pojoRequest(String pojoRequest)	If we want to use a POJO request as body or not.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	realm(String realm)	Keycloak realm, the default is master because usually all the operations are done starting from the master realm.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	resourcePath(String resourcePath)	Filter admin events by resource path.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	serverUrl(String serverUrl)	Keycloak server URL.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	types(String types)	Filter events by event types (comma-separated list, e.g., LOGIN,LOGOUT).
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	user(String user)	Filter events by user ID.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	username(String username)	Keycloak username.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	useTokenIntrospection(boolean useTokenIntrospection)	Enable OAuth 2.0 token introspection for real-time token validation.
default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder	useTokenIntrospection(String useTokenIntrospection)	Enable OAuth 2.0 token introspection for real-time token validation.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Details

advanced

default KeycloakEndpointBuilderFactory.AdvancedKeycloakEndpointProducerBuilder advanced()

accessToken

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder 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: java.lang.String type. Group: common

Parameters:

accessToken - the value to set

Returns:

the dsl builder

authClient

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder authClient(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder authIpAddress(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder 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: java.lang.String type. Default: master Group: common

Parameters:

authRealm - the value to set

Returns:

the dsl builder

authRealmFilter

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder authRealmFilter(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder authUser(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder client(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder clientId(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder clientSecret(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder dateFrom(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder dateTo(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder eventType(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder first(int 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder first(String 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.KeycloakEndpointProducerBuilder 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.KeycloakEndpointProducerBuilder 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.KeycloakEndpointProducerBuilder 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.KeycloakEndpointProducerBuilder 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder ipAddress(String 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.KeycloakEndpointProducerBuilder 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder keycloakClient(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder maxResults(int 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder maxResults(String 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.KeycloakEndpointProducerBuilder 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder operation(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder operationTypes(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder password(String 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.KeycloakEndpointProducerBuilder 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder pojoRequest(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder 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: java.lang.String type. Default: master Group: common

Parameters:

realm - the value to set

Returns:

the dsl builder

resourcePath

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder resourcePath(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder serverUrl(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder types(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder user(String 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

default KeycloakEndpointBuilderFactory.KeycloakEndpointProducerBuilder username(String 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.KeycloakEndpointProducerBuilder 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.KeycloakEndpointProducerBuilder 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