public class TwitterRESTService

  1. Object
  2. ConnectionRequest
  3. TwitterRESTService

ImplementsIOProgressListener

Calls to the Twitter REST API can be performed via this class although currently support for authentication isn’t implemented due to the transition to oAuth instead of basic authentication.

Fields

public static final String METHOD_USER_TIMELINE = "statuses/user_timeline"
public static final String METHOD_TWEETS = "search/tweets"

Constructors

public TwitterRESTService(String method)The constructor accepts the method to invoke
public TwitterRESTService(String method, boolean post)The constructor accepts the method to invoke
public TwitterRESTService(String method, String version, boolean post)The constructor accepts the method to invoke

Methods

public static String initToken(String consumerKey, String consumerSecret)Logs in to twitter as an application
public static void setToken(String token)For every request twitter now needs an authorization token
public boolean equals(Object o)Indicates whether some other object is “equal to” this one.
public int hashCode()Returns a hash code value for the object.
protected void readResponse(InputStream input) throws IOExceptionCallback for the server response with the input stream from the server.
public Hashtable<String, Object> getParseTree()Returns the full Hashtable parse tree read from the server
public int getStatusesCount()Returns the number of statuses within the response
public Hashtable<String, Object> getStatus(int offset)Returns the status at the given offset
public String getIdStr()Gets the id string of the first entry which is important if we want to set the id to start with in the next request

Inherited nested types

Inherited fields

Inherited methods

From ConnectionRequest

getDefaultCacheMode, setDefaultCacheMode, isReadResponseForErrorsDefault, setReadResponseForErrorsDefault, isHandleErrorCodesInGlobalErrorHandler, setHandleErrorCodesInGlobalErrorHandler, getCookieHeader, setCookieHeader, isCookiesEnabledDefault, setCookiesEnabledDefault, isDefaultFollowRedirects, setDefaultFollowRedirects, isReadTimeoutSupported, purgeCacheDirectory, getDefaultUserAgent, setDefaultUserAgent, setUseNativeCookieStore, isNativeCookieSharingSupported, fetchJSON, fetchJSONAsync, getCacheMode, setCacheMode, isCheckSSLCertificates, setCheckSSLCertificates, isInsecure, setInsecure, getResponseData, getHttpMethod, setHttpMethod, addRequestHeader, removeRequestHeader, removeRequestHeaderIfUnchanged, checkSSLCertificates, getReadTimeout, setReadTimeout, initConnection, getCachedData, purgeCache, cacheUnmodified, cookieReceived, cookieSent, initCookieHeader, getResponseCode, getResposeCode, shouldConvertPostToGetOnRedirect, readHeaders, readErrorCodeHeaders, getHeader, getHeaders, getHeaderFieldNames, getYield, shouldAutoCloseResponse, handleIOException, handleRuntimeException, handleException, canGetSSLCertificates, getSSLCertificates, handleErrorResponseCode, retry, onRedirect, postResponse, createRequestURL, buildRequestBody, shouldWriteUTFAsGetBytes, kill, shouldStop, isPausable, pause, resume, isPost, setPost, addArgument, removeArgument, removeAllArguments, addArgumentNoEncoding, addArgumentNoEncoding, addArgumentNoEncodingArray, addArgument, addArgumentArray, addArgument, addArguments, getContentType, setContentType, isWriteRequest, setWriteRequest, isReadRequest, setReadRequest, isPaused, setPaused, isKilled, setKilled, getPriority, setPriority, getUserAgent, setUserAgent, isFollowRedirects, setFollowRedirects, getTimeout, setTimeout, getContentLength, ioStreamUpdate, getUrl, setUrl, addResponseListener, removeResponseListener, addResponseCodeListener, addExceptionListener, removeResponseCodeListener, removeExceptionListener, hasResponseListeners, fireResponseListener, isDuplicateSupported, setDuplicateSupported, validate, getDisposeOnCompletion, setDisposeOnCompletion, getShowOnInit, setShowOnInit, getSilentRetryCount, setSilentRetryCount, isFailSilently, setFailSilently, isReadResponseForErrors, setReadResponseForErrors, getResponseContentType, isRedirecting, getDestinationFile, setDestinationFile, getDestinationStorage, setDestinationStorage, isCookiesEnabled, setCookiesEnabled, setChunkedStreamingMode, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, getRequestBody, setRequestBody, setRequestBody, getRequestBodyData, getResponseErrorMessage

Field details

METHOD_USER_TIMELINE

public static final String METHOD_USER_TIMELINE = "statuses/user_timeline"

METHOD_TWEETS

public static final String METHOD_TWEETS = "search/tweets"

Constructor details

TwitterRESTService

public TwitterRESTService(String method)
The constructor accepts the method to invoke

Parameters

method String
the api method to invoke e.g. “statuses/public_timeline”

TwitterRESTService

public TwitterRESTService(String method, boolean post)
The constructor accepts the method to invoke

Parameters

method String
the api method to invoke e.g. “statuses/public_timeline”
post boolean
true for post requests and false for get request

TwitterRESTService

public TwitterRESTService(String method, String version, boolean post)
The constructor accepts the method to invoke

Parameters

method String
the api method to invoke e.g. “statuses/public_timeline”
version String
the API version to send e.g. “1”
post boolean
true for post requests and false for get request

Method details

initToken

public static String initToken(String consumerKey, String consumerSecret)
Logs in to twitter as an application

Parameters

consumerKey String
the key to login with
consumerSecret String
the secret to to login with

Returns

the authorization token

setToken

public static void setToken(String token)
For every request twitter now needs an authorization token

Parameters

token String
the token

equals

public boolean equals(Object o)
Indicates whether some other object is “equal to” this one. The equals method implements an equivalence relation: It is reflexive: for any reference value x, x.equals(x) should return true. It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified. For any non-null reference value x, x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables. As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

readResponse

protected void readResponse(InputStream input) throws IOException
Callback for the server response with the input stream from the server. This method is invoked on the network thread

Parameters

input InputStream
the input stream containing the response

Throws

IOException
when a read input occurs

getParseTree

public Hashtable<String, Object> getParseTree()
Returns the full Hashtable parse tree read from the server

Returns

the parse tree

getStatusesCount

public int getStatusesCount()
Returns the number of statuses within the response

Returns

the number of statuses

getStatus

public Hashtable<String, Object> getStatus(int offset)
Returns the status at the given offset

Parameters

offset int
the offset for the status

Returns

the status hashtable

getIdStr

public String getIdStr()
Gets the id string of the first entry which is important if we want to set the id to start with in the next request

Returns

the id of the first entry