TwitterStream

java.lang.Object
- twitter4j.TwitterBase
- - twitter4j.TwitterOAuthSupportBase
  - - twitter4j.TwitterOAuthSupportBaseImpl
    - - twitter4j.TwitterStream

All Implemented Interfaces:

java.io.Serializable, OAuthSupport, twitter4j.internal.http.HttpResponseCode, twitter4j.internal.http.HttpResponseListener
```
public final class TwitterStream
extends TwitterOAuthSupportBaseImpl
implements java.io.Serializable
```
A java representation of the Streaming API: Methods
Note that this class is NOT compatible with Google App Engine as GAE is not capable of handling requests longer than 30 seconds.

Since:

Twitter4J 2.0.4

Author:

Yusuke Yamamoto - yusuke at mac.com

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) class TwitterStream.StreamHandlingThread

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`TwitterStream.StreamHandlingThread`

Field Summary

Fields
Modifier and Type	Field and Description
`private TwitterStream.StreamHandlingThread`	`handler`
`private twitter4j.internal.http.HttpClientWrapper`	`http`
`private static int`	`HTTP_ERROR_INITIAL_WAIT`
`private static int`	`HTTP_ERROR_WAIT_CAP`
`private java.util.List<ConnectionLifeCycleListener>`	`lifeCycleListeners`
`private static twitter4j.internal.logging.Logger`	`logger`
`private static int`	`NO_WAIT`
`private static long`	`serialVersionUID`
`private java.util.List<StatusListener>`	`statusListeners`
`private static int`	`TCP_ERROR_INITIAL_WAIT`
`private static int`	`TCP_ERROR_WAIT_CAP`

Fields inherited from class twitter4j.TwitterOAuthSupportBaseImpl
id, screenName

Fields inherited from class twitter4j.TwitterOAuthSupportBase
rateLimitStatusListener

Fields inherited from class twitter4j.TwitterBase
auth, conf

Fields inherited from interface twitter4j.internal.http.HttpResponseCode
BAD_GATEWAY, BAD_REQUEST, ENHANCE_YOUR_CLAIM, FORBIDDEN, FOUND, INTERNAL_SERVER_ERROR, MULTIPLE_CHOICES, NOT_ACCEPTABLE, NOT_FOUND, NOT_MODIFIED, OK, SERVICE_UNAVAILABLE, UNAUTHORIZED

Constructor Summary

