TwitterStreamImpl

java.lang.Object
- twitter4j.TwitterBaseImpl
- - twitter4j.TwitterStreamImpl

All Implemented Interfaces:

java.io.Serializable, OAuth2Support, OAuthSupport, TwitterBase, TwitterStream
```
class TwitterStreamImpl
extends TwitterBaseImpl
implements TwitterStream
```
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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class TwitterStreamImpl.Mode

(package private) class TwitterStreamImpl.TwitterStreamConsumer

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`TwitterStreamImpl.Mode`
`(package private) class`	`TwitterStreamImpl.TwitterStreamConsumer`

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`count`
`private static Dispatcher`	`dispatcher`
`private TwitterStreamImpl.TwitterStreamConsumer`	`handler`
`private HttpClient`	`http`
`private static int`	`HTTP_ERROR_INITIAL_WAIT`
`private static int`	`HTTP_ERROR_WAIT_CAP`
`private java.util.List<ConnectionLifeCycleListener>`	`lifeCycleListeners`
`private static Logger`	`logger`
`private static int`	`NO_WAIT`
`private static int`	`numberOfHandlers`
`private static long`	`serialVersionUID`
`private java.lang.String`	`stallWarningsGetParam`
`private HttpParameter`	`stallWarningsParam`
`private java.util.ArrayList<StreamListener>`	`streamListeners`
`private static int`	`TCP_ERROR_INITIAL_WAIT`
`private static int`	`TCP_ERROR_WAIT_CAP`

Fields inherited from class twitter4j.TwitterBaseImpl
auth, conf, factory

Constructor Summary

Constructors
Constructor and Description

TwitterStreamImpl(Configuration conf, Authorization auth)

Constructors
Constructor and Description
`TwitterStreamImpl(Configuration conf, Authorization auth)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TwitterStream`	`addConnectionLifeCycleListener(ConnectionLifeCycleListener listener)` Adds a ConnectionLifeCycleListener
`TwitterStream`	`addListener(StreamListener listener)`
`TwitterStream`	`cleanUp()` shutdown internal stream consuming thread
`TwitterStream`	`clearListeners()` clear status listeners
`private void`	`ensureSiteStreamsListenerIsSet()`
`private void`	`ensureStatusStreamListenerIsSet()` check if any listener is set.
`boolean`	`equals(java.lang.Object o)`
`TwitterStream`	`filter(FilterQuery query)` Start consuming public statuses that match one or more filter predicates.
`TwitterStream`	`filter(java.lang.String... track)` Start consuming public statuses that match the filter predicate.
`TwitterStream`	`firehose(int count)` Starts listening on all public statuses.
`private StatusStream`	`getCountStream(java.lang.String relativeUrl, int count)`
`private Dispatcher`	`getDispatcher()`
`(package private) StatusStream`	`getFilterStream(FilterQuery query)` Returns public statuses that match one or more filter predicates.
`(package private) StatusStream`	`getFirehoseStream(int count)` Returns a status stream of all public statuses.
`(package private) StatusStream`	`getLinksStream(int count)` Returns a status stream of all public statuses containing links.
`private RawStreamListener[]`	`getRawStreamListeners()`
`(package private) StatusStream`	`getRetweetStream()` Returns a stream of all retweets.
`(package private) StatusStream`	`getSampleStream()` Returns a stream of random sample of all public statuses.
`(package private) StatusStream`	`getSampleStream(java.lang.String language)` Returns a stream of random sample of all public statuses.
`(package private) java.io.InputStream`	`getSiteStream(boolean withFollowings, long[] follow)`
`private SiteStreamsListener[]`	`getSiteStreamsListeners()`
`private StatusListener[]`	`getStatusListeners()`
`(package private) UserStream`	`getUserStream(java.lang.String[] track)` User Streams provides real-time updates of all data needed to update a desktop application display.
`int`	`hashCode()`
`TwitterStream`	`links(int count)` Starts listening on all public statuses containing links.
`TwitterStream`	`onException(Consumer<java.lang.Exception> action)`
`TwitterStream`	`onStatus(Consumer<Status> action)`
`TwitterStream`	`removeListener(StreamListener listener)`
`TwitterStream`	`replaceListener(StreamListener toBeRemoved, StreamListener toBeAdded)` replace existing listener
`TwitterStream`	`retweet()` Starts listening on all retweets.
`TwitterStream`	`sample()` Starts listening on random sample of all public statuses.
`TwitterStream`	`sample(java.lang.String language)` Starts listening on random sample of all public statuses.
`TwitterStream`	`shutdown()` Shuts down internal dispatcher thread shared by all TwitterStream instances.
`StreamController`	`site(boolean withFollowings, long[] follow)` Site Streams, a new feature on the Streaming API, is now available for beta testing.
`private void`	`startHandler(TwitterStreamImpl.TwitterStreamConsumer handler)`
`java.lang.String`	`toString()`
`private void`	`updateListeners()`
`TwitterStream`	`user()` User Streams provides real-time updates of all data needed to update a desktop application display.
`TwitterStream`	`user(java.lang.String[] track)` User Streams provides real-time updates of all data needed to update a desktop application display.

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

