Package org.pac4j.oauth.client

Class TwitterClient

java.lang.Object

org.pac4j.core.util.InitializableObject

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

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

org.pac4j.oauth.client.OAuth10Client

org.pac4j.oauth.client.TwitterClient

All Implemented Interfaces:

Client<OAuth10Credentials>

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

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
TwitterClient()
TwitterClient(String key, String secret)
TwitterClient(String key, String secret, boolean includeEmail)

Method Summary

Modifier and Type	Method	Description
protected void	clientInit()
protected com.github.scribejava.core.builder.api.DefaultApi10a	getApi()
boolean	isAlwaysConfirmAuthorization()
boolean	isIncludeEmail()
void	setAlwaysConfirmAuthorization(boolean alwaysConfirmAuthorization)
void	setIncludeEmail(boolean includeEmail)

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

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

TwitterClient

public TwitterClient()

TwitterClient

public TwitterClient(String key,
                     String secret)

TwitterClient

public TwitterClient(String key,
                     String secret,
                     boolean includeEmail)

Method Detail

clientInit

protected void clientInit()

Overrides:

clientInit in class OAuth10Client

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)