twitter4j

Class TwitterBaseImpl

java.lang.Object

twitter4j.TwitterBaseImpl

All Implemented Interfaces:

java.io.Serializable, OAuth2Support, OAuthSupport, TwitterBase

Direct Known Subclasses:

AsyncTwitterImpl, TwitterImpl, TwitterStreamImpl

abstract class TwitterBaseImpl
extends java.lang.Object
implements TwitterBase, java.io.Serializable, OAuthSupport, OAuth2Support

Base class of Twitter / AsyncTwitter / TwitterStream supports OAuth.

Author:

Yusuke Yamamoto - yusuke at mac.com

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Authorization	auth
(package private) Configuration	conf
(package private) ObjectFactory	factory
(package private) HttpClient	http
private long	id
private java.util.List<RateLimitStatusListener>	rateLimitStatusListeners
private java.lang.String	screenName
private static long	serialVersionUID
private static java.lang.String	WWW_DETAILS

Constructor Summary

Constructors

Constructor and Description
TwitterBaseImpl(Configuration conf, Authorization auth)

Method Summary

Modifier and Type	Method and Description
void	addRateLimitStatusListener(RateLimitStatusListener listener) Registers a RateLimitStatusListener for account associated rate limits
(package private) void	ensureAuthorizationEnabled()
(package private) void	ensureOAuthEnabled()
boolean	equals(java.lang.Object o)
(package private) User	fillInIDAndScreenName()
(package private) User	fillInIDAndScreenName(HttpParameter[] parameters)
Authorization	getAuthorization() Returns the authorization scheme for this instance. The returned type will be either of BasicAuthorization, OAuthAuthorization, or NullAuthorization
Configuration	getConfiguration() Returns the configuration associated with this instance
long	getId() Returns authenticating user's user id. This method may internally call verifyCredentials() on the first invocation if - this instance is authenticated by Basic and email address is supplied instead of screen name, or - this instance is authenticated by OAuth.
private OAuthSupport	getOAuth()
private OAuth2Support	getOAuth2()
OAuth2Token	getOAuth2Token() Obtains an OAuth 2 Bearer token.
AccessToken	getOAuthAccessToken() Returns an access token associated with this instance. If no access token is associated with this instance, this will retrieve a new access token.
AccessToken	getOAuthAccessToken(RequestToken requestToken) Retrieves an access token associated with the supplied request token and sets userId.
AccessToken	getOAuthAccessToken(RequestToken requestToken, java.lang.String oauthVerifier) Retrieves an access token associated with the supplied request token and sets userId.
AccessToken	getOAuthAccessToken(java.lang.String oauthVerifier) Retrieves an access token.
AccessToken	getOAuthAccessToken(java.lang.String screenName, java.lang.String password) Retrieves an access token associated with the supplied screen name and password using xAuth. In order to get access acquire AccessToken using xAuth, you must apply by sending an email to api@twitter.com — all other applications will receive an HTTP 401 error.
RequestToken	getOAuthRequestToken() Retrieves a request token
RequestToken	getOAuthRequestToken(java.lang.String callbackUrl) Retrieves a request token
RequestToken	getOAuthRequestToken(java.lang.String callbackUrl, java.lang.String xAuthAccessType) Retrieves a request token
RequestToken	getOAuthRequestToken(java.lang.String callbackUrl, java.lang.String xAuthAccessType, java.lang.String xAuthMode) Retrieves a request token
java.lang.String	getScreenName() Returns authenticating user's screen name. This method may internally call verifyCredentials() on the first invocation if - this instance is authenticated by Basic and email address is supplied instead of screen name, or - this instance is authenticated by OAuth. Note that this method returns a transiently cached (will be lost upon serialization) screen name while it is possible to change a user's screen name.
int	hashCode()
void	httpResponseReceived(HttpResponseEvent event)
private void	init()
void	invalidateOAuth2Token() Revokes an issued OAuth 2 Bearer Token.
void	onRateLimitReached(Consumer<RateLimitStatusEvent> action) Registers a RateLimitStatusListener for account associated rate limits
void	onRateLimitStatus(Consumer<RateLimitStatusEvent> action) Registers a lambda action for account associated rate limits
private void	readObject(java.io.ObjectInputStream stream)
(package private) void	setFactory()
void	setOAuth2Token(OAuth2Token oauth2Token) Sets the OAuth 2 Bearer token.
void	setOAuthAccessToken(AccessToken accessToken) Sets the access token
void	setOAuthConsumer(java.lang.String consumerKey, java.lang.String consumerSecret) sets the OAuth consumer key and consumer secret
java.lang.String	toString()
private void	writeObject(java.io.ObjectOutputStream out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

WWW_DETAILS

private static final java.lang.String WWW_DETAILS

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

conf

Configuration conf

screenName

private transient java.lang.String screenName

id

private transient long id

http

transient HttpClient http

rateLimitStatusListeners

private java.util.List<RateLimitStatusListener> rateLimitStatusListeners

factory

ObjectFactory factory

auth

Authorization auth

Constructor Detail

TwitterBaseImpl

TwitterBaseImpl(Configuration conf,
                Authorization auth)

Method Detail

init

private void init()

setFactory

void setFactory()

getScreenName

public java.lang.String getScreenName()
                               throws TwitterException,
                                      java.lang.IllegalStateException

Description copied from interface: TwitterBase

Returns authenticating user's screen name.
This method may internally call verifyCredentials() on the first invocation if
- this instance is authenticated by Basic and email address is supplied instead of screen name, or - this instance is authenticated by OAuth.
Note that this method returns a transiently cached (will be lost upon serialization) screen name while it is possible to change a user's screen name.

Specified by:

getScreenName in interface TwitterBase

Returns:

the authenticating screen name

Throws:

TwitterException - when verifyCredentials threw an exception.

java.lang.IllegalStateException - if no credentials are supplied. i.e.) this is an anonymous Twitter instance

