org.pac4j.oauth.client

Class YahooClient

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.BaseOAuth10Client<YahooProfile>

org.pac4j.oauth.client.YahooClient

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,YahooProfile>

public class YahooClient
extends BaseOAuth10Client<YahooProfile>

This class is the OAuth client to authenticate users in Yahoo.

It returns a YahooProfile.

More information at http://developer.yahoo.com/social/rest_api_guide/extended-profile-resource.html

Since:

1.0.0

Author:

Jerome Leleu

See Also:

YahooProfile

Field Summary

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

logger, OAUTH_TOKEN, OAUTH_VERIFIER, REQUEST_TOKEN

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
YahooClient()
YahooClient(String key, String secret)

Method Summary

Modifier and Type	Method and Description
protected YahooProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
protected String	getProfileUrl(org.scribe.model.Token accessToken) Retrieve the url of the profile of the authenticated user for the provider.
protected boolean	hasBeenCancelled(WebContext context) Return if the authentication has been cancelled.
protected void	internalInit()
protected YahooClient	newClient()
protected YahooProfile	retrieveUserProfileFromToken(org.scribe.model.Token accessToken) Retrieve the user profile from the access token.

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

addAccessTokenToProfile, getAccessToken, getOAuthCredentials, getRequestTokenSessionAttributeName, isDirectRedirection, retrieveAuthorizationUrl

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

clone, createProxyRequest, getConnectTimeout, getKey, getMechanism, getProxyHost, getProxyPort, getReadTimeout, getSecret, getUserProfile, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, 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, getStateParameter, 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

Constructor Detail

YahooClient

public YahooClient()

YahooClient

public YahooClient(String key,
                   String secret)

Method Detail

newClient

protected YahooClient newClient()

Specified by:

newClient in class BaseClient<OAuthCredentials,YahooProfile>

internalInit

protected void internalInit()

Overrides:

internalInit in class BaseOAuthClient<YahooProfile>

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<YahooProfile>

Parameters:

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

Returns:

the url of the user profile given by the provider

retrieveUserProfileFromToken

protected YahooProfile retrieveUserProfileFromToken(org.scribe.model.Token accessToken)

Retrieve the user profile from the access token.

Overrides:

retrieveUserProfileFromToken in class BaseOAuthClient<YahooProfile>

Parameters:

accessToken - the access token

Returns:

the user profile

extractUserProfile

protected YahooProfile 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<YahooProfile>

Parameters:

body - the response body

Returns:

the user profile object

hasBeenCancelled

protected boolean hasBeenCancelled(WebContext context)

Description copied from class: BaseOAuthClient

Return if the authentication has been cancelled.

Specified by:

hasBeenCancelled in class BaseOAuthClient<YahooProfile>

Parameters:

context - the web context.

Returns:

if the authentication has been cancelled.