Constructors
Constructor and Description
`TwitterStream()` Deprecated. use `TwitterStreamFactory.getInstance()` instead.
`TwitterStream(Configuration conf, Authorization auth, StatusListener listener)`
`TwitterStream(java.lang.String screenName, java.lang.String password)` Deprecated. use `TwitterStreamFactory.getInstance()` instead.
`TwitterStream(java.lang.String screenName, java.lang.String password, StatusListener listener)` Deprecated. use `TwitterStreamFactory.getInstance()` instead.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addConnectionLifeCycleListener(ConnectionLifeCycleListener listener)` Adds a ConnectionLifeCycleListener
`void`	`addStatusListener(StatusListener statusListener)`
`void`	`addUserStreamListener(UserStreamListener userStreamListener)`
`void`	`cleanup()` Deprecated. use #cleanUp instead
`void`	`cleanUp()` shutdown internal stream consuming thread
`void`	`filter(FilterQuery query)` Start consuming public statuses that match one or more filter predicates.
`void`	`filter(int count, int[] follow, java.lang.String[] track)` Deprecated. use `filter(FilterQuery)` instead
`void`	`firehose(int count)` Starts listening on all public statuses.
`private StatusStream`	`getCountStream(java.lang.String relativeUrl, int count)`
`StatusStream`	`getFilterStream(FilterQuery query)` Returns public statuses that match one or more filter predicates.
`StatusStream`	`getFilterStream(int count, int[] follow, java.lang.String[] track)` Deprecated. use `getFilterStream(FilterQuery)` instead
`StatusStream`	`getFirehoseStream(int count)` Returns a status stream of all public statuses.
`StatusStream`	`getLinksStream(int count)` Returns a status stream of all public statuses containing links.
`StatusStream`	`getRetweetStream()` Returns a stream of all retweets.
`StatusStream`	`getSampleStream()` Returns a stream of random sample of all public statuses.
`UserStream`	`getUserStream()` User Streams provides real-time updates of all data needed to update a desktop application display.
`void`	`links(int count)` Starts listening on all public statuses containing links.
`void`	`retweet()` Starts listening on all retweets.
`void`	`sample()` Starts listening on random sample of all public statuses.
`void`	`setStatusListener(StatusListener statusListener)` Deprecated. use #addStatusListener instead.
`void`	`setUserStreamListener(UserStreamListener userStreamListener)` Deprecated. use #addStatusListener instead
`private void`	`startHandler(TwitterStream.StreamHandlingThread handler)`
`private void`	`startUserStreamHandler(TwitterStream.StreamHandlingThread handler)`
`void`	`stream(java.lang.String relativeUrl, int count, boolean handleUserStream)` Starts listening on a tweet stream.
`void`	`user()` User Streams provides real-time updates of all data needed to update a desktop application display.

Methods inherited from class twitter4j.TwitterOAuthSupportBaseImpl
getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthRequestToken, getOAuthRequestToken, isOAuthEnabled, setOAuthAccessToken, setOAuthAccessToken, setOAuthConsumer

Methods inherited from class twitter4j.TwitterOAuthSupportBase
equals, hashCode, httpResponseReceived, setRateLimitStatusListener, shutdown

Methods inherited from class twitter4j.TwitterBase
ensureAuthorizationEnabled, ensureBasicEnabled, getAuthorization, isBasicAuthEnabled, toString

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

- Field Detail
  - http
```
private final twitter4j.internal.http.HttpClientWrapper http
```
  - logger
```
private static final twitter4j.internal.logging.Logger logger
```
  - statusListeners
```
private java.util.List<StatusListener> statusListeners
```
  - lifeCycleListeners
```
private java.util.List<ConnectionLifeCycleListener> lifeCycleListeners
```
  - handler
```
private TwitterStream.StreamHandlingThread handler
```
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - TCP_ERROR_INITIAL_WAIT
```
private static final int TCP_ERROR_INITIAL_WAIT
```
    See Also:
    Constant Field Values
  - TCP_ERROR_WAIT_CAP
```
private static final int TCP_ERROR_WAIT_CAP
```
    See Also:
    Constant Field Values
  - HTTP_ERROR_INITIAL_WAIT
```
private static final int HTTP_ERROR_INITIAL_WAIT
```
    See Also:
    Constant Field Values
  - HTTP_ERROR_WAIT_CAP
```
private static final int HTTP_ERROR_WAIT_CAP
```
    See Also:
    Constant Field Values
  - NO_WAIT
```
private static final int NO_WAIT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - TwitterStream
```
public TwitterStream()
```
    Deprecated. use TwitterStreamFactory.getInstance() instead.
    
    Constructs a TwitterStream instance. UserID and password should be provided by either twitter4j.properties or system property. since Twitter4J 2.0.10
  - TwitterStream
```
public TwitterStream(java.lang.String screenName,
             java.lang.String password)
```
    Deprecated. use TwitterStreamFactory.getInstance() instead.
    
    Constructs a TwitterStream instance. UserID and password should be provided by either twitter4j.properties or system property. since Twitter4J 2.0.10
    
    Parameters:
    screenName - screen name
    password - password
  - TwitterStream
```
public TwitterStream(java.lang.String screenName,
             java.lang.String password,
             StatusListener listener)
```
    Deprecated. use TwitterStreamFactory.getInstance() instead.
    
    Constructs a TwitterStream instance. UserID and password should be provided by either twitter4j.properties or system property. since Twitter4J 2.0.10
    
    Parameters:
    screenName - screen name
    password - password
    listener - listener
  - TwitterStream
```
TwitterStream(Configuration conf,
             Authorization auth,
             StatusListener listener)
```
- Method Detail
  - firehose
```
public void firehose(int count)
```
    Starts listening on all public statuses. Available only to approved parties and requires a signed agreement to access. Please do not contact us about access to the firehose. If your service warrants access to it, we'll contact you.
    
    Parameters:
    count - Indicates the number of previous statuses to stream before transitioning to the live stream.
    Since:
    
    Twitter4J 2.0.4
    
    See Also:
    StatusStream, Streaming API: Methods statuses/firehose
  - getFirehoseStream
