TwitterStreamProvider (streams-provider-twitter 0.5.2-SNAPSHOT API)

java.lang.Object
- org.apache.streams.twitter.provider.TwitterStreamProvider

All Implemented Interfaces:

Serializable, DatumStatusCountable, StreamsOperation, StreamsProvider
```
public class TwitterStreamProvider
extends Object
implements StreamsProvider, Serializable, DatumStatusCountable
```
TwitterStreamProvider wraps a hosebird client and passes received documents to subscribing components.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected com.twitter.hbc.core.endpoint.StreamingEndpoint endpoint

protected TwitterStreamHelper processor

static String STREAMS_ID

Fields
Modifier and Type	Field and Description
`protected com.twitter.hbc.core.endpoint.StreamingEndpoint`	`endpoint`
`protected TwitterStreamHelper`	`processor`
`static String`	`STREAMS_ID`

Constructor Summary

Constructors
Constructor and Description

TwitterStreamProvider()

TwitterStreamProvider(TwitterStreamConfiguration config)

Constructors
Constructor and Description
`TwitterStreamProvider()`
`TwitterStreamProvider(TwitterStreamConfiguration config)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`addDatum(Future<List<StreamsDatum>> future)`
`void`	`cleanUp()`
`protected void`	`drainTo(Queue<StreamsDatum> drain)`
`TwitterStreamConfiguration`	`getConfig()`
`DatumStatusCounter`	`getDatumStatusCounter()`
`String`	`getId()`
`boolean`	`isRunning()`
`static void`	`main(String[] args)` To use from command line: Supply (at least) the following required configuration in application.conf: twitter.oauth.consumerKey twitter.oauth.consumerSecret twitter.oauth.accessToken twitter.oauth.accessTokenSecret Launch using: mvn exec:java -Dexec.mainClass=org.apache.streams.twitter.provider.TwitterStreamProvider -Dexec.args="application.conf tweets.json"
`protected List<StreamsDatum>`	`pollForDatum()`
`void`	`prepare(Object configurationObject)`
`StreamsResultSet`	`readCurrent()`
`StreamsResultSet`	`readNew(BigInteger sequence)`
`StreamsResultSet`	`readRange(org.joda.time.DateTime start, org.joda.time.DateTime end)`
`void`	`setConfig(TwitterStreamConfiguration config)`
`void`	`startStream()`

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

- Field Detail
  - STREAMS_ID
```
public static final String STREAMS_ID
```
    See Also:
    
    Constant Field Values
  - endpoint
```
protected com.twitter.hbc.core.endpoint.StreamingEndpoint endpoint
```
  - processor
```
protected TwitterStreamHelper processor
```
- Constructor Detail
  - TwitterStreamProvider
```
public TwitterStreamProvider()
```
  - TwitterStreamProvider
```
public TwitterStreamProvider(TwitterStreamConfiguration config)
```
- Method Detail
  - main
```
public static void main(String[] args)
```
    To use from command line:
    Supply (at least) the following required configuration in application.conf:
    twitter.oauth.consumerKey twitter.oauth.consumerSecret twitter.oauth.accessToken twitter.oauth.accessTokenSecret
    Launch using:
    mvn exec:java -Dexec.mainClass=org.apache.streams.twitter.provider.TwitterStreamProvider -Dexec.args="application.conf tweets.json"
    
    Parameters:
    
    args -
  - getConfig
```
public TwitterStreamConfiguration getConfig()
```
  - setConfig
```
public void setConfig(TwitterStreamConfiguration config)
```
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface StreamsOperation
  - startStream
```
public void startStream()
```
    Specified by:
    
    startStream in interface StreamsProvider
  - readCurrent
```
public StreamsResultSet readCurrent()
```
    Specified by:
    
    readCurrent in interface StreamsProvider
  - readNew
```
public StreamsResultSet readNew(BigInteger sequence)
```
    Specified by:
    
    readNew in interface StreamsProvider
  - readRange
```
public StreamsResultSet readRange(org.joda.time.DateTime start,
                                  org.joda.time.DateTime end)
```
    Specified by:
    
    readRange in interface StreamsProvider
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface StreamsProvider
  - prepare
```
public void prepare(Object configurationObject)
```
    Specified by:
    
    prepare in interface StreamsOperation
  - cleanUp
```
public void cleanUp()
```
    Specified by:
    
    cleanUp in interface StreamsOperation
  - getDatumStatusCounter
```
public DatumStatusCounter getDatumStatusCounter()
```
    Specified by:
    
    getDatumStatusCounter in interface DatumStatusCountable
  - addDatum
```
protected boolean addDatum(Future<List<StreamsDatum>> future)
```
  - drainTo
```
protected void drainTo(Queue<StreamsDatum> drain)
```
  - pollForDatum
```
protected List<StreamsDatum> pollForDatum()
```

Class TwitterStreamProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STREAMS_ID

endpoint

processor

Constructor Detail

TwitterStreamProvider

TwitterStreamProvider

Method Detail

main

getConfig

setConfig

getId

startStream

readCurrent

readNew

readRange

isRunning

prepare

cleanUp

getDatumStatusCounter

addDatum

drainTo

pollForDatum