Methods inherited from interface twitter4j.auth.OAuthSupport
getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthAccessToken, getOAuthRequestToken, getOAuthRequestToken, getOAuthRequestToken, getOAuthRequestToken, setOAuthAccessToken, setOAuthConsumer

Methods inherited from interface twitter4j.TwitterBase
addRateLimitStatusListener, getAuthorization, getConfiguration, getId, getScreenName, onRateLimitReached, onRateLimitStatus

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - http
```
private final HttpClient http
```
  - logger
```
private static final Logger logger
```
  - lifeCycleListeners
```
private final java.util.List<ConnectionLifeCycleListener> lifeCycleListeners
```
  - handler
```
private TwitterStreamImpl.TwitterStreamConsumer handler
```
  - stallWarningsGetParam
```
private final java.lang.String stallWarningsGetParam
```
  - stallWarningsParam
```
private final HttpParameter stallWarningsParam
```
  - dispatcher
```
private static transient volatile Dispatcher dispatcher
```
  - numberOfHandlers
```
private static int numberOfHandlers
```
  - streamListeners
```
private final java.util.ArrayList<StreamListener> streamListeners
```
  - 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
  - count
```
private static int count
```
- Constructor Detail
  - TwitterStreamImpl
```
TwitterStreamImpl(Configuration conf,
                  Authorization auth)
```
- Method Detail
  - firehose
```
public TwitterStream firehose(int count)
```
    Description copied from interface: TwitterStream
    
    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.
    
    Specified by:
    
    firehose in interface TwitterStream
    
    Parameters:
    
    count - Indicates the number of previous statuses to stream before transitioning to the live stream.
    
    See Also:
    
    StatusStream, Streaming API Methods statuses/firehose
  - getFirehoseStream
```
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 TwitterStream links(int count)
```
    Description copied from interface: TwitterStream
    
    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.
    
    Specified by:
    
    links in interface TwitterStream
    
    Parameters:
    
    count - Indicates the number of previous statuses to stream before transitioning to the live stream.
    
    See Also:
    
    StatusStream, Streaming API Methods statuses/links
  - getLinksStream
```
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
  - getCountStream
```
private StatusStream getCountStream(java.lang.String relativeUrl,
                                    int count)
                             throws TwitterException
```
    Throws:
    
    TwitterException
  - retweet
```
public TwitterStream retweet()
```
    Description copied from interface: TwitterStream
    
    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.
    
    Specified by:
    
    retweet in interface TwitterStream
    
    See Also:
    
    StatusStream, Streaming API Methods statuses/retweet
  - getRetweetStream
```
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 TwitterStream sample()
```
    Description copied from interface: TwitterStream
    
    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.
    
    Specified by:
    
    sample in interface TwitterStream
    
    See Also:
    
    StatusStream, Streaming API: Methods statuses/sample
  - sample
```
public TwitterStream sample(java.lang.String language)
```
    Description copied from interface: TwitterStream
    
    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.
    Only samples Tweets written in the given language.
    
    Specified by:
    
    sample in interface TwitterStream
    
    Parameters:
    
    language - language to be sampled
    
    See Also:
    
    StatusStream, Streaming API: Methods statuses/sample
  - getSampleStream
```
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
  - getSampleStream
