Package org.pac4j.oauth.client

Class GenericOAuth20Client

java.lang.Object

org.pac4j.core.util.InitializableObject

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

org.pac4j.core.client.IndirectClient<OAuth20Credentials>

org.pac4j.oauth.client.OAuth20Client

org.pac4j.oauth.client.GenericOAuth20Client

All Implemented Interfaces:

Client<OAuth20Credentials>

public class GenericOAuth20Client
extends OAuth20Client

This class is a generic OAuth2 client to authenticate users in a standard OAuth2 server.

All configuration parameters can be specified setting the corresponding attribute.

It returns a OAuth20Profile.

Author:

Julio Arrebola

Field Summary

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

configuration

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver

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

logger

Constructor Summary

Constructors

Constructor	Description
GenericOAuth20Client()

Method Summary

Modifier and Type	Method	Description
protected void	clientInit()
String	getClientAuthenticationMethod()
String	getScope()
boolean	isWithState()
void	setAuthUrl(String authUrl)
void	setClientAuthenticationMethod(String clientAuthenticationMethod)
void	setCustomParams(Map<String,String> customParamsMap)
void	setProfileAttrs(Map<String,String> profileAttrsMap)
void	setProfileId(String profileId)
void	setProfileNodePath(String profilePath)
void	setProfileUrl(String profileUrl)
void	setProfileVerb(com.github.scribejava.core.model.Verb profileVerb)
void	setScope(String scope)
void	setTokenUrl(String tokenUrl)
void	setWithState(boolean withState)

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

getConfiguration, getKey, getSecret, setConfiguration, setKey, setSecret, toString

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

computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, internalInit, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getUserProfile, notifySessionRenewal, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated

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

init, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericOAuth20Client

public GenericOAuth20Client()

Method Detail

clientInit

protected void clientInit()

Overrides:

clientInit in class OAuth20Client

setAuthUrl

public void setAuthUrl(String authUrl)

setTokenUrl

public void setTokenUrl(String tokenUrl)

setProfileUrl

public void setProfileUrl(String profileUrl)

setProfileNodePath

public void setProfileNodePath(String profilePath)

setProfileVerb

public void setProfileVerb(com.github.scribejava.core.model.Verb profileVerb)

setProfileAttrs

public void setProfileAttrs(Map<String,String> profileAttrsMap)

setCustomParams

public void setCustomParams(Map<String,String> customParamsMap)

setProfileId

public void setProfileId(String profileId)

getScope

public String getScope()

setScope

public void setScope(String scope)

isWithState

public boolean isWithState()

setWithState

public void setWithState(boolean withState)

getClientAuthenticationMethod

public String getClientAuthenticationMethod()

setClientAuthenticationMethod

public void setClientAuthenticationMethod(String clientAuthenticationMethod)