パッケージ twitter4j

クラス OAuthAuthorization

java.lang.Object

twitter4j.OAuthAuthorization

すべての実装されたインタフェース:

Serializable, Authorization

public class OAuthAuthorization
extends Object
implements Authorization, Serializable

関連項目:

• OAuth Core 1.0a
• 直列化された形式

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	クラス	説明
static class	OAuthAuthorization.OAuthAuthorizationBuilder	Builder for OAuthAuthorization

メソッドの概要

修飾子とタイプ	メソッド	説明
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 OAuthAuthorization.OAuthAuthorizationBuilder	newBuilder()
String	toString()

クラスから継承されたメソッド java.lang.Object

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

メソッドの詳細

newBuilder

public static OAuthAuthorization.OAuthAuthorizationBuilder newBuilder()

戻り値:

builder for OAuthAuthorization

getInstance

public static OAuthAuthorization getInstance(String consumerKey,
 String consumerSecret)

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

パラメータ:

consumerKey - consumer key

consumerSecret - consumer secret

戻り値:

OAuthAuthorization

getInstance

public static OAuthAuthorization getInstance()

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

戻り値:

OAuthAuthorization

getAuthorizationHeader

public String getAuthorizationHeader(twitter4j.HttpRequest req)

定義:

getAuthorizationHeader インタフェース内 Authorization

パラメータ:

req - request

戻り値:

header

isEnabled

public boolean isEnabled()

Returns true if authorization credentials are set.

定義:

isEnabled インタフェース内 Authorization

戻り値:

true if authorization credentials are set

getOAuthRequestToken

public RequestToken getOAuthRequestToken()
                                  throws TwitterException

Retrieves a request token

戻り値:

generated request token.

例外:

TwitterException - when Twitter service or network is unavailable

IllegalStateException - access token is already available

導入されたバージョン:

Twitter4J 2.0.0

関連項目:

• 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

パラメータ:

callbackURL - callback URL

戻り値:

generated request token

例外:

TwitterException - when Twitter service or network is unavailable

IllegalStateException - access token is already available

導入されたバージョン:

Twitter4J 2.0.0

関連項目:

• 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.

戻り値:

access token

例外:

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

IllegalStateException - when RequestToken has never been acquired

導入されたバージョン:

Twitter4J 2.0.0

関連項目:

• 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.

パラメータ:

oauthVerifier - OAuth verifier. AKA pin.

戻り値:

access token

例外:

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

導入されたバージョン:

Twitter4J 2.0.0

関連項目:

• 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.

パラメータ:

requestToken - the request token

戻り値:

access token associated with the supplied request token.

例外:

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

導入されたバージョン:

Twitter4J 2.0.0

関連項目:

• 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.

パラメータ:

requestToken - the request token

oauthVerifier - OAuth verifier. AKA pin.

戻り値:

access token associated with the supplied request token.

例外:

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

導入されたバージョン:

Twitter 2.1.1

関連項目:

• 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

例外:

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

encodeParameters

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

パラメータ:

httpParams - parameters to be encoded and concatenated

戻り値:

encoded string

関連項目:

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

equals

public boolean equals(Object o)

オーバーライド:

equals クラス内 Object

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 Object

toString

public String toString()

オーバーライド:

toString クラス内 Object