```
public StatusStream getFirehoseStream(int count)
                               throws TwitterException
```
    Returns a status stream of all public statuses. Available only to approved parties and requires a signed agreement to access. Please do not contact us about access to the firehose. If your service warrants access to it, we'll contact you.
    
    Parameters:
    count - Indicates the number of previous statuses to stream before transitioning to the live stream.
    
    Returns:
    StatusStream
    
    Throws:
    
    TwitterException - when Twitter service or network is unavailable
    Since:
    
    Twitter4J 2.0.4
    
    See Also:
    StatusStream, Streaming API: Methods statuses/firehose
  - links
```
public void links(int count)
```
    Starts listening on all public statuses containing links. Available only to approved parties and requires a signed agreement to access. Please do not contact us about access to the links stream. If your service warrants access to it, we'll contact you.
    
    Parameters:
    count - Indicates the number of previous statuses to stream before transitioning to the live stream.
    Since:
    
    Twitter4J 2.1.1
    
    See Also:
    StatusStream, Streaming API: Methods statuses/links
  - getLinksStream
```
public StatusStream getLinksStream(int count)
                            throws TwitterException
```
    Returns a status stream of all public statuses containing links. Available only to approved parties and requires a signed agreement to access. Please do not contact us about access to the links stream. If your service warrants access to it, we'll contact you.
    
    Parameters:
    count - Indicates the number of previous statuses to stream before transitioning to the live stream.
    
    Returns:
    StatusStream
    
    Throws:
    
    TwitterException - when Twitter service or network is unavailable
    Since:
    
    Twitter4J 2.1.1
    
    See Also:
    StatusStream, Streaming API: Methods statuses/links
  - stream
```
public void stream(java.lang.String relativeUrl,
          int count,
          boolean handleUserStream)
```
    Starts listening on a tweet stream.
    
    Parameters:
    relativeUrl - The relative url of the feed, for example "statuses/firehose.json" for the firehose.
    count - Indicates the number of previous statuses to stream before transitioning to the live stream.
  - getCountStream
```
private StatusStream getCountStream(java.lang.String relativeUrl,
                          int count)
                             throws TwitterException
```
    Throws:
    
    TwitterException
  - retweet
```
public void retweet()
```
    Starts listening on all retweets. The retweet stream is not a generally available resource. Few applications require this level of access. Creative use of a combination of other resources and various access levels can satisfy nearly every application use case. As of 9/11/2009, the site-wide retweet feature has not yet launched, so there are currently few, if any, retweets on this stream.
    
    Since:
    
    Twitter4J 2.0.10
    
    See Also:
    StatusStream, Streaming API: Methods statuses/retweet
  - getRetweetStream
```
public StatusStream getRetweetStream()
                              throws TwitterException
```
    Returns a stream of all retweets. The retweet stream is not a generally available resource. Few applications require this level of access. Creative use of a combination of other resources and various access levels can satisfy nearly every application use case. As of 9/11/2009, the site-wide retweet feature has not yet launched, so there are currently few, if any, retweets on this stream.
    
    Returns:
    StatusStream
    
    Throws:
    
    TwitterException - when Twitter service or network is unavailable
    Since:
    
    Twitter4J 2.0.10
    
    See Also:
    StatusStream, Streaming API: Methods statuses/retweet
  - sample
```
public void sample()
```
    Starts listening on random sample of all public statuses. The default access level provides a small proportion of the Firehose. The "Gardenhose" access level provides a proportion more suitable for data mining and research applications that desire a larger proportion to be statistically significant sample.
    
    Since:
    
    Twitter4J 2.0.10
    
    See Also:
    StatusStream, Streaming API: Methods statuses/sample
  - getSampleStream
```
public StatusStream getSampleStream()
                             throws TwitterException
```
    Returns a stream of random sample of all public statuses. The default access level provides a small proportion of the Firehose. The "Gardenhose" access level provides a proportion more suitable for data mining and research applications that desire a larger proportion to be statistically significant sample.
    
    Returns:
    StatusStream
    
    Throws:
    
    TwitterException - when Twitter service or network is unavailable
    Since:
    
    Twitter4J 2.0.10
    
    See Also:
    StatusStream, Streaming API: Methods statuses/sample
  - user
