SysomosProvider (streams-provider-sysomos 0.5.2-SNAPSHOT API)

java.lang.Object
- org.apache.streams.sysomos.provider.SysomosProvider

All Implemented Interfaces:

Serializable, StreamsOperation, StreamsProvider
```
public class SysomosProvider
extends Object
implements StreamsProvider
```
Streams Provider for the Sysomos Heartbeat API
Configuration: The provider takes either a Map[String,Object] containing the mode (backfill and terminate OR continuous) and a Map[String,String] of heartbeat IDs to document target ids or a string of the format ${heartbeatId}:${documentId},...,${heartbeatId}:${documentId} This configuration will configure the provider to backfill to the specified document and either terminate or not depending on the mode flag. Continuous mode is assumed, and is the ony mode supported by the String configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SysomosProvider.Mode

Nested Classes
Modifier and Type	Class and Description
`static class`	`SysomosProvider.Mode`

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`API_BATCH_SIZE`
`static String`	`ENDING_TIME_KEY`
`static int`	`LATENCY`
`static String`	`MODE_KEY`
`static long`	`PROVIDER_BATCH_SIZE`
`protected Queue<StreamsDatum>`	`providerQueue`
`static String`	`STARTING_DOCS_KEY`
`static String`	`STARTING_TIME_KEY`
`static String`	`STREAMS_ID`

Constructor Summary

Constructors
Constructor and Description

SysomosProvider(SysomosConfiguration sysomosConfiguration)
SysomosProvider constructor.

Constructors
Constructor and Description
`SysomosProvider(SysomosConfiguration sysomosConfiguration)` SysomosProvider constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanUp()`
`protected SysomosHeartbeatStream`	`createStream(String heartbeatId)`
`protected void`	`enqueueItem(StreamsDatum datum)`
`protected void`	`extractConfigFromMap(Map configMap)`
`SysomosClient`	`getClient()`
`SysomosConfiguration`	`getConfig()`
`int`	`getCount()`
`String`	`getId()`
`long`	`getMaxApiBatch()`
`long`	`getMinLatency()`
`SysomosProvider.Mode`	`getMode()`
`boolean`	`isRunning()`
`static void`	`main(String[] args)` To use from command line: Supply configuration similar to src/test/resources/rss.conf Launch using: mvn exec:java -Dexec.mainClass=org.apache.streams.rss.provider.RssStreamProvider -Dexec.args="rss.conf articles.json"
`protected void`	`pauseForSpace()` Wait for the queue size to be below threshold before allowing execution to continue on this thread.
`void`	`prepare(Object configurationObject)`
`StreamsResultSet`	`readCurrent()`
`StreamsResultSet`	`readNew(BigInteger bigInteger)`
`StreamsResultSet`	`readRange(org.joda.time.DateTime dateTime, org.joda.time.DateTime dateTime2)`
`void`	`setConfig(SysomosConfiguration config)`
`void`	`signalComplete(String heartbeatId)` signalComplete.
`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
  - ENDING_TIME_KEY
```
public static final String ENDING_TIME_KEY
```
    See Also:
    
    Constant Field Values
  - STARTING_TIME_KEY
```
public static final String STARTING_TIME_KEY
```
    See Also:
    
    Constant Field Values
  - MODE_KEY
```
public static final String MODE_KEY
```
    See Also:
    
    Constant Field Values
  - STARTING_DOCS_KEY
```
public static final String STARTING_DOCS_KEY
```
    See Also:
    
    Constant Field Values
  - LATENCY
```
public static final int LATENCY
```
    See Also:
    
    Constant Field Values
  - PROVIDER_BATCH_SIZE
```
public static final long PROVIDER_BATCH_SIZE
```
    See Also:
    
    Constant Field Values
  - API_BATCH_SIZE
```
public static final long API_BATCH_SIZE
```
    See Also:
    
    Constant Field Values
  - providerQueue
```
protected volatile Queue<StreamsDatum> providerQueue
```
- Constructor Detail
  - SysomosProvider
```
public SysomosProvider(SysomosConfiguration sysomosConfiguration)
```
    SysomosProvider constructor.
    
    Parameters:
    
    sysomosConfiguration - SysomosConfiguration
- Method Detail
  - main
```
public static void main(String[] args)
                 throws Exception
```
    To use from command line:
    Supply configuration similar to src/test/resources/rss.conf
    Launch using:
    mvn exec:java -Dexec.mainClass=org.apache.streams.rss.provider.RssStreamProvider -Dexec.args="rss.conf articles.json"
    
    Parameters:
    
    args - args
    
    Throws:
    
    Exception - Exception
  - getConfig
```
public SysomosConfiguration getConfig()
```
  - setConfig
```
public void setConfig(SysomosConfiguration config)
```
  - getMode
```
public SysomosProvider.Mode getMode()
```
  - getMinLatency
```
public long getMinLatency()
```
  - getMaxApiBatch
```
public long getMaxApiBatch()
```
  - getClient
```
public SysomosClient getClient()
```
  - 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 bigInteger)
```
    Specified by:
    
    readNew in interface StreamsProvider
  - readRange
```
public StreamsResultSet readRange(org.joda.time.DateTime dateTime,
                                  org.joda.time.DateTime dateTime2)
```
    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
  - signalComplete
```
public void signalComplete(String heartbeatId)
```
    signalComplete.
    
    Parameters:
    
    heartbeatId - heartbeatId
  - enqueueItem
```
protected void enqueueItem(StreamsDatum datum)
```
  - createStream
```
protected SysomosHeartbeatStream createStream(String heartbeatId)
```
  - pauseForSpace
```
protected void pauseForSpace()
```
    Wait for the queue size to be below threshold before allowing execution to continue on this thread.
  - extractConfigFromMap
```
protected void extractConfigFromMap(Map configMap)
```
  - getCount
```
public int getCount()
```

Class SysomosProvider

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STREAMS_ID

ENDING_TIME_KEY

STARTING_TIME_KEY

MODE_KEY

STARTING_DOCS_KEY

LATENCY

PROVIDER_BATCH_SIZE

API_BATCH_SIZE

providerQueue

Constructor Detail

SysomosProvider

Method Detail

main

getConfig

setConfig

getMode

getMinLatency

getMaxApiBatch

getClient

getId

startStream

readCurrent

readNew

readRange

isRunning

prepare

cleanUp

signalComplete

enqueueItem

createStream

pauseForSpace

extractConfigFromMap

getCount