```
StatusStream getSampleStream(java.lang.String language)
                      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.
    Only returns tweets in the given languages
    
    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 TwitterStream user()
```
    Description copied from interface: TwitterStream
    
    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.
    
    Specified by:
    
    user in interface TwitterStream
    
    See Also:
    
    User Streams
  - user
```
public TwitterStream user(java.lang.String[] track)
```
    Description copied from interface: TwitterStream
    
    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.
    
    Specified by:
    
    user in interface TwitterStream
    
    Parameters:
    
    track - keywords to track
    
    See Also:
    
    User Streams
  - getUserStream
```
UserStream getUserStream(java.lang.String[] track)
                  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.
    
    Parameters:
    
    track - keywords to track
    
    Returns:
    
    UserStream
    
    Throws:
    
    TwitterException - when Twitter service or network is unavailable
    
    Since:
    
    Twitter4J 2.1.9
    
    See Also:
    
    User Streams
  - site
```
public StreamController site(boolean withFollowings,
                             long[] follow)
```
    Description copied from interface: TwitterStream
    
    Site Streams, a new feature on the Streaming API, is now available for beta testing. Site Streams allows services, such as web sites or mobile push services, to receive real-time updates for a large number of users without any of the hassles of managing REST API rate limits. The initial version delivers events created by, or directed to, users that have shared their OAuth token with your application. The following events are streamed immediately, and without rate limits: Home Timelines, Mentions Timelines, User Timelines, Direct Messages, Mentions, Follows, Favorites, Tweets, Retweets, Profile changes, and List changes. The following limitations must be respected during the beta period. These limitations may be changed with little advance notice. We intend to increase or remove these various limitations as we move from beta test into full production:
    Limit the follow count to 100 users per stream. Clients must occasionally compact users onto a smaller number of connections to minimize the total number of connections outstanding.
    Open no more than 25 new connections per second and exponentially back-off on errors.
    
    Specified by:
    
    site in interface TwitterStream
    
    Parameters:
    
    withFollowings - whether to receive status updates from people following
    
    follow - an array of users to include in the stream
    
    Returns:
    
    controller to control the site stream
    
    See Also:
    
    Site Streams | Twitter Developers
  - getDispatcher
```
private Dispatcher getDispatcher()
```
  - getSiteStream
```
java.io.InputStream getSiteStream(boolean withFollowings,
                                  long[] follow)
                           throws TwitterException
```
    Throws:
    
    TwitterException
  - filter
```
public TwitterStream filter(FilterQuery query)
```
    Description copied from interface: TwitterStream
    
    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.
    
    Specified by:
    
    filter in interface TwitterStream
    
    Parameters:
    
    query - Filter query
    
    See Also:
    
    StatusStream, Streaming API Methods statuses/filter
  - filter
```
public TwitterStream filter(java.lang.String... track)
```
    Description copied from interface: TwitterStream
    
    Start consuming public statuses that match the filter predicate. 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.
    
    Specified by:
    
    filter in interface TwitterStream
    
    Parameters:
    
    track - words to be filtered
  - getFilterStream
```
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, Streaming API Methods | Twitter Developers
  - ensureStatusStreamListenerIsSet
```
private void ensureStatusStreamListenerIsSet()
```
    check if any listener is set. Throws IllegalStateException if no listener is set.
    
    Throws:
    
    java.lang.IllegalStateException - when no listener is set.
  - ensureSiteStreamsListenerIsSet
```
private void ensureSiteStreamsListenerIsSet()
```
  - startHandler
```
private void startHandler(TwitterStreamImpl.TwitterStreamConsumer handler)
```
  - cleanUp
```
public TwitterStream cleanUp()
```
    Description copied from interface: TwitterStream
    
    shutdown internal stream consuming thread
    
    Specified by:
    
    cleanUp in interface TwitterStream
  - shutdown
