org.wildfly.security.auth.server.event.RealmDefiniteOutcomeAuthenticationEvent Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2015 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.RealmIdentity;
import org.wildfly.security.credential.Credential;
import org.wildfly.security.evidence.Evidence;
/**
* An authentication event with a definite outcome.
*
* @author David M. Lloyd
*/
public abstract class RealmDefiniteOutcomeAuthenticationEvent extends RealmAuthenticationEvent {
private final Credential credential;
private final Evidence evidence;
/**
* Construct a new instance.
*
* @param realmIdentity the authenticated realm identity
* @param credential the actual credential value from the authentication (may be {@code null} if not known)
* @param evidence the evidence used to authenticate (may be {@code null} if not known or not applicable)
*/
RealmDefiniteOutcomeAuthenticationEvent(final RealmIdentity realmIdentity, final Credential credential, final Evidence evidence) {
super(realmIdentity);
this.credential = credential;
this.evidence = evidence;
}
/**
* Get the actual credential used.
*
* @return the actual credential used, or {@code null} if it is not known or none was used
*/
public Credential getCredential() {
return credential;
}
/**
* Get the actual credential guess used.
*
* @return the actual credential guess used, or {@code null} if there was no guess, it is not known, or no credential was used
*/
public Evidence getEvidence() {
return evidence;
}
public R accept(final RealmEventVisitor visitor, final P param) {
return visitor.handleDefiniteOutcomeAuthenticationEvent(this, param);
}
public final boolean isFailure() {
return ! isSuccess();
}
}