io.micronaut.security.authentication.AuthenticationException 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-2023 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.authentication;

import io.micronaut.core.annotation.Nullable;

/**
 * A runtime exception thrown when authentication fails.
 *
 * @author James Kleeh
 * @since 1.0
 */
public class AuthenticationException extends RuntimeException {

    private final AuthenticationResponse response;

    /**
     * Sets the message based on the response.
     *
     * @param response The authentication response
     */
    public AuthenticationException(AuthenticationResponse response) {
        super(response.getMessage().orElse(null));
        this.response = response;
    }

    /**
     * No message.
     */
    public AuthenticationException() {
        super();
        response = null;
    }

    /**
     * @param message A custom message
     */
    public AuthenticationException(String message) {
        super(message);
        response = null;
    }

    /**
     * @return The authentication response, or null if the exception is not tied to a response
     */
    @Nullable
    public AuthenticationResponse getResponse() {
        return response;
    }
}