Package org.keycloak.services.resources.admin

Class AdminEventBuilder

java.lang.Object
org.keycloak.services.resources.admin.AdminEventBuilder
public class AdminEventBuilder extends Object

  • Field Details

    • logger

      protected static final org.jboss.logging.Logger logger

    • auth

      protected final AdminAuth auth

    • ipAddress

      protected final String ipAddress

    • realm

      protected final org.keycloak.models.RealmModel realm

    • adminEvent

      protected final org.keycloak.events.admin.AdminEvent adminEvent

    • listeners

      protected final Map<String,org.keycloak.events.EventListenerProvider> listeners

    • session

      protected final org.keycloak.models.KeycloakSession session

    • store

      protected org.keycloak.events.EventStoreProvider store

  • Constructor Details

    • AdminEventBuilder

      public AdminEventBuilder(org.keycloak.models.RealmModel realm, AdminAuth auth, org.keycloak.models.KeycloakSession session, org.keycloak.common.ClientConnection clientConnection)

    • AdminEventBuilder

      protected AdminEventBuilder(org.keycloak.models.RealmModel realm, AdminAuth auth, org.keycloak.models.KeycloakSession session, String ipAddress, org.keycloak.events.admin.AdminEvent adminEvent)

  • Method Details

    • clone

      public AdminEventBuilder clone(org.keycloak.models.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(org.keycloak.models.RealmModel realm)

    • refreshRealmEventsConfig

      public AdminEventBuilder refreshRealmEventsConfig(org.keycloak.models.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(org.keycloak.models.KeycloakSession session)

    • addListeners

      protected AdminEventBuilder addListeners(org.keycloak.models.KeycloakSession session)

    • operation

      public AdminEventBuilder operation(org.keycloak.events.admin.OperationType operationType)

    • resource

      public AdminEventBuilder resource(org.keycloak.events.admin.ResourceType resourceType)

    • resource

      public AdminEventBuilder resource(String resourceType)
      Setter for custom resource types with values different from ResourceType.

    • authRealm

      public AdminEventBuilder authRealm(org.keycloak.models.RealmModel realm)

    • authClient

      public AdminEventBuilder authClient(org.keycloak.models.ClientModel client)

    • authUser

      public AdminEventBuilder authUser(org.keycloak.models.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 org.keycloak.events.admin.AdminEvent getEvent()

    • success

      public void success()

    • send

      protected void send()