Package org.pac4j.oauth.client
Class CasOAuthWrapperClient
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.CasOAuthWrapperClient
- All Implemented Interfaces:
org.pac4j.core.client.Client
This class is the OAuth client to authenticate users on CAS servers using OAuth wrapper.
The url of the OAuth endpoint of the CAS server must be set by using the setCasOAuthUrl(String)
method.
It returns a CasOAuthWrapperProfile
.
More information at https://wiki.jasig.org/display/CASUM/OAuth+server+support
- Since:
- 1.3.0
- Author:
- Jerome Leleu
-
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
ConstructorDescriptionConstructor for CasOAuthWrapperClient.CasOAuthWrapperClient
(String key, String secret, String casOAuthUrl) Constructor for CasOAuthWrapperClient. -
Method Summary
Modifier and TypeMethodDescriptioncom.github.scribejava.core.model.Verb
Getter for the fieldaccessTokenVerb
.Getter for the fieldcasLogoutUrl
.Getter for the fieldcasOAuthUrl
.protected void
internalInit
(boolean forceReinit) boolean
isImplicitFlow.boolean
isJsonTokenExtractor.void
setAccessTokenVerb
(com.github.scribejava.core.model.Verb accessTokenVerb) Setter for the fieldaccessTokenVerb
.void
setCasLogoutUrl
(String casLogoutUrl) Setter for the fieldcasLogoutUrl
.void
setCasOAuthUrl
(String casOAuthUrl) Setter for the fieldcasOAuthUrl
.void
setImplicitFlow
(boolean implicitFlow) Setter for the fieldimplicitFlow
.void
setJsonTokenExtractor
(boolean jsonTokenExtractor) setJsonTokenExtractor.Methods inherited from class org.pac4j.oauth.client.OAuth20Client
beforeInternalInit, getKey, getSecret, setKey, setSecret
Methods inherited from class org.pac4j.core.client.IndirectClient
afterInternalInit, checkCredentials, computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getLogoutAction, getLogoutActionBuilder, getLogoutProcessor, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, processLogout, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setLogoutActionBuilderIfUndefined, setLogoutProcessor, setLogoutProcessorIfUndefined, setRedirectionActionBuilder, setRedirectionActionBuilderIfUndefined, setUrlResolver, toString
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, getAuthenticator, getAuthorizationGenerators, getCredentials, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession, validateCredentials
Methods inherited from class org.pac4j.core.util.InitializableObject
getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize
-
Constructor Details
-
Method Details
-
internalInit
protected void internalInit(boolean forceReinit) - Overrides:
internalInit
in classOAuth20Client
-
getCasOAuthUrl
Getter for the field
casOAuthUrl
.- Returns:
- a
String
object
-
setCasOAuthUrl
Setter for the field
casOAuthUrl
.- Parameters:
casOAuthUrl
- aString
object
-
isImplicitFlow
public boolean isImplicitFlow()isImplicitFlow.
- Returns:
- a boolean
-
setImplicitFlow
public void setImplicitFlow(boolean implicitFlow) Setter for the field
implicitFlow
.- Parameters:
implicitFlow
- a boolean
-
getCasLogoutUrl
Getter for the field
casLogoutUrl
.- Returns:
- a
String
object
-
setCasLogoutUrl
Setter for the field
casLogoutUrl
.- Parameters:
casLogoutUrl
- aString
object
-
isJsonTokenExtractor
public boolean isJsonTokenExtractor()isJsonTokenExtractor.
- Returns:
- a boolean
-
setJsonTokenExtractor
public void setJsonTokenExtractor(boolean jsonTokenExtractor) setJsonTokenExtractor.
- Parameters:
jsonTokenExtractor
- a boolean
-
getAccessTokenVerb
public com.github.scribejava.core.model.Verb getAccessTokenVerb()Getter for the field
accessTokenVerb
.- Returns:
- a
Verb
object
-
setAccessTokenVerb
public void setAccessTokenVerb(com.github.scribejava.core.model.Verb accessTokenVerb) Setter for the field
accessTokenVerb
.- Parameters:
accessTokenVerb
- aVerb
object
-