alpine.server.auth.AlpineAuthenticationException Maven / Gradle / Ivy

Go to download
/*
 * This file is part of Alpine.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * Copyright (c) Steve Springett. All Rights Reserved.
 */
package alpine.server.auth;

import javax.naming.AuthenticationException;
import java.security.Principal;

/**
 * An exception class that optionally holds pre-determined causes for common
 * authentication failures.
 *
 * @author Steve Springett
 * @since 1.1.0
 */
public class AlpineAuthenticationException extends AuthenticationException {

    private static final long serialVersionUID = 7367893115241461285L;

    public enum CauseType {
        INVALID_CREDENTIALS,
        EXPIRED_CREDENTIALS,
        FORCE_PASSWORD_CHANGE,
        SUSPENDED,
        UNMAPPED_ACCOUNT,
        OTHER
    }

    private final CauseType causeType;
    private Principal principal;

    public AlpineAuthenticationException(final CauseType causeType) {
        this.causeType = causeType;
    }

    public AlpineAuthenticationException(final CauseType causeType, final Principal principal) {
        this.principal = principal;
        this.causeType = causeType;
    }

    public CauseType getCauseType() {
        return causeType;
    }

    public Principal getPrincipal() {
        return principal;
    }

}