org.keycloak.events.EventBuilder クラス

org.keycloak.events.EventBuilder 連携図

公開メンバ関数
	EventBuilder (RealmModel realm, KeycloakSession session, ClientConnection clientConnection)
EventBuilder	realm (RealmModel realm)
EventBuilder	realm (String realmId)
EventBuilder	client (ClientModel client)
EventBuilder	client (String clientId)
EventBuilder	user (UserModel user)
EventBuilder	user (String userId)
EventBuilder	session (UserSessionModel session)
EventBuilder	session (String sessionId)
EventBuilder	ipAddress (String ipAddress)
EventBuilder	event (EventType e)
EventBuilder	detail (String key, String value)
EventBuilder	removeDetail (String key)
Event	getEvent ()
void	success ()
void	error (String error)
EventBuilder	clone ()

非公開メンバ関数
	EventBuilder (EventStoreProvider store, List< EventListenerProvider > listeners, RealmModel realm, Event event)
void	send ()

非公開変数類
EventStoreProvider	store
List< EventListenerProvider >	listeners
RealmModel	realm
Event	event

静的非公開変数類
static final Logger	log = Logger.getLogger(EventBuilder.class)

詳解

著者

Stian Thorgersen

構築子と解体子

EventBuilder() [1/2]

org.keycloak.events.EventBuilder.EventBuilder ( RealmModel  realm, KeycloakSession  session, ClientConnection  clientConnection  )

inline

                                                                                                      {
        this.realm = realm;

        event = new Event();

        if (realm.isEventsEnabled()) {
            EventStoreProvider store = session.getProvider(EventStoreProvider.class);
            if (store != null) {
                this.store = store;
            } else {
                log.error("Events enabled, but no event store provider configured");
            }
        }

        if (realm.getEventsListeners() != null && !realm.getEventsListeners().isEmpty()) {
            this.listeners = new LinkedList<>();
            for (String id : realm.getEventsListeners()) {
                EventListenerProvider listener = session.getProvider(EventListenerProvider.class, id);
                if (listener != null) {
                    listeners.add(listener);
                } else {
                    log.error("Event listener '" + id + "' registered, but provider not found");
                }
            }
        }

        realm(realm);
        ipAddress(clientConnection.getRemoteAddr());
    }

EventBuilder() [2/2]

org.keycloak.events.EventBuilder.EventBuilder ( EventStoreProvider  store, List< EventListenerProvider >  listeners, RealmModel  realm, Event  event  )

inlineprivate

                                                                                                                         {
        this.store = store;
        this.listeners = listeners;
        this.realm = realm;
        this.event = event;
    }

関数詳解

client() [1/2]

EventBuilder org.keycloak.events.EventBuilder.client ( ClientModel  client )

inline

                                                   {
        event.setClientId(client == null ? null : client.getClientId());
        return this;
    }

client() [2/2]

EventBuilder org.keycloak.events.EventBuilder.client ( String  clientId )

inline

                                                {
        event.setClientId(clientId);
        return this;
    }

clone()

EventBuilder org.keycloak.events.EventBuilder.clone ( )

inline

                                {
        return new EventBuilder(store, listeners, realm, event.clone());
    }

detail()

EventBuilder org.keycloak.events.EventBuilder.detail ( String  key, String  value  )

inline

                                                         {
        if (value == null || value.equals("")) {
            return this;
        }

        if (event.getDetails() == null) {
            event.setDetails(new HashMap<String, String>());
        }
        event.getDetails().put(key, value);
        return this;
    }

error()

void org.keycloak.events.EventBuilder.error ( String  error )

inline

                                    {
        if (Objects.isNull(event.getType())) {
            throw new IllegalStateException("Attempted to define event error without first setting the event type");
        }

        if (!event.getType().name().endsWith("_ERROR")) {
            event.setType(EventType.valueOf(event.getType().name() + "_ERROR"));
        }
        event.setError(error);
        send();
    }

event()

EventBuilder org.keycloak.events.EventBuilder.event ( EventType  e )

inline

                                           {
        event.setType(e);
        return this;
    }

getEvent()

Event org.keycloak.events.EventBuilder.getEvent ( )

inline

                            {
        return event;
    }

ipAddress()

EventBuilder org.keycloak.events.EventBuilder.ipAddress ( String  ipAddress )

inline

                                                    {
        event.setIpAddress(ipAddress);
        return this;
    }

realm() [1/2]

EventBuilder org.keycloak.events.EventBuilder.realm ( RealmModel  realm )

inline

                                                {
        event.setRealmId(realm == null ? null : realm.getId());
        return this;
    }

realm() [2/2]

EventBuilder org.keycloak.events.EventBuilder.realm ( String  realmId )

inline

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

removeDetail()

EventBuilder org.keycloak.events.EventBuilder.removeDetail ( String  key )

inline

                                                 {
        if (event.getDetails() != null) {
            event.getDetails().remove(key);
        }
        return this;
    }

send()

void org.keycloak.events.EventBuilder.send ( )

inlineprivate

                        {
        event.setTime(Time.currentTimeMillis());

        if (store != null) {
            if (realm.getEnabledEventTypes() != null && !realm.getEnabledEventTypes().isEmpty() ? realm.getEnabledEventTypes().contains(event.getType().name()) : event.getType().isSaveByDefault()) {
                try {
                    store.onEvent(event);
                } catch (Throwable t) {
                    log.error("Failed to save event", t);
                }
            }
        }

        if (listeners != null) {
            for (EventListenerProvider l : listeners) {
                try {
                    l.onEvent(event);
                } catch (Throwable t) {
                    log.error("Failed to send type to " + l, t);
                }
            }
        }
    }

session() [1/2]

EventBuilder org.keycloak.events.EventBuilder.session ( UserSessionModel  session )

inline

                                                          {
        event.setSessionId(session == null ? null : session.getId());
        return this;
    }

session() [2/2]

EventBuilder org.keycloak.events.EventBuilder.session ( String  sessionId )

inline

                                                  {
        event.setSessionId(sessionId);
        return this;
    }

success()

void org.keycloak.events.EventBuilder.success ( )

inline

                          {
        send();
    }

user() [1/2]

EventBuilder org.keycloak.events.EventBuilder.user ( UserModel  user )

inline

                                             {
        event.setUserId(user == null ? null : user.getId());
        return this;
    }

user() [2/2]

EventBuilder org.keycloak.events.EventBuilder.user ( String  userId )

inline

                                            {
        event.setUserId(userId);
        return this;
    }

メンバ詳解

event

Event org.keycloak.events.EventBuilder.event

private

listeners

List<EventListenerProvider> org.keycloak.events.EventBuilder.listeners

private

log

final Logger org.keycloak.events.EventBuilder.log = Logger.getLogger(EventBuilder.class)

staticprivate

realm

RealmModel org.keycloak.events.EventBuilder.realm

private

store

EventStoreProvider org.keycloak.events.EventBuilder.store

private

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/events/EventBuilder.java