com.nimbusds.openid.connect.provider.spi.grants.TokenRequestParameters Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of c2id-server-sdk Show documentation

SDK for Connect2id Server extensions, such as OpenID Connect claims sources and OAuth 2.0 grant handlers

There is a newer version: 5.8

package com.nimbusds.openid.connect.provider.spi.grants;


import java.net.URI;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import org.checkerframework.checker.nullness.qual.Nullable;

import com.nimbusds.oauth2.sdk.Scope;


/**
 * Common token request parameters for an OAuth 2.0 grant.
 */
public interface TokenRequestParameters {
	
	
	/**
	 * Returns the requested scope.
	 *
	 * @return The scope, {@code null} if not specified.
	 */
	default @Nullable Scope getScope() {
		return null;
	}
	
	
	/**
	 * Returns the resource server URI(s).
	 *
	 * @return The resource server URI(s), {@code null} if not specified.
	 */
	default @Nullable List getResources() {
		return null;
	}
	
	
	/**
	 * Returns the custom token request parameters.
	 *
	 * @return The custom parameters, empty map if none.
	 */
	default Map> getCustomParameters() {
		return Collections.emptyMap();
	}
}