redback-integrations/redback-rest/redback-rest-api/src/main/java/org/apache/archiva/redback/rest/api/model/v2/TokenRefreshRequest.java

package org.apache.archiva.redback.rest.api.model.v2;/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import io.swagger.v3.oas.annotations.media.Schema;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import java.io.Serializable;

/**
 * @author Martin Stockhammer <martin_s@apache.org>
 */
@XmlRootElement( name = "refreshToken" )
@Schema( name = "TokenRefreshRequest", description = "Information for requesting token from a refresh token" )
public class TokenRefreshRequest implements Serializable
{

    private static final long serialVersionUID = 3900011211040344882L;
    GrantType grantType;
    String refreshToken;
    String scope;

    public TokenRefreshRequest( )
    {
    }

    public TokenRefreshRequest( GrantType grantType, String refreshToken, String scope )
    {
        this.grantType = grantType;
        this.refreshToken = refreshToken;
        this.scope = scope;
    }

    @XmlElement( name = "grant_type", required = true)
    @Schema(name="grant_type", description = "The grant type for requesting the token. 'refresh_token' for token refresh")
    public GrantType getGrantType( )
    {
        return grantType;
    }

    public void setGrantType( GrantType grantType )
    {
        this.grantType = grantType;
    }

    @XmlElement( name = "refresh_token" )
    @Schema(name="refresh_token", description = "The refresh token that is validated before generating the new access token")
    public String getRefreshToken( )
    {
        return refreshToken;
    }

    public void setRefreshToken( String refreshToken )
    {
        this.refreshToken = refreshToken;
    }

    @XmlElement( name = "scope")
    @Schema(description = "The scope for the new access token.")
    public String getScope( )
    {
        return scope;
    }

    public void setScope( String scope )
    {
        this.scope = scope;
    }
}