Package org.pac4j.oauth.client
Class GenericOAuth20Client
java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.IndirectClient
org.pac4j.oauth.client.OAuth20Client
org.pac4j.oauth.client.GenericOAuth20Client
- All Implemented Interfaces:
org.pac4j.core.client.Client
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, saveProfileInSession
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttributeConverter
(Class<org.pac4j.core.profile.converter.AbstractAttributeConverter> converter) Add attribute converter.getScope()
protected void
internalInit
(boolean forceReinit) boolean
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
void
setTokenUrl
(String tokenUrl) void
setWithState
(boolean withState) Methods inherited from class org.pac4j.oauth.client.OAuth20Client
beforeInternalInit, getConfiguration, getKey, getSecret, setConfiguration, setKey, setSecret, toString
Methods inherited from class org.pac4j.core.client.IndirectClient
afterInternalInit, computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getUserProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession
Methods inherited from class org.pac4j.core.util.InitializableObject
getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize
-
Constructor Details
-
GenericOAuth20Client
public GenericOAuth20Client()
-
-
Method Details
-
internalInit
protected void internalInit(boolean forceReinit) - Overrides:
internalInit
in classOAuth20Client
-
setAuthUrl
-
setTokenUrl
-
setProfileUrl
-
setProfileNodePath
-
setProfileVerb
public void setProfileVerb(com.github.scribejava.core.model.Verb profileVerb) -
setProfileAttrs
-
setCustomParams
-
setProfileId
-
getScope
-
setScope
-
isWithState
public boolean isWithState() -
setWithState
public void setWithState(boolean withState) -
getClientAuthenticationMethod
-
setClientAuthenticationMethod
-
getConverters
-
addAttributeConverter
public void addAttributeConverter(Class<org.pac4j.core.profile.converter.AbstractAttributeConverter> converter) Add attribute converter.- Parameters:
converter
- the converter
-