io.micronaut.security.event.LogoutEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-security Show documentation

Official Security Solution for Micronaut

There is a newer version: 4.11.1

/*
 * Copyright 2017-2024 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.security.event;

import io.micronaut.core.annotation.Nullable;

import java.util.Locale;

/**
 * Event triggered when the user logs out.
 *
 * @author Sergio del Amo
 * @since 1.0
 */
public class LogoutEvent extends SecurityEvent {

    /**
     * Event triggered when the user logs out.
     *
     * @param source The {@link io.micronaut.security.authentication.Authentication} of the user logging out.
     * @param host   The hostname from the request
     * @param locale The locale of the request
     * @throws IllegalArgumentException if source is null.
     * @since 4.7.0
     */
    public LogoutEvent(Object source, @Nullable String host, Locale locale) {
        super(source, host, locale);
    }

    /**
     * Event triggered when the user logs out.
     *
     * @param source The {@link io.micronaut.security.authentication.Authentication} of the user logging out.
     * @throws IllegalArgumentException if source is null.
     * @deprecated Use {@link #LogoutEvent(Object, String, Locale)} instead
     */
    @Deprecated(forRemoval = true, since = "4.7.0")
    public LogoutEvent(Object source) {
        this(source, null, Locale.getDefault());
    }
}