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 static final org.jboss.logging.Logger	logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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()
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)
void	success()

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

Constructor Details

AdminEventBuilder

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

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

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)

representation

public AdminEventBuilder representation(Object value)

detail

public AdminEventBuilder detail(String key,
 String value)

getEvent

public AdminEvent getEvent()

success

public void success()