org.keycloak.services.resources.admin.AdminEventBuilder クラス

org.keycloak.services.resources.admin.AdminEventBuilder 連携図

公開メンバ関数
	AdminEventBuilder (RealmModel realm, AdminAuth auth, KeycloakSession session, ClientConnection clientConnection)
AdminEventBuilder	realm (RealmModel realm)
AdminEventBuilder	realm (String realmId)
AdminEventBuilder	refreshRealmEventsConfig (KeycloakSession session)
AdminEventBuilder	operation (OperationType operationType)
AdminEventBuilder	resource (ResourceType resourceType)
AdminEventBuilder	authRealm (RealmModel realm)
AdminEventBuilder	authClient (ClientModel client)
AdminEventBuilder	authUser (UserModel user)
AdminEventBuilder	authIpAddress (String ipAddress)
AdminEventBuilder	resourcePath (String... pathElements)
AdminEventBuilder	resourcePath (UriInfo uriInfo)
AdminEventBuilder	resourcePath (UriInfo uriInfo, String id)
AdminEventBuilder	representation (Object value)
AdminEvent	getEvent ()
void	success ()

静的限定公開変数類
static final Logger	logger = Logger.getLogger(AdminEventBuilder.class)

非公開メンバ関数
AdminEventBuilder	updateStore (KeycloakSession session)
AdminEventBuilder	addListeners (KeycloakSession session)
String	getResourcePath (UriInfo uriInfo)
void	send ()

非公開変数類
EventStoreProvider	store
Map< String, EventListenerProvider >	listeners
RealmModel	realm
AdminEvent	adminEvent

詳解

構築子と解体子

AdminEventBuilder()

org.keycloak.services.resources.admin.AdminEventBuilder.AdminEventBuilder ( RealmModel  realm, AdminAuth  auth, KeycloakSession  session, ClientConnection  clientConnection  )

inline

                                                                                                                           {
        this.realm = realm;
        adminEvent = new AdminEvent();

        this.listeners = new HashMap<>();
        updateStore(session);
        addListeners(session);

        authRealm(auth.getRealm());
        authClient(auth.getClient());
        authUser(auth.getUser());
        authIpAddress(clientConnection.getRemoteAddr());
    }

関数詳解

addListeners()

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.addListeners ( KeycloakSession  session )

inlineprivate

                                                                    {
        Set<String> extraListeners = realm.getEventsListeners();
        if (extraListeners != null && !extraListeners.isEmpty()) {
            for (String id : extraListeners) {
                if (!listeners.containsKey(id)) {
                    EventListenerProvider listener = session.getProvider(EventListenerProvider.class, id);
                    if (listener != null) {
                        listeners.put(id, listener);
                    } else {
                        ServicesLogger.LOGGER.providerNotFound(id);
                    }
                }
            }
        }
        return this;
    }

authClient()

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.authClient ( ClientModel  client )

inline

                                                            {
        AuthDetails authDetails = adminEvent.getAuthDetails();
        if(authDetails == null) {
            authDetails =  new AuthDetails();
            authDetails.setClientId(client.getId());
        } else {
            authDetails.setClientId(client.getId());
        }
        adminEvent.setAuthDetails(authDetails);
        return this;
    }

authIpAddress()

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.authIpAddress ( String  ipAddress )

inline

                                                             {
        AuthDetails authDetails = adminEvent.getAuthDetails();
        if(authDetails == null) {
            authDetails =  new AuthDetails();
            authDetails.setIpAddress(ipAddress);
        } else {
            authDetails.setIpAddress(ipAddress);
        }
        adminEvent.setAuthDetails(authDetails);
        return this;
    }

authRealm()

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.authRealm ( RealmModel  realm )

inline

                                                         {
        AuthDetails authDetails = adminEvent.getAuthDetails();
        if(authDetails == null) {
            authDetails =  new AuthDetails();
            authDetails.setRealmId(realm.getId());
        } else {
            authDetails.setRealmId(realm.getId());
        }
        adminEvent.setAuthDetails(authDetails);
        return this;
    }

authUser()

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.authUser ( UserModel  user )

inline

                                                      {
        AuthDetails authDetails = adminEvent.getAuthDetails();
        if(authDetails == null) {
            authDetails =  new AuthDetails();
            authDetails.setUserId(user.getId());
        } else {
            authDetails.setUserId(user.getId());
        }
        adminEvent.setAuthDetails(authDetails);
        return this;
    }

getEvent()

AdminEvent org.keycloak.services.resources.admin.AdminEventBuilder.getEvent ( )

