org.wildfly.security.auth.server.event.SecurityAuthenticationFailedEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-elytron

WildFly Security SPIs

The newest version!

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2017 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * 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 org.wildfly.security.auth.server.event;

import org.wildfly.security.auth.server.SecurityIdentity;

import java.security.Principal;

/**
 * An event to represent a failed authentication.
 *
 * @author Darran Lofthouse
 */
public final class SecurityAuthenticationFailedEvent extends SecurityAuthenticationEvent {

    private final Principal principal;

    /**
     * Constructor for a new instance.
     *
     * @param securityIdentity the {@link SecurityIdentity} that failed authentication ({@code null} when identity does not exists)
     * @param principal the principal used to that failed authentication (filled event if identity does not exists)
     */
    public SecurityAuthenticationFailedEvent(SecurityIdentity securityIdentity, Principal principal) {
        super(securityIdentity, false);
        this.principal = principal;
    }

    /**
     * Gets the principal used to the failed authentication.
     *
     * @return the principal used to that failed authentication (filled event if identity does not exists)
     */
    public Principal getPrincipal() {
        return principal;
    }

    @Override
    public  R accept(SecurityEventVisitor visitor, P param) {
        return visitor.handleAuthenticationFailedEvent(this, param);
    }

}