Package org.keycloak.services.resources.admin

Class AdminEventBuilder

java.lang.Object

org.keycloak.services.resources.admin.AdminEventBuilder

public class AdminEventBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final AdminEvent	adminEvent
protected final AdminAuth	auth
protected final String	ipAddress
protected final Map<String,EventListenerProvider>	listeners
protected static final org.jboss.logging.Logger	logger
protected final RealmModel	realm
protected final KeycloakSession	session
protected EventStoreProvider	store

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AdminEventBuilder(RealmModel realm, AdminAuth auth, KeycloakSession session, String ipAddress, AdminEvent adminEvent)
	AdminEventBuilder(RealmModel realm, AdminAuth auth, KeycloakSession session, ClientConnection clientConnection)

Method Summary

Modifier and Type	Method	Description
protected AdminEventBuilder	addListeners(KeycloakSession session)
AdminEventBuilder	authClient(ClientModel client)
AdminEventBuilder	authIpAddress(String ipAddress)
AdminEventBuilder	authRealm(RealmModel realm)
AdminEventBuilder	authUser(UserModel user)
AdminEventBuilder	clone(KeycloakSession session)	Create a new instance of the AdminEventBuilder that is bound to a new session.
AdminEventBuilder	detail(String key, String value)
AdminEvent	getEvent()
protected String	getResourcePath(jakarta.ws.rs.core.UriInfo uriInfo)
AdminEventBuilder	operation(OperationType operationType)
AdminEventBuilder	realm(RealmModel realm)
AdminEventBuilder	refreshRealmEventsConfig(KeycloakSession session)	Refreshes the builder assuming that the realm event information has changed.
AdminEventBuilder	representation(Object value)
AdminEventBuilder	resource(String resourceType)	Setter for custom resource types with values different from ResourceType.
AdminEventBuilder	resource(ResourceType resourceType)
AdminEventBuilder	resourcePath(jakarta.ws.rs.core.UriInfo uriInfo)
AdminEventBuilder	resourcePath(jakarta.ws.rs.core.UriInfo uriInfo, String id)
AdminEventBuilder	resourcePath(String... pathElements)
protected void	send()
protected void	stripSecretsFromRepresentation(Object value)
void	success()
protected AdminEventBuilder	updateStore(KeycloakSession session)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

protected static final org.jboss.logging.Logger logger

auth

protected final AdminAuth auth

ipAddress

protected final String ipAddress

realm

protected final RealmModel realm

adminEvent

protected final AdminEvent adminEvent

listeners

protected final Map<String,EventListenerProvider> listeners

session

protected final KeycloakSession session

store

protected EventStoreProvider store

Constructor Details

AdminEventBuilder

public AdminEventBuilder(RealmModel realm,
 AdminAuth auth,
 KeycloakSession session,
 ClientConnection clientConnection)

AdminEventBuilder

protected AdminEventBuilder(RealmModel realm,
 AdminAuth auth,
 KeycloakSession session,
 String ipAddress,
 AdminEvent adminEvent)

Method Details

clone

public AdminEventBuilder clone(KeycloakSession session)

Create a new instance of the AdminEventBuilder that is bound to a new session. Use this when starting, for example, a nested transaction.

Parameters:

session - new session where the AdminEventBuilder should be bound to.

Returns:

a new instance of AdminEventBuilder

realm

public AdminEventBuilder realm(RealmModel realm)

refreshRealmEventsConfig

public AdminEventBuilder refreshRealmEventsConfig(KeycloakSession session)

Refreshes the builder assuming that the realm event information has changed. Thought to be used when the updateRealmEventsConfig has modified the events configuration. Now the store and the listeners are updated to have previous and new setup.

Parameters:

session - The session

Returns:

The same builder

updateStore

protected AdminEventBuilder updateStore(KeycloakSession session)

addListeners

protected AdminEventBuilder addListeners(KeycloakSession session)

operation

public AdminEventBuilder operation(OperationType operationType)

resource

public AdminEventBuilder resource(ResourceType resourceType)

resource

public AdminEventBuilder resource(String resourceType)

Setter for custom resource types with values different from ResourceType.

authRealm

public AdminEventBuilder authRealm(RealmModel realm)

authClient

public AdminEventBuilder authClient(ClientModel client)

authUser

public AdminEventBuilder authUser(UserModel user)

authIpAddress

public AdminEventBuilder authIpAddress(String ipAddress)

resourcePath

public AdminEventBuilder resourcePath(String... pathElements)

resourcePath

public AdminEventBuilder resourcePath(jakarta.ws.rs.core.UriInfo uriInfo)

resourcePath

public AdminEventBuilder resourcePath(jakarta.ws.rs.core.UriInfo uriInfo,
 String id)

getResourcePath

protected String getResourcePath(jakarta.ws.rs.core.UriInfo uriInfo)

representation

public AdminEventBuilder representation(Object value)

stripSecretsFromRepresentation

protected void stripSecretsFromRepresentation(Object value)

detail

public AdminEventBuilder detail(String key,
 String value)

getEvent

public AdminEvent getEvent()

success

public void success()

send

protected void send()