com.authlete.common.dto.TokenRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of authlete-java-common Show documentation
Authlete Java library used commonly by service implementations and the Authlete server.
There is a newer version: 4.17
/*
 * Copyright (C) 2014-2015 Authlete, Inc.
 *
 * 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 com.authlete.common.dto;


import java.io.Serializable;
import java.util.Map;
import com.authlete.common.web.URLCoder;


/**
 * Request to Authlete's {@code /auth/token} API.
 *
 * 
 * 
 * parameters (REQUIRED)
 * 
 * 
 * OAuth 2.0 token request parameters which are the request parameters
 * that the OAuth 2.0 token endpoint of the service implementation
 * received from the client application.
 * 
 * 
 * The value of {@code "parameters"} is the entire entity body (which
 * is formatted in {@code application/x-www-form-urlencoded}) of the
 * request from the client application.
 * 
 * 
 *
 * clientId (OPTIONAL)
 * 
 * 
 * The client ID extracted from {@code Authorization} header of
 * the token request from the client application.
 * 
 * 
 * If the token endpoint of the service implementation supports
 * Basic Authentication as a means of
 * client
 * authentication, and the request from the client application
 * contained its client ID in {@code Authorization} header, the
 * value should be extracted and set to this parameter.
 * 
 * 
 *
 * clientSecret (OPTIONAL)
 * 
 * 
 * The client secret extracted from {@code Authorization} header
 * of the token request from the client application.
 * 
 * 
 * If the token endpoint of the service implementation supports
 * Basic Authentication as a means of
 * client
 * authentication, and the request from the client application
 * contained its client secret in {@code Authorization} header, the
 * value should be extracted and set to this parameter.
 * 
 * 
 * 
 * 
 *
 * 
 * An entity body of a token request may contain the client ID
 * ({@code client_id}) and the client secret ({@code client_secret})
 * along with other request parameters as described in
 * RFC 6749, 2.3.1. Client Password. If the client credentials
 * are contained in both {@code Authorization} header and the entity
 * body, they must be identical. Otherwise, Authlete's {@code
 * /auth/token} API generates an error (it's not a service error but
 * a client error).
 * 
 *
 * @author Takahiko Kawasaki
 */
public class TokenRequest implements Serializable
{
    private static final long serialVersionUID = 2L;


    /**
     * OAuth 2.0 token request parameters.
     */
    private String parameters;


    /**
     * Client ID.
     */
    private String clientId;


    /**
     * Client secret.
     */
    private String clientSecret;


    /**
     * Get the value of {@code parameters} which are the request
     * parameters that the OAuth 2.0 token endpoint of the service
     * implementation received from the client application.
     */
    public String getParameters()
    {
        return parameters;
    }


    /**
     * Set the value of {@code parameters} which are the request
     * parameters that the OAuth 2.0 token endpoint of the service
     * implementation received from the client application.
     */
    public TokenRequest setParameters(String parameters)
    {
        this.parameters = parameters;

        return this;
    }


    /**
     * Set the value of {@code parameters} which are the request
     * parameters that the OAuth 2.0 token endpoint of the service
     * implementation received from the client application.
     *
     * 
     * This method converts the given map into a string in {@code
     * x-www-form-urlencoded} and passes it to {@link
     * #setParameters(String)} method.
     * 
     *
     * @param parameters
     *         Request parameters.
     *
     * @return
     *         {@code this} object.
     *
     * @since 1.24
     */
    public TokenRequest setParameters(Map parameters)
    {
        return setParameters(URLCoder.formUrlEncode(parameters));
    }


    /**
     * Get the client ID extracted from {@code Authorization}
     * header of the token request from the client application.
     */
    public String getClientId()
    {
        return clientId;
    }


    /**
     * Set the client ID extracted from {@code Authorization}
     * header of the token request from the client application.
     */
    public TokenRequest setClientId(String clientId)
    {
        this.clientId = clientId;

        return this;
    }


    /**
     * Get the client secret extracted from {@code Authorization}
     * header of the token request from the client application.
     */
    public String getClientSecret()
    {
        return clientSecret;
    }


    /**
     * Set the client secret extracted from {@code Authorization}
     * header of the token request from the client application.
     */
    public TokenRequest setClientSecret(String clientSecret)
    {
        this.clientSecret = clientSecret;

        return this;
    }
}