Package org.pac4j.oauth.client
Class TwitterClient
java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.IndirectClient
org.pac4j.oauth.client.OAuth10Client
org.pac4j.oauth.client.TwitterClient
- All Implemented Interfaces:
org.pac4j.core.client.Client
This class is the OAuth client to authenticate users in Twitter.
You can define if a screen should always been displayed for authorization confirmation by using the
setAlwaysConfirmAuthorization(boolean)
method (false
by default).
If your twitter oauth app allows requests for email addresses you can enable requesting an email
address by using the setIncludeEmail(boolean)
method (false
by default).
It returns a TwitterProfile
.
More information at https://dev.twitter.com/docs/api/1/get/account/verify_credentials
- Since:
- 1.0.0
- Author:
- Jerome Leleu
-
Field Summary
Fields inherited from class org.pac4j.oauth.client.OAuth10Client
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 TwitterClient.TwitterClient
(String key, String secret) Constructor for TwitterClient.TwitterClient
(String key, String secret, boolean includeEmail) Constructor for TwitterClient. -
Method Summary
Modifier and TypeMethodDescriptionprotected com.github.scribejava.core.builder.api.DefaultApi10a
getApi()
getApi.protected void
internalInit
(boolean forceReinit) boolean
isAlwaysConfirmAuthorization.boolean
isIncludeEmail.void
setAlwaysConfirmAuthorization
(boolean alwaysConfirmAuthorization) Setter for the fieldalwaysConfirmAuthorization
.void
setIncludeEmail
(boolean includeEmail) Setter for the fieldincludeEmail
.Methods inherited from class org.pac4j.oauth.client.OAuth10Client
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, findSessionLogoutHandler, getAuthenticator, getAuthorizationGenerators, getConfig, getCredentials, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setConfig, 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
-
TwitterClient
public TwitterClient()Constructor for TwitterClient.
-
TwitterClient
Constructor for TwitterClient.
-
TwitterClient
Constructor for TwitterClient.
-
-
Method Details
-
internalInit
protected void internalInit(boolean forceReinit) - Overrides:
internalInit
in classOAuth10Client
-
getApi
protected com.github.scribejava.core.builder.api.DefaultApi10a getApi()getApi.
- Returns:
- a
DefaultApi10a
object
-
isAlwaysConfirmAuthorization
public boolean isAlwaysConfirmAuthorization()isAlwaysConfirmAuthorization.
- Returns:
- a boolean
-
setAlwaysConfirmAuthorization
public void setAlwaysConfirmAuthorization(boolean alwaysConfirmAuthorization) Setter for the field
alwaysConfirmAuthorization
.- Parameters:
alwaysConfirmAuthorization
- a boolean
-
isIncludeEmail
public boolean isIncludeEmail()isIncludeEmail.
- Returns:
- a boolean
-
setIncludeEmail
public void setIncludeEmail(boolean includeEmail) Setter for the field
includeEmail
.- Parameters:
includeEmail
- a boolean
-