io.micronaut.security.endpoints.TokenRefreshRequest 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.endpoints;

import com.fasterxml.jackson.annotation.JsonProperty;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.serde.annotation.Serdeable;

import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.Pattern;

/**
 * Encapsulate the request to get a new access token.
 *
 * @author Sergio del Amo
 * @since 1.0
 */
@Serdeable
public class TokenRefreshRequest {

    public static final String GRANT_TYPE_REFRESH_TOKEN = "refresh_token";

    public static final String GRANT_TYPE = "grant_type";

    @NonNull
    @NotBlank
    @Pattern(regexp = GRANT_TYPE_REFRESH_TOKEN)
    @JsonProperty(GRANT_TYPE)
    private final String grantType;

    @NotBlank
    @JsonProperty(GRANT_TYPE_REFRESH_TOKEN)
    @NonNull
    private final String refreshToken;

    /**
     *
     * @param grantType Grant type
     * @param refreshToken Refresh token
     */
    public TokenRefreshRequest(@NonNull String grantType,
                               @NonNull String refreshToken) {
        this.grantType = grantType;
        this.refreshToken = refreshToken;
    }

    /**
     * grantType getter.
     * @return e.g refresh_token
     */
    @NonNull
    public String getGrantType() {
        return grantType;
    }

    /**
     * refreshToken getter.
     * @return e.g. XXXXX
     */
    @NonNull
    public String getRefreshToken() {
        return refreshToken;
    }

}