Package io.micronaut.security.event

Class LogoutEvent

java.lang.Object

java.util.EventObject

io.micronaut.context.event.ApplicationEvent

io.micronaut.security.event.SecurityEvent

io.micronaut.security.event.LogoutEvent

All Implemented Interfaces:

Serializable

public class LogoutEvent
extends SecurityEvent

Event triggered when the user logs out.

Since:

1.0

Author:

Sergio del Amo

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
LogoutEvent(Object source)	Deprecated, for removal: This API element is subject to removal in a future version. Use LogoutEvent(Object, String, Locale) instead
LogoutEvent(Object source, @Nullable String host, Locale locale)	Event triggered when the user logs out.

Method Summary

Methods inherited from class io.micronaut.security.event.SecurityEvent

getHost, getLocale

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

LogoutEvent

public LogoutEvent(Object source,
 @Nullable
 @Nullable String host,
 Locale locale)

Event triggered when the user logs out.

Parameters:

source - The Authentication of the user logging out.

host - The hostname from the request

locale - The locale of the request

Throws:

IllegalArgumentException - if source is null.

Since:

4.7.0

LogoutEvent

@Deprecated(forRemoval=true,
            since="4.7.0")
public LogoutEvent(Object source)

Deprecated, for removal: This API element is subject to removal in a future version.

Use LogoutEvent(Object, String, Locale) instead

Event triggered when the user logs out.

Parameters:

source - The Authentication of the user logging out.

Throws:

IllegalArgumentException - if source is null.