org.pac4j.openid.client

Class YahooOpenIdClient

java.lang.Object

org.pac4j.core.util.InitializableObject

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

org.pac4j.openid.client.BaseOpenIdClient<YahooOpenIdProfile>

org.pac4j.openid.client.YahooOpenIdClient

All Implemented Interfaces:

Cloneable, Client<OpenIdCredentials,YahooOpenIdProfile>

public class YahooOpenIdClient
extends BaseOpenIdClient<YahooOpenIdProfile>

This class is the OpenID client to authenticate users with their yahoo account.

It returns a YahooOpenIdProfile.

Since:

1.6.0

Author:

Patrice de Saint Steban

See Also:

GoogleOpenIdProfile

Field Summary

Fields

Modifier and Type	Field and Description
static String	YAHOO_GENERIC_USER_IDENTIFIER

Fields inherited from class org.pac4j.openid.client.BaseOpenIdClient

DISCOVERY_INFORMATION

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, logger, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
YahooOpenIdClient()

Method Summary

Methods

Modifier and Type	Method and Description
protected YahooOpenIdProfile	createProfile(org.openid4java.message.AuthSuccess authSuccess) Create the appropriate OpenID profile.
protected org.openid4java.message.ax.FetchRequest	getFetchRequest() Get a fetch request for attributes.
protected String	getUser(WebContext context) Return the user identifier for the web context.
protected void	internalInit()
protected BaseClient<OpenIdCredentials,YahooOpenIdProfile>	newClient()
String	toString()

Methods inherited from class org.pac4j.openid.client.BaseOpenIdClient

getDiscoveryInformationSessionAttributeName, getMechanism, isDirectRedirection, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile

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

addAuthorizationGenerator, clone, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getRedirectAction, getRedirectionUrl, getStateParameter, getUserProfile, isEnableContextualRedirects, prependHostToUrlIfNotPresent, redirect, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setName

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

YAHOO_GENERIC_USER_IDENTIFIER

public static final String YAHOO_GENERIC_USER_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

YahooOpenIdClient

public YahooOpenIdClient()

Method Detail

internalInit

protected void internalInit()

Overrides:

internalInit in class BaseOpenIdClient<YahooOpenIdProfile>

newClient

protected BaseClient<OpenIdCredentials,YahooOpenIdProfile> newClient()

Specified by:

newClient in class BaseClient<OpenIdCredentials,YahooOpenIdProfile>

getUser

protected String getUser(WebContext context)

Description copied from class: BaseOpenIdClient

Return the user identifier for the web context.

Specified by:

getUser in class BaseOpenIdClient<YahooOpenIdProfile>

Returns:

the user identifier

getFetchRequest

protected org.openid4java.message.ax.FetchRequest getFetchRequest()
                                                           throws org.openid4java.message.MessageException

Description copied from class: BaseOpenIdClient

Get a fetch request for attributes.

Specified by:

getFetchRequest in class BaseOpenIdClient<YahooOpenIdProfile>

Returns:

a fetch request for attributes

Throws:

org.openid4java.message.MessageException

createProfile

protected YahooOpenIdProfile createProfile(org.openid4java.message.AuthSuccess authSuccess)
                                    throws org.openid4java.message.MessageException

Description copied from class: BaseOpenIdClient

Create the appropriate OpenID profile.

Specified by:

createProfile in class BaseOpenIdClient<YahooOpenIdProfile>

Returns:

the appropriate OpenID profile

Throws:

org.openid4java.message.MessageException

toString

public String toString()

Overrides:

toString in class BaseClient<OpenIdCredentials,YahooOpenIdProfile>