getId

public long getId()
           throws TwitterException,
                  java.lang.IllegalStateException

Description copied from interface: TwitterBase

Returns authenticating user's user id.
This method may internally call verifyCredentials() on the first invocation if
- this instance is authenticated by Basic and email address is supplied instead of screen name, or - this instance is authenticated by OAuth.

Specified by:

getId in interface TwitterBase

Returns:

the authenticating user's id

Throws:

TwitterException - when verifyCredentials threw an exception.

java.lang.IllegalStateException - if no credentials are supplied. i.e.) this is an anonymous Twitter instance

fillInIDAndScreenName

User fillInIDAndScreenName()
                    throws TwitterException

Throws:

TwitterException

fillInIDAndScreenName

User fillInIDAndScreenName(HttpParameter[] parameters)
                    throws TwitterException

Throws:

TwitterException

addRateLimitStatusListener

public void addRateLimitStatusListener(RateLimitStatusListener listener)

Description copied from interface: TwitterBase

Registers a RateLimitStatusListener for account associated rate limits

Specified by:

addRateLimitStatusListener in interface TwitterBase

Parameters:

listener - the listener to be added

See Also:

Rate Limiting | Twitter Developers

onRateLimitStatus

public void onRateLimitStatus(Consumer<RateLimitStatusEvent> action)

Description copied from interface: TwitterBase

Registers a lambda action for account associated rate limits

Specified by:

onRateLimitStatus in interface TwitterBase

Parameters:

action - the action to be added

See Also:

Rate Limiting | Twitter Developers

onRateLimitReached

public void onRateLimitReached(Consumer<RateLimitStatusEvent> action)

Description copied from interface: TwitterBase

Registers a RateLimitStatusListener for account associated rate limits

Specified by:

onRateLimitReached in interface TwitterBase

Parameters:

action - the action to be added

See Also:

Rate Limiting | Twitter Developers

httpResponseReceived

public void httpResponseReceived(HttpResponseEvent event)

getAuthorization

public final Authorization getAuthorization()

Description copied from interface: TwitterBase

Returns the authorization scheme for this instance.
The returned type will be either of BasicAuthorization, OAuthAuthorization, or NullAuthorization

Specified by:

getAuthorization in interface TwitterBase

Returns:

the authorization scheme for this instance

getConfiguration

public Configuration getConfiguration()

Description copied from interface: TwitterBase

Returns the configuration associated with this instance

Specified by:

getConfiguration in interface TwitterBase

Returns:

configuration associated with this instance

ensureAuthorizationEnabled

final void ensureAuthorizationEnabled()

ensureOAuthEnabled

final void ensureOAuthEnabled()

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream stream)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

setOAuthConsumer

public void setOAuthConsumer(java.lang.String consumerKey,
                             java.lang.String consumerSecret)

