com.here.account.oauth2

Interface ClientAuthorizationRequestProvider

All Known Subinterfaces:

ClientCredentialsProvider

All Known Implementing Classes:

AbstractClientAuthorizationRequestProvider, ClientAuthorizationProviderChain, ClientCredentialsGrantRequestProvider, FromDefaultHereCredentialsPropertiesFile, FromHereCredentialsIniFile, FromHereCredentialsIniStream, FromProperties, FromRunAsIdFileProvider, FromSystemProperties, OAuth1ClientCredentialsProvider, OAuth1ClientCredentialsProvider.FromFile, OAuth1ClientCredentialsProvider.FromProperties, RunAsIdAuthorizationProvider

public interface ClientAuthorizationRequestProvider

A ClientAuthorizationRequestProvider identifies a token endpoint, provides a mechanism to use credentials to authorize access token requests, and provides access token request objects.

Method Summary

Modifier and Type	Method and Description
HttpProvider.HttpRequestAuthorizer	getClientAuthorizer() Gets the HttpRequestAuthorizer that the client will use to authorize access token requests.
Clock	getClock() Get the Clock implementation in use.
HttpConstants.HttpMethods	getHttpMethod() Get the HTTP Method used to obtain authorization.
AccessTokenRequest	getNewAccessTokenRequest() Gets a new AccessTokenRequest to authorize this client to obtain an Access Token.
default String	getScope() Get the token scope.
String	getTokenEndpointUrl() Gets the url of the token endpoint for this OAuth 2.0 Provider.

Method Detail

getTokenEndpointUrl

String getTokenEndpointUrl()

Gets the url of the token endpoint for this OAuth 2.0 Provider. See also The OAuth 2.0 Authorization Framework: Token Endpoint.

Returns:

the url of the token endpoint

getClientAuthorizer

HttpProvider.HttpRequestAuthorizer getClientAuthorizer()

Gets the HttpRequestAuthorizer that the client will use to authorize access token requests.

Returns:

the client authorizer

Throws:

RequestProviderException - if no suitable authorizer can be gotten, due to missing configuration elements

getNewAccessTokenRequest

AccessTokenRequest getNewAccessTokenRequest()

Gets a new AccessTokenRequest to authorize this client to obtain an Access Token.

Returns:

the new Access Token Request

getHttpMethod

HttpConstants.HttpMethods getHttpMethod()

Get the HTTP Method used to obtain authorization.

Returns:

the HTTP Method

getClock

Clock getClock()

Get the Clock implementation in use.

Returns:

the Clock in use.

getScope

default String getScope()

Get the token scope.

Returns:

the scope