Interface Event

All Superinterfaces:
SerializableAsMap
All Known Subinterfaces:
AuditableEvent, GraphQLEvent, UserManagementGraphQLEvent
All Known Implementing Classes:
AccessTokenAuthenticationEvent, AccessTokenOAuthEvent, AccountCreatedGraphQLEvent, AccountCreatedScimEvent, AccountDeletedGraphQLEvent, AccountDeletedScimEvent, AccountEvent, AccountReadGraphQLEvent, AccountReadScimEvent, AccountSearchScimEvent, AccountUpdatedGraphQLEvent, AccountUpdatedScimEvent, ActivatedAccountEvent, AuthenticationAttemptEvent, AuthenticationEvent, AuthorizationCodeOAuthEvent, BackchannelAuthenticationEvent, ClientAuthenticationEvent, ConfigurationChangedSystemEvent, ConsentorCompleteOAuthEvent, ConsentorCompleteOAuthEvent.Success, ConsentorCompleteOAuthEvent.Unsuccessful, ConsumedAuthorizationCodeOAuthEvent, ConsumedDeviceCodeOAuthEvent, ConsumedInitialAccessTokenDcrOAuthEvent, CreatedAccountEvent, CreatedDeviceEvent, CreatedSsoSessionEvent, CredentialManagerEvent, DelegationOauthEvent, DeletedDeviceEvent, DeniedIntrospectionOAuthEvent, DeviceCodeOAuthEvent, DeviceEvent, DeviceUpdatedEvent, FailedAuthenticationActionEvent, FailedAuthenticationEvent, FailedCatVerificationEvent, FailedVerificationCredentialManagerEvent, FailureBackchannelAuthenticationEvent, FailureClientAuthenticationEvent, IdTokenOAuthEvent, InitialAccessTokenDcrOAuthEvent, IntrospectionOAuthEvent, IssuedAccessTokenOAuthEvent, IssuedAuthorizationCodeOAuthEvent, IssuedDelegationOAuthEvent, IssuedDeviceCodeOAuthEvent, IssuedIdTokenOAuthEvent, IssuedInitialAccessTokenDcrOAuthEvent, IssuedRefreshTokenOAuthEvent, LinkedAccountEvent, LoginAuthenticationEvent, LogoutAuthenticationEvent, OAuthEvent, PasswordUpdatedCredentialManagerEvent, PendingCompletionAuthenticationActionEvent, ProfileAddedSystemEvent, RefreshTokenOAuthEvent, RegisteredDcrClientOAuthEvent, RevokedAccessTokenOAuthEvent, RevokedDelegationOAuthEvent, RevokedDelegationScimEvent, RevokedInitialAccessTokenDcrOAuthEvent, RevokedRefreshTokenOAuthEvent, ScimEvent, SessionEvent, StartedBackchannelAuthenticationEvent, SuccessAuthenticationActionEvent, SuccessAuthenticationEvent, SuccessBackchannelAuthenticationEvent, SuccessClientAuthenticationEvent, SuccessfulVerificationCredentialManagerEvent, SuccessSsoAuthenticationEvent, SystemEvent, TokenOAuthEvent, UnlinkedAccountEvent, UserAuthenticationEvent, UserConsentedOAuthEvent, UserInfoOAuthEvent

public interface Event extends SerializableAsMap
Root Server event type.

Events can be published by the server when something noticeable happens, and are meant to be handled by registered EventListener instances.

See the sub-types of this interface to find out what kinds of events the server produces.

Since:
2.2.0
  • Method Summary

    Modifier and Type
    Method
    Description
    default Map<String,Object>
    Get a map representation of this Event.
  • Method Details

    • asMap

      default Map<String,Object> asMap()
      Get a map representation of this Event.
      Specified by:
      asMap in interface SerializableAsMap
      Returns:
      a Map representation of this Event. This can be used to serialize events. Sub-types are encouraged to override this method, calling super.asMap() and enriching the returned mutable Map with the more specific information added by the sub-type.