```
public void user()
```
    User Streams provides real-time updates of all data needed to update a desktop application display. Applications can request startup back-fill from the REST API and then transition to Streaming for nearly all subsequent reads. Rate limits and latency are practically eliminated. Desktop developers can stop managing rate limits and use this new data to create an entirely new user experience. On our end, we hope to reduce costs and increase site reliability.
    
    See Also:
    User Streams
  - getUserStream
```
public UserStream getUserStream()
                         throws TwitterException
```
    User Streams provides real-time updates of all data needed to update a desktop application display. Applications can request startup back-fill from the REST API and then transition to Streaming for nearly all subsequent reads. Rate limits and latency are practically eliminated. Desktop developers can stop managing rate limits and use this new data to create an entirely new user experience. On our end, we hope to reduce costs and increase site reliability.
    
    Returns:
    UserStream
    
    Throws:
    
    TwitterException - when Twitter service or network is unavailable
    See Also:
    User Streams
  - filter
```
public void filter(FilterQuery query)
            throws TwitterException
```
    Start consuming public statuses that match one or more filter predicates. At least one predicate parameter, follow, locations, or track must be specified. Multiple parameters may be specified which allows most clients to use a single connection to the Streaming API. Placing long parameters in the URL may cause the request to be rejected for excessive URL length.
    The default access level allows up to 200 track keywords, 400 follow userids and 10 1-degree location boxes. Increased access levels allow 80,000 follow userids ("shadow" role), 400,000 follow userids ("birddog" role), 10,000 track keywords ("restricted track" role), 200,000 track keywords ("partner track" role), and 200 10-degree location boxes ("locRestricted" role). Increased track access levels also pass a higher proportion of statuses before limiting the stream.
    
    Parameters:
    query - Filter query
    
    Throws:
    
    TwitterException
    Since:
    
    Twitter4J 2.1.2
    
    See Also:
    StatusStream, Streaming API: Methods statuses/filter
  - getFilterStream
```
public StatusStream getFilterStream(FilterQuery query)
                             throws TwitterException
```
    Returns public statuses that match one or more filter predicates. At least one predicate parameter, follow, locations, or track must be specified. Multiple parameters may be specified which allows most clients to use a single connection to the Streaming API. Placing long parameters in the URL may cause the request to be rejected for excessive URL length.
    The default access level allows up to 200 track keywords, 400 follow userids and 10 1-degree location boxes. Increased access levels allow 80,000 follow userids ("shadow" role), 400,000 follow userids ("birddog" role), 10,000 track keywords ("restricted track" role), 200,000 track keywords ("partner track" role), and 200 10-degree location boxes ("locRestricted" role). Increased track access levels also pass a higher proportion of statuses before limiting the stream.
    
    Parameters:
    query - Filter query
    
    Returns:
    StatusStream
    
    Throws:
    
    TwitterException - when Twitter service or network is unavailable
    Since:
    
    Twitter4J 2.1.2
    
    See Also:
    StatusStream, Twitter API Wiki / Streaming API Documentation - filter
  - filter
```
public void filter(int count,
          int[] follow,
          java.lang.String[] track)
```
    Deprecated. use filter(FilterQuery) instead
    
    Start consuming public statuses that match one or more filter predicates. At least one predicate parameter, follow, locations, or track must be specified. Multiple parameters may be specified which allows most clients to use a single connection to the Streaming API. Placing long parameters in the URL may cause the request to be rejected for excessive URL length.
    The default access level allows up to 200 track keywords, 400 follow userids and 10 1-degree location boxes. Increased access levels allow 80,000 follow userids ("shadow" role), 400,000 follow userids ("birddog" role), 10,000 track keywords ("restricted track" role), 200,000 track keywords ("partner track" role), and 200 10-degree location boxes ("locRestricted" role). Increased track access levels also pass a higher proportion of statuses before limiting the stream.
    
    Parameters:
    count - Indicates the number of previous statuses to stream before transitioning to the live stream.
    follow - Specifies the users, by ID, to receive public tweets from.
    track - Specifies keywords to track.
    Since:
    
    Twitter4J 2.0.10
    
    See Also:
    StatusStream, Twitter API Wiki / Streaming API Documentation - filter
  - getFilterStream