```
public TwitterStream shutdown()
```
    Description copied from interface: TwitterStream
    
    Shuts down internal dispatcher thread shared by all TwitterStream instances.
    
    Specified by:
    
    shutdown in interface TwitterStream
  - addConnectionLifeCycleListener
```
public TwitterStream addConnectionLifeCycleListener(ConnectionLifeCycleListener listener)
```
    Description copied from interface: TwitterStream
    
    Adds a ConnectionLifeCycleListener
    
    Specified by:
    
    addConnectionLifeCycleListener in interface TwitterStream
    
    Parameters:
    
    listener - listener to be added
  - addListener
```
public TwitterStream addListener(StreamListener listener)
```
    Specified by:
    
    addListener in interface TwitterStream
    
    Parameters:
    
    listener - listener to add
  - onStatus
```
public TwitterStream onStatus(Consumer<Status> action)
```
    Specified by:
    
    onStatus in interface TwitterStream
    
    Parameters:
    
    action - action when receiving Status
    
    Returns:
    
    this instance
  - onException
```
public TwitterStream onException(Consumer<java.lang.Exception> action)
```
    Specified by:
    
    onException in interface TwitterStream
    
    Parameters:
    
    action - action when receiving TwitterException
    
    Returns:
    
    this instance
  - removeListener
```
public TwitterStream removeListener(StreamListener listener)
```
    Specified by:
    
    removeListener in interface TwitterStream
    
    Parameters:
    
    listener - listener to remove
  - clearListeners
```
public TwitterStream clearListeners()
```
    Description copied from interface: TwitterStream
    
    clear status listeners
    
    Specified by:
    
    clearListeners in interface TwitterStream
  - replaceListener
```
public TwitterStream replaceListener(StreamListener toBeRemoved,
                                     StreamListener toBeAdded)
```
    Description copied from interface: TwitterStream
    
    replace existing listener
    
    Specified by:
    
    replaceListener in interface TwitterStream
    
    Parameters:
    
    toBeRemoved - listener to be removed
    
    toBeAdded - listener to be added
  - updateListeners
```
private void updateListeners()
```
  - getRawStreamListeners
```
private RawStreamListener[] getRawStreamListeners()
```
  - getSiteStreamsListeners
```
private SiteStreamsListener[] getSiteStreamsListeners()
```
  - getStatusListeners
```
private StatusListener[] getStatusListeners()
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class TwitterBaseImpl
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class TwitterBaseImpl
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class TwitterBaseImpl

Class TwitterStreamImpl

Nested Class Summary

Field Summary

Fields inherited from class twitter4j.TwitterBaseImpl

Constructor Summary

Method Summary

Methods inherited from class twitter4j.TwitterBaseImpl

Methods inherited from class java.lang.Object

Methods inherited from interface twitter4j.auth.OAuthSupport

Methods inherited from interface twitter4j.TwitterBase

Field Detail

serialVersionUID

http

logger

lifeCycleListeners

handler

stallWarningsGetParam

stallWarningsParam

dispatcher

numberOfHandlers

streamListeners

TCP_ERROR_INITIAL_WAIT

TCP_ERROR_WAIT_CAP

HTTP_ERROR_INITIAL_WAIT

HTTP_ERROR_WAIT_CAP

NO_WAIT

count

Constructor Detail

TwitterStreamImpl

Method Detail

firehose

getFirehoseStream

links

getLinksStream

getCountStream

retweet

getRetweetStream

sample

sample

getSampleStream

getSampleStream

user

user

getUserStream

site

getDispatcher

getSiteStream

filter

filter

getFilterStream

ensureStatusStreamListenerIsSet

ensureSiteStreamsListenerIsSet

startHandler

cleanUp

shutdown

addConnectionLifeCycleListener

addListener

onStatus

onException

removeListener

clearListeners

replaceListener

updateListeners

getRawStreamListeners

getSiteStreamsListeners

getStatusListeners

equals

hashCode

toString