com.authlete.common.dto.StandardIntrospectionRequest 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) 2017 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 com.authlete.common.api.AuthleteApi;


/**
 * Request to Authlete's {@code /api/auth/introspection/standard} API.
 * Note that the API and {@code /api/auth/introspection} API are different.
 * {@code /api/auth/introspection/standard} API exists to help your
 * authorization server provide its own introspection API which complies
 * with RFC 7662 (OAuth
 * 2.0 Token Introspection).
 *
 * 
 * 
 * parameters (REQUIRED)
 * 
 * 
 * Request parameters which comply with the introspection request
 * defined in "2.1. Introspection Request" in RFC 7662. The following is
 * an example value of {@code parameters}.
 * 
 * token=pNj1h24a4geA_YHilxrshkRkxJDsyXBZWKp3hZ5ND7A&token_type_hint=access_token
 * 
 * The implementation of the introspection endpoint of your
 * authorization server will receive an HTTP POST [RFC 7231] request with
 * parameters in the "{@code application/x-www-form-urlencoded}"
 * format. It is the entity body of the request that Authlete's
 * {@code /api/auth/introspection/standard} API expects as the
 * value of {@code parameters}.
 * 
 * 
 * 
 * 
 *
 * @see RFC 7662, OAuth 2.0 Token Introspection
 * @see StandardIntrospectionResponse
 * @see AuthleteApi#standardIntrospection(StandardIntrospectionRequest)
 *
 * @author Takahiko Kawasaki
 *
 * @since 2.7
 */
public class StandardIntrospectionRequest implements Serializable
{
    private static final long serialVersionUID = 1L;


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


    /**
     * Get the value of {@code parameters} that represents the
     * request parameters which the introspection endpoint of
     * the authorization server received.
     *
     * @return
     *         Request parameters which comply with RFC 7662.
     *         For example, "{@code
     *         token=pNj1h24a4geA_YHilxrshkRkxJDsyXBZWKp3hZ5ND7A}".
     */
    public String getParameters()
    {
        return parameters;
    }


    /**
     * Set the value of {@code parameters} that represents the
     * request parameters which the introspection endpoint of
     * the authorization server received.
     *
     * @param parameters
     *         Request parameters which comply with RFC 7662.
     *         For example, "{@code
     *         token=pNj1h24a4geA_YHilxrshkRkxJDsyXBZWKp3hZ5ND7A}".
     *
     * @return
     *         {@code this} object.
     */
    public StandardIntrospectionRequest setParameters(String parameters)
    {
        this.parameters = parameters;

        return this;
    }
}