io.micronaut.security.token.Claims Maven / Gradle / Ivy

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

Official Security Solution for Micronaut

There is a newer version: 4.10.1

/*
 * Copyright 2017-2023 original authors
 *
 * 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
 *
 * https://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.micronaut.security.token;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;

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

/**
 * Authentication claims.
 *
 * @since 1.1.0
 * @author Sergio del Amo
 */
public interface Claims {
    String ISSUER = "iss";

    String SUBJECT = "sub";

    String EXPIRATION_TIME = "exp";

    String NOT_BEFORE = "nbf";

    String ISSUED_AT = "iat";

    String TOKEN_ID = "jti";

    String KEY_ID = "kid";

    String AUDIENCE = "aud";

    List ALL_CLAIMS = Arrays.asList(ISSUER, SUBJECT, EXPIRATION_TIME, NOT_BEFORE, ISSUED_AT, TOKEN_ID, AUDIENCE);

    /**
     * Retrieves a value from the claims for the given name.
     *
     * @param name the claim name
     * @return {@code null} if the claim not exist or the claim value.
     */
    @Nullable
    Object get(String name);

    /**
     *
     * @return All claim names.
     */
    @NonNull
    Set names();

    /**
     *
     * @param name the claim name
     * @return {@code false} if the claim does not exist.
     */
    boolean contains(String name);
}