io.helidon.security.jwt.ClaimValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-security-jwt Show documentation

Implementation of JWT and JWK to be used in other modules.

There is a newer version: 4.1.6

/*
 * Copyright (c) 2024 Oracle and/or its affiliates.
 *
 * 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 io.helidon.security.jwt;

import java.util.List;
import java.util.Set;

import io.helidon.common.Errors;

/**
 * JWT claim validator.
 */
public interface ClaimValidator {

    /**
     * Scope of the JWT claims.
     *
     * @return JWT claim scope
     */
    JwtScope jwtScope();

    /**
     * Handled JWT claims.
     *
     * @return claims
     */
    Set claims();

    /**
     * Validate JWT against this class's configuration.
     *
     * @param jwt        jwt to validate
     * @param collector  collector of error messages to add problems to. Use {@link Errors.Collector#fatal(Object, String)}
     *                   to mark the validation as a failure
     * @param validators immutable list of all currently processed claim validators
     */
    void validate(Jwt jwt, Errors.Collector collector, List validators);

}