All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

Toolkit for developing Connect2id Server extensions, such as custom OpenID Connect claims sources and grant handlers.

There is a newer version: 5.10
Show newest version
package com.nimbusds.openid.connect.provider.spi.grants;


import com.nimbusds.oauth2.sdk.GeneralException;
import com.nimbusds.oauth2.sdk.GrantType;
import com.nimbusds.oauth2.sdk.Scope;
import com.nimbusds.oauth2.sdk.client.ClientMetadata;
import com.nimbusds.oauth2.sdk.id.ClientID;


/**
 * Service Provider Interface (SPI) for handling OAuth 2.0 client credentials
 * grants. Returns the matching {@link GrantAuthorization authorisation} on
 * success.
 *
 * 

Implementations must be thread-safe. * *

Related specifications: * *

    *
  • OAuth 2.0 (RFC 6749), sections 1.3.4 and 4.4. *
*/ public interface ClientCredentialsGrantHandler extends GrantHandler { /** * The handled grant type. */ GrantType GRANT_TYPE = GrantType.CLIENT_CREDENTIALS; /** * Handles a client credentials grant. The client is confidential and * always authenticated. * * @param scope The requested scope, {@code null} if not * specified. * @param clientID The client identifier. Not {@code null}. * @param clientMetadata The OAuth 2.0 client metadata. Not * {@code null}. * *

If the requested scope is invalid, unknown, malformed, or exceeds * the scope granted by the resource owner the handler must throw a * {@link GeneralException} with an * {@link com.nimbusds.oauth2.sdk.OAuth2Error#INVALID_SCOPE * invalid_scope} error code. * * @return The authorisation. * * @throws GeneralException If the grant is invalid, or another * exception was encountered. */ GrantAuthorization processGrant(final Scope scope, final ClientID clientID, final ClientMetadata clientMetadata) throws GeneralException; }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy