Package twitter4j

Class OAuthAuthorization

java.lang.Object

twitter4j.OAuthAuthorization

All Implemented Interfaces:

Serializable, Authorization

public class OAuthAuthorization
extends Object
implements Authorization, Serializable

See Also:

• OAuth Core 1.0a
• Serialized Form

Method Summary

Modifier and Type	Method	Description
static String	encodeParameters(List<twitter4j.HttpParameter> httpParams)
boolean	equals(Object o)
String	getAuthorizationHeader(twitter4j.HttpRequest req)
static OAuthAuthorization	getInstance()	Equivalent to OAuthAuthorization.newBuilder().build();
static OAuthAuthorization	getInstance(String consumerKey, String consumerSecret)	Equivalent to OAuthAuthorization.newBuilder().oAuthConsumer(key, secret).build();
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(String oauthVerifier)	Retrieves an access token.
AccessToken	getOAuthAccessToken(RequestToken requestToken)	Retrieves an access token associated with the supplied request token and sets userId.
AccessToken	getOAuthAccessToken(RequestToken requestToken, String oauthVerifier)	Retrieves an access token associated with the supplied request token and sets userId.
RequestToken	getOAuthRequestToken()	Retrieves a request token
RequestToken	getOAuthRequestToken(String callbackURL)	Retrieves a request token
int	hashCode()
void	invalidateOAuthToken()	Invalidates the OAuth token
boolean	isEnabled()	Returns true if authorization credentials are set.
static twitter4j.OAuthAuthorization.OAuthAuthorizationBuilder	newBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static twitter4j.OAuthAuthorization.OAuthAuthorizationBuilder newBuilder()

Returns:

builder for OAuthAuthorization

getInstance

public static OAuthAuthorization getInstance(String consumerKey,
 String consumerSecret)

Equivalent to OAuthAuthorization.newBuilder().oAuthConsumer(key, secret).build();

Parameters:

consumerKey - consumer key

consumerSecret - consumer secret

Returns:

OAuthAuthorization

getInstance

public static OAuthAuthorization getInstance()

Equivalent to OAuthAuthorization.newBuilder().build();

Returns:

OAuthAuthorization

getAuthorizationHeader

public String getAuthorizationHeader(twitter4j.HttpRequest req)

Specified by:

getAuthorizationHeader in interface Authorization

Parameters:

req - request

Returns:

header

isEnabled

public boolean isEnabled()

Returns true if authorization credentials are set.

Specified by:

isEnabled in interface Authorization

Returns:

true if authorization credentials are set

getOAuthRequestToken

public RequestToken getOAuthRequestToken()
                                  throws TwitterException

Retrieves a request token

Returns:

generated request token.

Throws:

TwitterException - when Twitter service or network is unavailable

IllegalStateException - access token is already available

Since:

Twitter4J 2.0.0

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(String callbackURL)
                                  throws TwitterException

Retrieves a request token

Parameters:

callbackURL - callback URL

Returns:

generated request token

Throws:

TwitterException - when Twitter service or network is unavailable

IllegalStateException - access token is already available

Since:

Twitter4J 2.0.0

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.

Returns:

access token

Throws:

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

IllegalStateException - when RequestToken has never been acquired

Since:

Twitter4J 2.0.0

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(String oauthVerifier)
                                throws TwitterException

Retrieves an access token.

Parameters:

oauthVerifier - OAuth verifier. AKA pin.

Returns:

access token

Throws:

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

Since:

Twitter4J 2.0.0

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

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

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

Since:

Twitter4J 2.0.0

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,
 String oauthVerifier)
                                throws TwitterException

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

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

Since:

Twitter 2.1.1

See Also:

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

invalidateOAuthToken

public void invalidateOAuthToken()
                          throws TwitterException

Invalidates the OAuth token

On success, sets oauthToken to null

Throws:

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

encodeParameters

public static String encodeParameters(List<twitter4j.HttpParameter> httpParams)

Parameters:

httpParams - parameters to be encoded and concatenated

Returns:

encoded string

See Also:

• OAuth / TestCases
• Space encoding - OAuth | Google Groups

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object