org.pac4j.oauth.client

Class StravaClient

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient<OAuthCredentials,U>

org.pac4j.oauth.client.BaseOAuthClient<U>

org.pac4j.oauth.client.BaseOAuth20Client<StravaProfile>

org.pac4j.oauth.client.StravaClient

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,StravaProfile>

public class StravaClient
extends BaseOAuth20Client<StravaProfile>

OAuth20Client for Strava.

Use the key as the client_id and secret as the client_secret, both provided by Strava at: https://www.strava.com/settings/api

Set approvalPrompt to "force" if you want to force the authorization dialog to always display on Strava, otherwise let it to "auto" (default value).

More info at: http://strava.github.io/api/

Since:

1.7.0

Author:

Adrian Papusoi

Field Summary

Fields

Modifier and Type	Field and Description
protected String	scope comma delimited string of ‘view_private’ and/or ‘write’, leave blank for read-only permissions.

Fields inherited from class org.pac4j.oauth.client.BaseOAuth20Client

logger, OAUTH_CODE

Fields inherited from class org.pac4j.oauth.client.BaseOAuthClient

connectTimeout, key, proxyHost, proxyPort, readTimeout, secret, service, tokenAsHeader

Fields inherited from class org.pac4j.core.client.BaseClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
StravaClient()
StravaClient(String key, String secret)

Method Summary

Modifier and Type	Method and Description
protected StravaProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
String	getApprovalPrompt()
protected String	getProfileUrl(org.scribe.model.Token accessToken) Retrieve the url of the profile of the authenticated user for the provider.
String	getScope()
protected boolean	hasBeenCancelled(WebContext context) Return if the authentication has been cancelled.
protected void	internalInit()
protected boolean	isDirectRedirection()
protected StravaClient	newClient()
protected boolean	requiresStateParameter() Return if this client requires a state parameter.
void	setApprovalPrompt(String approvalPrompt)
void	setScope(String scope)

Methods inherited from class org.pac4j.oauth.client.BaseOAuth20Client

getAccessToken, getOAuthCredentials, getStateParameter, retrieveAuthorizationUrl

Methods inherited from class org.pac4j.oauth.client.BaseOAuthClient

addAccessTokenToProfile, clone, createProxyRequest, getConnectTimeout, getKey, getMechanism, getProxyHost, getProxyPort, getReadTimeout, getSecret, getUserProfile, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, retrieveUserProfileFromToken, sendRequestForData, sendRequestForData, setConnectTimeout, setKey, setProxyHost, setProxyPort, setReadTimeout, setSecret, setTokenAsHeader

Methods inherited from class org.pac4j.core.client.BaseClient

addAuthorizationGenerator, getAuthenticator, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getProfileCreator, getRedirectAction, getRedirectionUrl, getUserProfile, isEnableContextualRedirects, isIncludeClientNameInCallbackUrl, prependHostToUrlIfNotPresent, redirect, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setIncludeClientNameInCallbackUrl, setName, setProfileCreator, toString

Methods inherited from class org.pac4j.core.util.InitializableObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

scope

protected String scope

comma delimited string of ‘view_private’ and/or ‘write’, leave blank for read-only permissions.

Constructor Detail

StravaClient

public StravaClient()

StravaClient

public StravaClient(String key,
                    String secret)

Method Detail

getApprovalPrompt

public String getApprovalPrompt()

setApprovalPrompt

public void setApprovalPrompt(String approvalPrompt)

getScope

public String getScope()

setScope

public void setScope(String scope)

newClient

protected StravaClient newClient()

Specified by:

newClient in class BaseClient<OAuthCredentials,StravaProfile>

internalInit

protected void internalInit()

Overrides:

internalInit in class BaseOAuthClient<StravaProfile>

requiresStateParameter

protected boolean requiresStateParameter()

Description copied from class: BaseOAuth20Client

Return if this client requires a state parameter.

Specified by:

requiresStateParameter in class BaseOAuth20Client<StravaProfile>

Returns:

if this client requires a state parameter.

hasBeenCancelled

protected boolean hasBeenCancelled(WebContext context)

Description copied from class: BaseOAuthClient

Return if the authentication has been cancelled.

Specified by:

hasBeenCancelled in class BaseOAuthClient<StravaProfile>

Parameters:

context - the web context.

Returns:

if the authentication has been cancelled.

getProfileUrl

protected String getProfileUrl(org.scribe.model.Token accessToken)

Description copied from class: BaseOAuthClient

Retrieve the url of the profile of the authenticated user for the provider.

Specified by:

getProfileUrl in class BaseOAuthClient<StravaProfile>

Parameters:

accessToken - only used when constructing dynamic urls from data in the token

Returns:

the url of the user profile given by the provider

extractUserProfile

protected StravaProfile extractUserProfile(String body)

Description copied from class: BaseOAuthClient

Extract the user profile from the response (JSON, XML...) of the profile url.

Specified by:

extractUserProfile in class BaseOAuthClient<StravaProfile>

Parameters:

body - the response body

Returns:

the user profile object

isDirectRedirection

protected boolean isDirectRedirection()

Overrides:

isDirectRedirection in class BaseOAuth20Client<StravaProfile>