```
public StatusStream getFilterStream(int count,
                           int[] follow,
                           java.lang.String[] track)
                             throws TwitterException
```
    Deprecated. use getFilterStream(FilterQuery) instead
    
    Returns public statuses that match one or more filter predicates. At least one predicate parameter, follow, locations, or track must be specified. Multiple parameters may be specified which allows most clients to use a single connection to the Streaming API. Placing long parameters in the URL may cause the request to be rejected for excessive URL length.
    The default access level allows up to 200 track keywords, 400 follow userids and 10 1-degree location boxes. Increased access levels allow 80,000 follow userids ("shadow" role), 400,000 follow userids ("birddog" role), 10,000 track keywords ("restricted track" role), 200,000 track keywords ("partner track" role), and 200 10-degree location boxes ("locRestricted" role). Increased track access levels also pass a higher proportion of statuses before limiting the stream.
    
    Parameters:
    follow - Specifies the users, by ID, to receive public tweets from.
    
    Returns:
    StatusStream
    
    Throws:
    
    TwitterException - when Twitter service or network is unavailable
    Since:
    
    Twitter4J 2.0.10
    
    See Also:
    StatusStream, Twitter API Wiki / Streaming API Documentation - filter
  - startHandler
```
private void startHandler(TwitterStream.StreamHandlingThread handler)
```
  - startUserStreamHandler
```
private void startUserStreamHandler(TwitterStream.StreamHandlingThread handler)
```
  - cleanUp
```
public void cleanUp()
```
    shutdown internal stream consuming thread
    
    Since:
    
    Twitter4J 2.1.7
  - cleanup
```
public void cleanup()
```
    Deprecated. use #cleanUp instead
  - setStatusListener
```
public void setStatusListener(StatusListener statusListener)
```
    Deprecated. use #addStatusListener instead.
    
    Clear existing listeners and sets a StatusListener
    
    Parameters:
    statusListener - listener to be set
  - addStatusListener
```
public void addStatusListener(StatusListener statusListener)
```
    Parameters:
    statusListener - listener to be added
    Since:
    
    Twitter4J 2.1.7
  - addConnectionLifeCycleListener
```
public void addConnectionLifeCycleListener(ConnectionLifeCycleListener listener)
```
    Adds a ConnectionLifeCycleListener
    
    Parameters:
    listener - listener to be added
    Since:
    
    Twitter4J 2.1.7
  - setUserStreamListener
```
public void setUserStreamListener(UserStreamListener userStreamListener)
```
    Deprecated. use #addStatusListener instead
    
    Clear existing listeners and sets a UserStreamListener
    
    Parameters:
    userStreamListener - listener to be set
  - addUserStreamListener
```
public void addUserStreamListener(UserStreamListener userStreamListener)
```
    Parameters:
    userStreamListener - listener to be added
    Since:
    
    Twitter4J 2.1.7

Class TwitterStream

Nested Class Summary

Field Summary

Fields inherited from class twitter4j.TwitterOAuthSupportBaseImpl

Fields inherited from class twitter4j.TwitterOAuthSupportBase

Fields inherited from class twitter4j.TwitterBase

Fields inherited from interface twitter4j.internal.http.HttpResponseCode

Constructor Summary

Method Summary

Methods inherited from class twitter4j.TwitterOAuthSupportBaseImpl

Methods inherited from class twitter4j.TwitterOAuthSupportBase

Methods inherited from class twitter4j.TwitterBase

Methods inherited from class java.lang.Object

Field Detail

http

logger

statusListeners

lifeCycleListeners

handler

serialVersionUID

TCP_ERROR_INITIAL_WAIT

TCP_ERROR_WAIT_CAP

HTTP_ERROR_INITIAL_WAIT

HTTP_ERROR_WAIT_CAP

NO_WAIT

Constructor Detail

TwitterStream

TwitterStream

TwitterStream

TwitterStream

Method Detail

firehose

getFirehoseStream

links

getLinksStream

stream

getCountStream

retweet

getRetweetStream

sample

getSampleStream

user

getUserStream

filter

getFilterStream

filter

getFilterStream

startHandler

startUserStreamHandler

cleanUp

cleanup

setStatusListener

addStatusListener

addConnectionLifeCycleListener

setUserStreamListener

addUserStreamListener