Description copied from interface: OAuthSupport

sets the OAuth consumer key and consumer secret

Specified by:

setOAuthConsumer in interface OAuth2Support

Specified by:

setOAuthConsumer in interface OAuthSupport

Parameters:

consumerKey - OAuth consumer key

consumerSecret - OAuth consumer secret

getOAuthRequestToken

public RequestToken getOAuthRequestToken()
                                  throws TwitterException

Description copied from interface: OAuthSupport

Retrieves a request token

Specified by:

getOAuthRequestToken in interface OAuthSupport

Returns:

generated request token.

Throws:

TwitterException - when Twitter service or network is unavailable

See Also:

OAuth FAQ | Twitter Developers, OAuth Core 1.0a - 6.1. Obtaining an Unauthorized Request Token, POST oauth/request_token | Twitter Developers

getOAuthRequestToken

public RequestToken getOAuthRequestToken(java.lang.String callbackUrl)
                                  throws TwitterException

Description copied from interface: OAuthSupport

Retrieves a request token

Specified by:

getOAuthRequestToken in interface OAuthSupport

Parameters:

callbackUrl - callback URL

Returns:

generated request token

Throws:

TwitterException - when Twitter service or network is unavailable

See Also:

OAuth FAQ | Twitter Developers, OAuth Core 1.0a - 6.1. Obtaining an Unauthorized Request Token, POST oauth/request_token | Twitter Developers

getOAuthRequestToken

public RequestToken getOAuthRequestToken(java.lang.String callbackUrl,
                                         java.lang.String xAuthAccessType)
                                  throws TwitterException

Description copied from interface: OAuthSupport

Retrieves a request token

Specified by:

getOAuthRequestToken in interface OAuthSupport

Parameters:

callbackUrl - callback URL

xAuthAccessType - Overrides the access level an application requests to a users account. Supported values are read or write. This parameter is intended to allow a developer to register a read/write application but also request read only access when appropriate.

Returns:

generated request token

Throws:

TwitterException - when Twitter service or network is unavailable

See Also:

OAuth FAQ | Twitter Developers, OAuth Core 1.0a - 6.1. Obtaining an Unauthorized Request Token, POST oauth/request_token | Twitter Developers

getOAuthRequestToken

public RequestToken getOAuthRequestToken(java.lang.String callbackUrl,
                                         java.lang.String xAuthAccessType,
                                         java.lang.String xAuthMode)
                                  throws TwitterException

Description copied from interface: OAuthSupport

Retrieves a request token

Specified by:

getOAuthRequestToken in interface OAuthSupport

Parameters:

callbackUrl - callback URL

xAuthAccessType - Overrides the access level an application requests to a users account. Supported values are read or write. This parameter is intended to allow a developer to register a read/write application but also request read only access when appropriate.

xAuthMode - Set to reverse_auth to obtain a special request token to be used in the reverse auth process.

Returns:

generated request token

Throws:

TwitterException - when Twitter service or network is unavailable

See Also:

OAuth FAQ | Twitter Developers, OAuth Core 1.0a - 6.1. Obtaining an Unauthorized Request Token, POST oauth/request_token | Twitter Developers

getOAuthAccessToken

public AccessToken getOAuthAccessToken()
                                throws TwitterException

Returns an access token associated with this instance.
If no access token is associated with this instance, this will retrieve a new access token. Basic authenticated instance of this class will try acquiring an AccessToken using xAuth.
In order to get access acquire AccessToken using xAuth, you must apply by sending an email to api@twitter.com all other applications will receive an HTTP 401 error. Web-based applications will not be granted access, except on a temporary basis for when they are converting from basic-authentication support to full OAuth support.
Storage of Twitter usernames and passwords is forbidden. By using xAuth, you are required to store only access tokens and access token secrets. If the access token expires or is expunged by a user, you must ask for their login and password again before exchanging the credentials for an access token.

Specified by:

getOAuthAccessToken in interface OAuthSupport

Returns:

access token

Throws:

TwitterException - When Twitter service or network is unavailable, when the user has not authorized, or when the client application is not permitted to use xAuth

See Also:

xAuth | Twitter Developers

getOAuthAccessToken

public AccessToken getOAuthAccessToken(java.lang.String oauthVerifier)
                                throws TwitterException

Description copied from interface: OAuthSupport

Retrieves an access token.

Specified by:

getOAuthAccessToken in interface OAuthSupport

Parameters:

oauthVerifier - OAuth verifier. AKA pin.

Returns:

access token

Throws:

TwitterException - when Twitter service or network is unavailable, or the user has not authorized

See Also:

OAuth FAQ | dev.twitter.com - How long does an access token last?, OAuth Core 1.0a - 6.2. Obtaining User Authorization, POST oauth/access_token | Twitter Developers

getOAuthAccessToken

public AccessToken getOAuthAccessToken(RequestToken requestToken)
                                throws TwitterException

Description copied from interface: OAuthSupport

Retrieves an access token associated with the supplied request token and sets userId.

Specified by:

getOAuthAccessToken in interface OAuthSupport

Parameters:

requestToken - the request token

Returns:

access token associated with the supplied request token.

Throws:

TwitterException - when Twitter service or network is unavailable, or the user has not authorized

See Also:

OAuth FAQ | dev.twitter.com - How long does an access token last?, OAuth Core 1.0a - 6.2. Obtaining User Authorization, POST oauth/access_token | Twitter Developers

getOAuthAccessToken

public AccessToken getOAuthAccessToken(RequestToken requestToken,
                                       java.lang.String oauthVerifier)
                                throws TwitterException

Description copied from interface: OAuthSupport

Retrieves an access token associated with the supplied request token and sets userId.

Specified by:

getOAuthAccessToken in interface OAuthSupport

Parameters:

requestToken - the request token

oauthVerifier - OAuth verifier. AKA pin.

Returns:

access token associated with the supplied request token.

Throws:

TwitterException - when Twitter service or network is unavailable, or the user has not authorized

See Also:

OAuth Core 1.0a - 6.2. Obtaining User Authorization, POST oauth/access_token | Twitter Developers

setOAuthAccessToken

public void setOAuthAccessToken(AccessToken accessToken)

Description copied from interface: OAuthSupport

Sets the access token

Specified by:

setOAuthAccessToken in interface OAuthSupport

Parameters:

accessToken - accessToken

getOAuthAccessToken

public AccessToken getOAuthAccessToken(java.lang.String screenName,
                                       java.lang.String password)
                                throws TwitterException

Description copied from interface: OAuthSupport

Retrieves an access token associated with the supplied screen name and password using xAuth.
In order to get access acquire AccessToken using xAuth, you must apply by sending an email to api@twitter.com — all other applications will receive an HTTP 401 error. Web-based applications will not be granted access, except on a temporary basis for when they are converting from basic-authentication support to full OAuth support.
Storage of Twitter usernames and passwords is forbidden. By using xAuth, you are required to store only access tokens and access token secrets. If the access token expires or is expunged by a user, you must ask for their login and password again before exchanging the credentials for an access token.

Specified by:

getOAuthAccessToken in interface OAuthSupport

Parameters:

screenName - the screen name

password - the password

Returns:

access token associated with the supplied request token.

Throws:

TwitterException - when Twitter service or network is unavailable, or the user has not authorized

See Also:

OAuth FAQ | dev.twitter.com - How long does an access token last?, xAuth | Twitter Developers, POST oauth/access_token | Twitter Developers

getOAuth

private OAuthSupport getOAuth()

getOAuth2Token

public OAuth2Token getOAuth2Token()
                           throws TwitterException

Description copied from interface: OAuth2Support

Obtains an OAuth 2 Bearer token.

Specified by:

getOAuth2Token in interface OAuth2Support

Returns:

OAuth 2 Bearer token

Throws:

TwitterException - when Twitter service or network is unavailable, or connecting non-SSL endpoints.

See Also:

POST oauth2/token | Twitter Developers

setOAuth2Token

public void setOAuth2Token(OAuth2Token oauth2Token)

Description copied from interface: OAuth2Support

Sets the OAuth 2 Bearer token.

Specified by:

setOAuth2Token in interface OAuth2Support

Parameters:

oauth2Token - OAuth 2 Bearer token

invalidateOAuth2Token

public void invalidateOAuth2Token()
                           throws TwitterException

Description copied from interface: OAuth2Support

Revokes an issued OAuth 2 Bearer Token.

Specified by:

invalidateOAuth2Token in interface OAuth2Support

Throws:

TwitterException - when Twitter service or network is unavailable, or connecting non-SSL endpoints.

getOAuth2

private OAuth2Support getOAuth2()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object