com.here.account.auth

Class OAuth1ClientCredentialsProvider

java.lang.Object

com.here.account.auth.OAuth1ClientCredentialsProvider

All Implemented Interfaces:

ClientAuthorizationRequestProvider, ClientCredentialsProvider

Direct Known Subclasses:

OAuth1ClientCredentialsProvider.FromProperties

public class OAuth1ClientCredentialsProvider
extends Object
implements ClientCredentialsProvider

A ClientCredentialsProvider that injects client credentials by signing token requests with an OAuth1 signature.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth1ClientCredentialsProvider.FromFile An OAuth1ClientCredentialsProvider.FromProperties that pulls credential values from the specified File.
static class	OAuth1ClientCredentialsProvider.FromProperties An OAuth1ClientCredentialsProvider that pulls credentials values from the given properties.

Constructor Summary

Constructors

Constructor and Description
OAuth1ClientCredentialsProvider(Clock clock, String tokenEndpointUrl, String accessKeyId, String accessKeySecret)
OAuth1ClientCredentialsProvider(Clock clock, String tokenEndpointUrl, String accessKeyId, String accessKeySecret, String scope)
OAuth1ClientCredentialsProvider(String tokenEndpointUrl, String accessKeyId, String accessKeySecret) Construct a new OAuth1ClientCredentialsProvider that points to the given token endpoint and uses the given client credentials to sign requests using OAuth1 signatures.
OAuth1ClientCredentialsProvider(String tokenEndpointUrl, String accessKeyId, String accessKeySecret, String scope)

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.
static Properties	getPropertiesFromFile(File file) Loads the File as an InputStream into a new Properties object, and returns it.
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

Constructor Detail

OAuth1ClientCredentialsProvider

public OAuth1ClientCredentialsProvider(String tokenEndpointUrl,
                                       String accessKeyId,
                                       String accessKeySecret)

Construct a new OAuth1ClientCredentialsProvider that points to the given token endpoint and uses the given client credentials to sign requests using OAuth1 signatures.

Parameters:

tokenEndpointUrl - the full URL of the OAuth2.0 token endpoint

accessKeyId - the access key id to be used as a client credential

accessKeySecret - the access key secret to be used as a client credential

OAuth1ClientCredentialsProvider

public OAuth1ClientCredentialsProvider(String tokenEndpointUrl,
                                       String accessKeyId,
                                       String accessKeySecret,
                                       String scope)

OAuth1ClientCredentialsProvider

public OAuth1ClientCredentialsProvider(Clock clock,
                                       String tokenEndpointUrl,
                                       String accessKeyId,
                                       String accessKeySecret)

OAuth1ClientCredentialsProvider

public OAuth1ClientCredentialsProvider(Clock clock,
                                       String tokenEndpointUrl,
                                       String accessKeyId,
                                       String accessKeySecret,
                                       String scope)

Method Detail

getClock

public Clock getClock()

Get the Clock implementation in use.

Specified by:

getClock in interface ClientAuthorizationRequestProvider

Returns:

the Clock in use.

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

getPropertiesFromFile

public static Properties getPropertiesFromFile(File file)
                                        throws IOException

Loads the File as an InputStream into a new Properties object, and returns it.

Parameters:

file - the File to use as input

Returns:

the Properties populated from the specified file's contents

Throws:

IOException - if there is trouble reading the properties from the file

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

getScope

public String getScope()

Get the token scope.

Specified by:

getScope in interface ClientAuthorizationRequestProvider

Returns:

the scope