inline

                                 {
        return adminEvent;
    }

getResourcePath()

String org.keycloak.services.resources.admin.AdminEventBuilder.getResourcePath ( UriInfo  uriInfo )

inlineprivate

                                                    {
        String path = uriInfo.getPath();

        StringBuilder sb = new StringBuilder();
        sb.append("/realms/");
        sb.append(realm.getName());
        sb.append("/");
        String realmRelative = sb.toString();

        return path.substring(path.indexOf(realmRelative) + realmRelative.length());
    }

operation()

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.operation ( OperationType  operationType )

inline

                                                                    {
        adminEvent.setOperationType(operationType);
        return this;
    }

realm() [1/2]

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.realm ( RealmModel  realm )

inline

                                                     {
        adminEvent.setRealmId(realm.getId());
        return this;
    }

realm() [2/2]

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.realm ( String  realmId )

inline

                                                   {
        adminEvent.setRealmId(realmId);
        return this;
    }

refreshRealmEventsConfig()

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.refreshRealmEventsConfig ( KeycloakSession  session )

inline

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.

引数

session

The session

戻り値

The same builder

                                                                               {
        return this.updateStore(session).addListeners(session);
    }

representation()

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.representation ( Object  value )

inline

                                                          {
        if (value == null || value.equals("")) {
            return this;
        }
        try {
            adminEvent.setRepresentation(JsonSerialization.writeValueAsString(value));
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return this;
    }

resource()

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.resource ( ResourceType  resourceType )

inline

                                                                {
        adminEvent.setResourceType(resourceType);
        return this;
    }

resourcePath() [1/3]

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.resourcePath ( String...  pathElements )

inline

                                                                  {
        StringBuilder sb = new StringBuilder();
        for (String element : pathElements) {
            sb.append("/");
            sb.append(element);
        }
        if (pathElements.length > 0) sb.deleteCharAt(0); // remove leading '/'

        adminEvent.setResourcePath(sb.toString());
        return this;
    }

resourcePath() [2/3]

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.resourcePath ( UriInfo  uriInfo )

inline

                                                           {
        String path = getResourcePath(uriInfo);
        adminEvent.setResourcePath(path);
        return this;
    }

resourcePath() [3/3]

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.resourcePath ( UriInfo  uriInfo, String  id  )

inline

                                                                      {
        StringBuilder sb = new StringBuilder();
        sb.append(getResourcePath(uriInfo));
        sb.append("/");
        sb.append(id);
        adminEvent.setResourcePath(sb.toString());
        return this;
    }

send()

void org.keycloak.services.resources.admin.AdminEventBuilder.send ( )

inlineprivate

                        {
        boolean includeRepresentation = false;
        if(realm.isAdminEventsDetailsEnabled()) {
            includeRepresentation = true;
        }
        adminEvent.setTime(Time.toMillis(Time.currentTime()));

        if (store != null) {
            try {
                store.onEvent(adminEvent, includeRepresentation);
            } catch (Throwable t) {
                ServicesLogger.LOGGER.failedToSaveEvent(t);
            }
        }

        if (listeners != null) {
            for (EventListenerProvider l : listeners.values()) {
                try {
                    l.onEvent(adminEvent, includeRepresentation);
                } catch (Throwable t) {
                    ServicesLogger.LOGGER.failedToSendType(t, l);
                }
            }
        }
    }

success()

void org.keycloak.services.resources.admin.AdminEventBuilder.success ( )

inline

                          {
        send();
    }

updateStore()

AdminEventBuilder org.keycloak.services.resources.admin.AdminEventBuilder.updateStore ( KeycloakSession  session )

inlineprivate

                                                                   {
        if (realm.isAdminEventsEnabled() && store == null) {
            this.store = session.getProvider(EventStoreProvider.class);
            if (store == null) {
                ServicesLogger.LOGGER.noEventStoreProvider();
            }
        }
        return this;
    }

メンバ詳解

adminEvent

AdminEvent org.keycloak.services.resources.admin.AdminEventBuilder.adminEvent

private

listeners

Map<String, EventListenerProvider> org.keycloak.services.resources.admin.AdminEventBuilder.listeners

private

logger

final Logger org.keycloak.services.resources.admin.AdminEventBuilder.logger = Logger.getLogger(AdminEventBuilder.class)

staticprotected

realm

RealmModel org.keycloak.services.resources.admin.AdminEventBuilder.realm

private

store

EventStoreProvider org.keycloak.services.resources.admin.AdminEventBuilder.store

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/resources/admin/AdminEventBuilder.java