com.here.account.auth

Class OAuth2Authorizer

java.lang.Object

com.here.account.auth.OAuth2Authorizer

All Implemented Interfaces:

HttpProvider.HttpRequestAuthorizer

public class OAuth2Authorizer
extends Object
implements HttpProvider.HttpRequestAuthorizer

Appends the specified OAuth2.0 Bearer Token to the HTTP request.

See also HTTP Authentication Scheme Registry for a list of authschemes.

Author:

kmccrack

Constructor Summary

Constructors

Constructor and Description
OAuth2Authorizer(String accessToken) Construct the Bearer authorizer with the specified accessToken.
OAuth2Authorizer(Supplier<String> accessTokenSupplier) Construct the Bearer authorizer with the specified accessTokenSupplier.

Method Summary

Modifier and Type	Method and Description
void	authorize(HttpProvider.HttpRequest httpRequest, String method, String url, Map<String,List<String>> formParams) Computes and adds a signature or token to the request as appropriate for the authentication or authorization scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2Authorizer

public OAuth2Authorizer(String accessToken)

Construct the Bearer authorizer with the specified accessToken. Access Token is as defined in OAuth2.0 Section 1.4.

Parameters:

accessToken - the OAuth2.0 Bearer Access Token value

OAuth2Authorizer

public OAuth2Authorizer(Supplier<String> accessTokenSupplier)

Construct the Bearer authorizer with the specified accessTokenSupplier. This allows the accessTokenSupplier to change the Access Token it uses as needed, such as to avoid token expiration. Access Token is as defined in OAuth2.0 Section 1.4.

Parameters:

accessTokenSupplier - the Supplier for the OAuth2.0 Bearer Access Token values

Method Detail

authorize

public void authorize(HttpProvider.HttpRequest httpRequest,
                      String method,
                      String url,
                      Map<String,List<String>> formParams)

Computes and adds a signature or token to the request as appropriate for the authentication or authorization scheme.

Specified by:

authorize in interface HttpProvider.HttpRequestAuthorizer

Parameters:

httpRequest - the HttpRequest under construction, to which to attach authorization

method - the HTTP method

url - the URL of the request

formParams - the Content-Type: application/x-www-form-urlencoded form parameters.