org.pac4j.oauth.client

Class FoursquareClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

org.pac4j.oauth.client.BaseOAuthClient<U,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

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

org.pac4j.oauth.client.FoursquareClient

All Implemented Interfaces:

Client<OAuthCredentials,FoursquareProfile>

public class FoursquareClient
extends BaseOAuth20Client<FoursquareProfile>

This class is the OAuth client to authenticate users in Foursquare. It returns a FoursquareProfile.

More information at https://developer.foursquare.com/overview/auth.html

Since:

1.5.0

Author:

Alexey Ogarkov

Field Summary

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

logger, OAUTH_CODE

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

service

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected FoursquareProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
protected com.github.scribejava.core.builder.api.BaseApi<com.github.scribejava.core.oauth.OAuth20Service>	getApi() Define the OAuth API for this client.
protected String	getOAuthScope() Define the OAuth scope for this client.
protected String	getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken) Retrieve the url of the profile of the authenticated user for the provider.
protected void	internalInit(WebContext context) Internal initialization of the object.

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

addAccessTokenToProfile, getAccessToken, getOAuthCredentials, retrieveAuthorizationUrl, signRequest

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

buildOAuthConfig, createOAuthRequest, getConnectTimeout, getKey, getReadTimeout, getResponseType, getSecret, hasBeenCancelled, hasOAuthGrantType, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, retrieveUserProfileFromToken, sendRequestForData, setConnectTimeout, setKey, setReadTimeout, setResponseType, setSecret, setTokenAsHeader

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

computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl

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

addAuthorizationGenerator, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName, toString

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

init, reinit

Methods inherited from class java.lang.Object

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

Constructor Detail

FoursquareClient

public FoursquareClient()

FoursquareClient

public FoursquareClient(String key,
                        String secret)

Method Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class BaseOAuthClient<FoursquareProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Parameters:

context - the web context

getApi

protected com.github.scribejava.core.builder.api.BaseApi<com.github.scribejava.core.oauth.OAuth20Service> getApi()

Description copied from class: BaseOAuthClient

Define the OAuth API for this client.

Specified by:

getApi in class BaseOAuthClient<FoursquareProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Returns:

the OAuth API

getOAuthScope

protected String getOAuthScope()

Description copied from class: BaseOAuthClient

Define the OAuth scope for this client.

Overrides:

getOAuthScope in class BaseOAuthClient<FoursquareProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Returns:

the OAuth scope

getProfileUrl

protected String getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken 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<FoursquareProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

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 FoursquareProfile extractUserProfile(String body)
                                        throws HttpAction

Description copied from class: BaseOAuthClient

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

Specified by:

extractUserProfile in class BaseOAuthClient<FoursquareProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Parameters:

body - the response body

Returns:

the user profile object

Throws:

HttpAction - whether an additional HTTP action is required