org.wildfly.security.auth.callback.EvidenceVerifyCallback 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.callback;
import java.util.function.Function;
import org.wildfly.security.evidence.Evidence;
import javax.security.auth.callback.Callback;
/**
* A {@link Callback} for use where credential verification is required.
*
* @author Darran Lofthouse
*/
public class EvidenceVerifyCallback implements ExtendedCallback {
private final Evidence evidence;
private boolean verified;
/**
* Construct a new instance of this {@link Callback}.
*
* @param evidence the evidence to be verified
*/
public EvidenceVerifyCallback(final Evidence evidence) {
this.evidence = evidence;
}
/**
* Get the evidence being verified.
*
* @return the evidence being verified
*/
public Evidence getEvidence() {
return evidence;
}
/**
* Get the acquired evidence, if it is set and of the given type, and if so, return the evidence cast to the type.
*
* @param evidenceType the evidence type class (must not be {@code null})
* @param the evidence type
* @return the evidence, or {@code null} if the criteria wasn't met
*/
public C getEvidence(Class evidenceType) {
return applyToEvidence(evidenceType, Function.identity());
}
/**
* Get the acquired evidence, if it is set and of the given type and algorithm, and if so, return the evidence cast to the type.
*
* @param evidenceType the evidence type class (must not be {@code null})
* @param algorithmName the algorithm name
* @param the evidence type
* @return the evidence, or {@code null} if the criteria are not met
*/
public C getEvidence(Class evidenceType, String algorithmName) {
return applyToEvidence(evidenceType, algorithmName, Function.identity());
}
/**
* Apply the given function to the acquired evidence, if it is set and of the given type.
*
* @param evidenceType the evidence type class (must not be {@code null})
* @param function the function to apply (must not be {@code null})
* @param the evidence type
* @param the return type
* @return the result of the function, or {@code null} if the criteria are not met
*/
public R applyToEvidence(Class evidenceType, Function function) {
final Evidence evidence = this.evidence;
return evidence == null ? null : evidence.castAndApply(evidenceType, function);
}
/**
* Apply the given function to the acquired evidence, if it is set and of the given type and algorithm.
*
* @param evidenceType the evidence type class (must not be {@code null})
* @param algorithmName the algorithm name
* @param function the function to apply (must not be {@code null})
* @param the evidence type
* @param the return type
* @return the result of the function, or {@code null} if the criteria are not met
*/
public R applyToEvidence(Class evidenceType, String algorithmName, Function function) {
final Evidence evidence = this.evidence;
return evidence == null ? null : evidence.castAndApply(evidenceType, algorithmName, function);
}
/**
* Set if the evidence referenced here has been verified.
*
* @param verified the verification state of the evidence
*/
public void setVerified(final boolean verified) {
this.verified = verified;
}
/**
* Get the verification state for the evidence referenced here.
*
* @return {@code true} if the evidence has been verified, {@code false} otherwise
*/
public boolean isVerified() {
return verified;
}
/**
* This {@link Callback} is not optional as verification is required.
*/
@Override
public boolean isOptional() {
return false;
}
/**
* This {@link Callback} needs to know if evidence validation was successful.
*/
@Override
public boolean needsInformation() {
return true;
}
}