org.pac4j.openid.client

Class YahooOpenIdClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

org.pac4j.core.client.IndirectClient<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:

YahooOpenIdProfile

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.IndirectClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, NEEDS_CLIENT_REDIRECTION_PARAMETER

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

logger

Constructor Summary

Constructors

Constructor and Description
YahooOpenIdClient()

Method Summary

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(WebContext context) Internal initialization of the object.
protected BaseClient<OpenIdCredentials,YahooOpenIdProfile>	newClient() Create a new instance of the client.
String	toString()

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

getClientType, getDiscoveryInformationSessionAttributeName, isDirectRedirection, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile

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

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

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

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

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

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(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class BaseOpenIdClient<YahooOpenIdProfile>

Parameters:

context - the web context

newClient

protected BaseClient<OpenIdCredentials,YahooOpenIdProfile> newClient()

Description copied from class: BaseClient

Create a new instance of the client.

Specified by:

newClient in class BaseClient<OpenIdCredentials,YahooOpenIdProfile>

Returns:

A new instance of the client

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>

Parameters:

context - the web context

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 - an OpenID exception

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>

Parameters:

authSuccess - the authentication success message

Returns:

the appropriate OpenID profile

Throws:

org.openid4java.message.MessageException - an OpenID exception

toString

public String toString()

Overrides:

toString in class BaseClient<OpenIdCredentials,YahooOpenIdProfile>