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
public class TwitterClient extends OAuth10Client
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
-
-
Constructor Summary
Constructors Constructor Description TwitterClient()
TwitterClient(java.lang.String key, java.lang.String secret)
TwitterClient(java.lang.String key, java.lang.String secret, boolean includeEmail)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected com.github.scribejava.core.builder.api.DefaultApi10a
getApi()
protected void
internalInit(boolean forceReinit)
boolean
isAlwaysConfirmAuthorization()
boolean
isIncludeEmail()
void
setAlwaysConfirmAuthorization(boolean alwaysConfirmAuthorization)
void
setIncludeEmail(boolean includeEmail)
-
Methods inherited from class org.pac4j.oauth.client.OAuth10Client
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
-
-
-
-
Method Detail
-
internalInit
protected void internalInit(boolean forceReinit)
- Overrides:
internalInit
in classOAuth10Client
-
getApi
protected com.github.scribejava.core.builder.api.DefaultApi10a getApi()
-
isAlwaysConfirmAuthorization
public boolean isAlwaysConfirmAuthorization()
-
setAlwaysConfirmAuthorization
public void setAlwaysConfirmAuthorization(boolean alwaysConfirmAuthorization)
-
isIncludeEmail
public boolean isIncludeEmail()
-
setIncludeEmail
public void setIncludeEmail(boolean includeEmail)
-
-