io.micronaut.security.endpoints.introspection.IntrospectionRequest Maven / Gradle / Ivy

Go to download

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.11.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.endpoints.introspection;

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

import jakarta.validation.constraints.NotBlank;

/**
 * A parameter representing the token along with optional parameters representing
 * additional context that is known by the protected resource to aid the authorization server in its response.
 * @see RFC7662 2.1. Introspection request
 * @author Sergio del Amo
 * @since 2.1.0
 */
@Serdeable
public class IntrospectionRequest {

    /**
     *  The string value of the token.
     */
    @NonNull
    @NotBlank
    private final String token;

    /**
     * A hint about the type of the token submitted for introspection.
     */
    @Nullable
    private final String token_type_hint;

    /**
     *
     * @param token The string value of the token
     * @param tokenTypeHint A hint about the type of the token submitted for introspection.
     */
    public IntrospectionRequest(@NonNull @NotBlank String token, @Nullable String tokenTypeHint) {
        this.token = token;
        this.token_type_hint = tokenTypeHint;
    }

    /**
     *
     * @return  The string value of the token
     */
    @NonNull
    public String getToken() {
        return token;
    }

    /**
     *
     * @return A hint about the type of the token submitted for introspection.
     */
    @Nullable
    public String getTokenTypeHint() {
        return token_type_hint;
    }

    /**
     *
     * @return A hint about the type of the token submitted for introspection.
     */
    @Nullable
    @SuppressWarnings("MethodName")
    public String getToken_type_hint() {
        return getTokenTypeHint();
    }

    @Override
    public String toString() {
        return "IntrospectionRequest{" +
                "token='" + token + '\'' +
                ", token_type_hint='" + token_type_hint + '\'' +
                '}';
    }
}