OAuthAuthorization (twitter4j-ads 5.0 API)

java.lang.Object
- twitter4jads.auth.OAuthAuthorization

All Implemented Interfaces:: java.io.Serializable, Authorization, OAuthSupport

public class OAuthAuthorization
extends java.lang.Object
implements Authorization, java.io.Serializable, OAuthSupport

See Also:: OAuth Core 1.0a, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OAuthAuthorization(Configuration conf)

Constructors
Constructor and Description
`OAuthAuthorization(Configuration conf)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`encodeParameters(java.util.List<HttpParameter> httpParams)`
`static java.lang.String`	`encodeParameters(java.util.List<HttpParameter> httpParams, java.lang.String splitter, boolean quot)`
`boolean`	`equals(java.lang.Object o)`
`java.util.List<HttpParameter>`	`generateOAuthSignatureHttpParams(java.lang.String method, java.lang.String url)`
`java.lang.String`	`getAuthorizationHeader(HttpRequest req)`
`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
`int`	`hashCode()`
`boolean`	`isEnabled()` #{inheritDoc}
`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
`void`	`setOAuthRealm(java.lang.String realm)` Sets the OAuth realm
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OAuthAuthorization
```
public OAuthAuthorization(Configuration conf)
```
    Parameters:
    
    conf - configuration
- Method Detail
  - getAuthorizationHeader
```
public java.lang.String getAuthorizationHeader(HttpRequest req)
```
    Specified by:
    
    getAuthorizationHeader in interface Authorization
  - isEnabled
```
public boolean isEnabled()
```
    #{inheritDoc}
    
    Specified by:
    
    isEnabled in interface Authorization
    
    Returns:
    
    true if authorization credentials are set
  - getOAuthRequestToken
```
public RequestToken getOAuthRequestToken()
                                  throws TwitterException
```
    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
```
    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
```
    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
  - 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.
    
    Specified by:
    
    getOAuthAccessToken in interface OAuthSupport
    
    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(java.lang.String oauthVerifier)
                                throws TwitterException
```
    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
```
    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
```
    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
  - getOAuthAccessToken
```
public AccessToken getOAuthAccessToken(java.lang.String screenName,
                                       java.lang.String password)
                                throws TwitterException
```
    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
  - setOAuthAccessToken
```
public void setOAuthAccessToken(AccessToken accessToken)
```
    Sets the access token
    
    Specified by:
    
    setOAuthAccessToken in interface OAuthSupport
    
    Parameters:
    
    accessToken - accessToken
  - setOAuthRealm
```
public void setOAuthRealm(java.lang.String realm)
```
    Sets the OAuth realm
    
    Parameters:
    
    realm - OAuth realm
    
    Since:
    
    Twitter 2.1.4
  - generateOAuthSignatureHttpParams
```
public java.util.List<HttpParameter> generateOAuthSignatureHttpParams(java.lang.String method,
                                                                      java.lang.String url)
```
  - encodeParameters
```
public static java.lang.String encodeParameters(java.util.List<HttpParameter> httpParams)
```
    Parameters:
    
    httpParams - parameters to be encoded and concatenated
    
    Returns:
    
    encoded string
    
    See Also:
    
    OAuth / TestCases, Space encoding - OAuth | Google Groups
  - encodeParameters
```
public static java.lang.String encodeParameters(java.util.List<HttpParameter> httpParams,
                                                java.lang.String splitter,
                                                boolean quot)
```
  - 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 OAuthSupport
    
    Parameters:
    
    consumerKey - OAuth consumer key
    
    consumerSecret - OAuth consumer secret
  - 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

Class OAuthAuthorization

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OAuthAuthorization

Method Detail

getAuthorizationHeader

isEnabled

getOAuthRequestToken

getOAuthRequestToken

getOAuthRequestToken

getOAuthAccessToken

getOAuthAccessToken

getOAuthAccessToken

getOAuthAccessToken

getOAuthAccessToken

setOAuthAccessToken

setOAuthRealm

generateOAuthSignatureHttpParams

encodeParameters

encodeParameters

setOAuthConsumer

equals

hashCode

toString