io.inkstand.security.AuthenticationException Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 Gerald Muecke, [email protected]
 *
 * 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
 *
 *     http://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.inkstand.security;

import io.inkstand.InkstandException;

/**
 * Exception that should be thrown when the authentication of a user fails. If there are no further details about the
 * reason for the exception, use the {@link AuthenticationException} directly. Otherwise try to use a more detailed
 * version.
 *
 * @author Gerald Mücke
 */
public class AuthenticationException extends InkstandException {

    private static final long serialVersionUID = 2358944636079872791L;

    private final String userId;

    public AuthenticationException(final String userId) {
        this("Authentication failed", userId, null);
    }

    public AuthenticationException(final String userId, final Throwable cause) {
        this("Authentication failed", userId, cause);
    }

    public AuthenticationException(final String message, final String userId) {
        this(message, userId, null);
    }

    public AuthenticationException(final String message, final String userId, final Throwable cause) {
        super(message, cause);
        this.userId = userId;
    }

    @Override
    public String getMessage() {
        return getMessage(super.getMessage(), userId);
    }

    @Override
    public String getLocalizedMessage() {
        return getMessage(super.getLocalizedMessage(), userId);
    }

    private String getMessage(final String message, final String user) {
        return message + "[user=" + user+ ']';
    }

    /**
     * The id of the user that failed to authenticate
     *
     * @return a string representing the id of the user whose authentication failed
     */
    public String getUserId() {
        return userId;
    }

}