com.here.account.auth.provider

Class ClientAuthorizationProviderChain

java.lang.Object

com.here.account.auth.provider.ClientAuthorizationProviderChain

All Implemented Interfaces:

ClientAuthorizationRequestProvider

public class ClientAuthorizationProviderChain
extends Object
implements ClientAuthorizationRequestProvider

Author:

kmccrack

Field Summary

Fields

Modifier and Type	Field and Description
static ClientAuthorizationProviderChain	DEFAULT_CLIENT_CREDENTIALS_PROVIDER_CHAIN Deprecated. use getNewDefaultClientCredentialsProviderChain(Clock)

Constructor Summary

Constructors

Constructor and Description
ClientAuthorizationProviderChain(ClientAuthorizationRequestProvider... clientAuthorizationProviders)
ClientAuthorizationProviderChain(List<ClientCredentialsProvider> clientAuthorizationProviders)

Method Summary

Modifier and Type	Method and Description
HttpProvider.HttpRequestAuthorizer	getClientAuthorizer() Gets the HttpRequestAuthorizer that the client will use to authorize access token requests.
protected ClientAuthorizationRequestProvider	getClientCredentialsProvider()
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.
static ClientAuthorizationProviderChain	getNewDefaultClientCredentialsProviderChain(Clock clock) Factory method for getting a new default ClientAuthorizationProviderChain.
String	getScope() Get the token scope.
String	getTokenEndpointUrl() Gets the url of the token endpoint for this OAuth 2.0 Provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CLIENT_CREDENTIALS_PROVIDER_CHAIN

@Deprecated
public static ClientAuthorizationProviderChain DEFAULT_CLIENT_CREDENTIALS_PROVIDER_CHAIN

Deprecated. use getNewDefaultClientCredentialsProviderChain(Clock)

Constructor Detail

ClientAuthorizationProviderChain

public ClientAuthorizationProviderChain(ClientAuthorizationRequestProvider... clientAuthorizationProviders)

ClientAuthorizationProviderChain

public ClientAuthorizationProviderChain(List<ClientCredentialsProvider> clientAuthorizationProviders)

Method Detail

getNewDefaultClientCredentialsProviderChain

public static ClientAuthorizationProviderChain getNewDefaultClientCredentialsProviderChain(Clock clock)

Factory method for getting a new default ClientAuthorizationProviderChain. The exact sequence of providers is subject to change in future releases, as new providers are added.

Currently, the default ClientCredentialsProviderChain uses

• System properties
• ~/.here/credentials.ini file
• ~/.here/credentials.properties file
• file:///dev/shm/identity/access-token file

Parameters:

clock - the clock implementation to use

Returns:

the ClientAuthorizationProviderChain with default implementations in preference order

getClientCredentialsProvider

protected ClientAuthorizationRequestProvider getClientCredentialsProvider()

getTokenEndpointUrl

public 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.

Specified by:

getTokenEndpointUrl in interface ClientAuthorizationRequestProvider

Returns:

the url of the token endpoint

getClientAuthorizer

public HttpProvider.HttpRequestAuthorizer getClientAuthorizer()

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

Specified by:

getClientAuthorizer in interface ClientAuthorizationRequestProvider

Returns:

the client authorizer

getNewAccessTokenRequest

public AccessTokenRequest getNewAccessTokenRequest()

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

Specified by:

getNewAccessTokenRequest in interface ClientAuthorizationRequestProvider

Returns:

the new Access Token Request

getHttpMethod

public HttpConstants.HttpMethods getHttpMethod()

Get the HTTP Method used to obtain authorization.

Specified by:

getHttpMethod in interface ClientAuthorizationRequestProvider

Returns:

the HTTP Method

getClock

public Clock getClock()

Get the Clock implementation in use.

Specified by:

getClock in interface ClientAuthorizationRequestProvider

Returns:

the Clock in use.

getScope

public String getScope()

Get the token scope.

Specified by:

getScope in interface ClientAuthorizationRequestProvider

Returns:

the scope