org.wildfly.security.evidence.Evidence 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 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.evidence;

import java.security.Principal;
import java.util.function.Function;

/**
 * A piece of evidence which may be used for credential verification.
 *
 * @author David M. Lloyd
 * @author Darran Lofthouse
 */
public interface Evidence {

    /**
     * Get the {@link Principal} which can be derived from this evidence, this can be {@code null} if there is no derived Principal.
     *
     * @return the {@link Principal} which can be derived from this evidence, this can be {@code null} if there is no derived Principal.
     * @deprecated Use {@link #getDefaultPrincipal()} or {@link #getDecodedPrincipal()} instead.
     */
    @Deprecated
    default Principal getPrincipal() {
        return null;
    }

    /**
     * Get the default {@link Principal} associated with this evidence (may be {@code null}).
     *
     * @return the default {@link Principal} associated with this evidence (may be{@code null})
     * @since 1.10.0
     */
    default Principal getDefaultPrincipal() {
        return getPrincipal();
    }

    /**
     * Get the {@link Principal} derived from this evidence using an evidence decoder (may be {@code null}).
     *
     * @return the {@link Principal} derived from this evidence using an evidence decoder (may be {@code null})
     * @since 1.10.0
     */
    default Principal getDecodedPrincipal() {
        return getDefaultPrincipal();
    }

    /**
     * Set the {@link Principal} derived from this evidence using an evidence decoder (may be {@code null}).
     * This method is a no-op by default. It is intended to be implemented by evidence types that can be
     * associated with a principal derived from an evidence decoder.
     *
     * @param principal the principal derived from this evidence using an evidence decoder (may be {@code null})
     * @since 1.10.0
     */
    default void setDecodedPrincipal(Principal principal) {
        // no-op
    }

    /**
     * Cast this evidence type if the type and algorithm matches.
     *
     * @param evidenceType the evidence type class to check
     * @param algorithmName the name of the algorithm or {@code null} if any algorithm is acceptable
     * @param  the evidence type
     * @return the evidence cast as the target type, or {@code null} if the evidence does not match the criteria
     */
    default  E castAs(Class evidenceType, String algorithmName) {
        return castAndApply(evidenceType, algorithmName, Function.identity());
    }

    /**
     * Cast this evidence type if the type matches.
     *
     * @param evidenceType the evidence type class to check
     * @param  the evidence type
     * @return the evidence cast as the target type, or {@code null} if the evidence does not match the criteria
     */
    default  E castAs(Class evidenceType) {
        return castAndApply(evidenceType, Function.identity());
    }

    /**
     * Cast this evidence type and apply a function if the type matches.
     *
     * @param evidenceType the evidence type class to check
     * @param algorithmName the name of the algorithm or {@code null} if any algorithm is acceptable
     * @param function the function to apply
     * @param  the evidence type
     * @param  the return type
     * @return the result of the function, or {@code null} if the evidence is not of the given type
     */
    default  R castAndApply(Class evidenceType, String algorithmName, Function function) {
        return evidenceType.isInstance(this) && algorithmName == null ? function.apply(evidenceType.cast(this)) : null;
    }

    /**
     * Cast this evidence type and apply a function if the type matches.
     *
     * @param evidenceType the evidence type class to check
     * @param function the function to apply
     * @param  the evidence type
     * @param  the return type
     * @return the result of the function, or {@code null} if the evidence is not of the given type
     */
    default  R castAndApply(Class evidenceType, Function function) {
        return evidenceType.isInstance(this) ? function.apply(evidenceType.cast(this)) : null;
    }
}