com.amazonaws.services.kinesis.clientlibrary.lib.worker

Class Worker

java.lang.Object

com.amazonaws.services.kinesis.clientlibrary.lib.worker.Worker

All Implemented Interfaces:

java.lang.Runnable

public class Worker
extends java.lang.Object
implements java.lang.Runnable

Worker is the high level class that Kinesis applications use to start processing data. It initializes and oversees different components (e.g. syncing shard and lease information, tracking shard assignments, and processing data from the shards).

Constructor Summary

Constructors

Constructor and Description
Worker(IRecordProcessorFactory recordProcessorFactory, KinesisClientLibConfiguration config) Constructor.
Worker(IRecordProcessorFactory recordProcessorFactory, KinesisClientLibConfiguration config, AmazonKinesis kinesisClient, AmazonDynamoDB dynamoDBClient, AmazonCloudWatch cloudWatchClient)
Worker(IRecordProcessorFactory recordProcessorFactory, KinesisClientLibConfiguration config, AmazonKinesis kinesisClient, AmazonDynamoDB dynamoDBClient, AmazonCloudWatch cloudWatchClient, java.util.concurrent.ExecutorService execService)
Worker(IRecordProcessorFactory recordProcessorFactory, KinesisClientLibConfiguration config, AmazonKinesis kinesisClient, AmazonDynamoDB dynamoDBClient, IMetricsFactory metricsFactory, java.util.concurrent.ExecutorService execService)
Worker(IRecordProcessorFactory recordProcessorFactory, KinesisClientLibConfiguration config, AmazonKinesisClient kinesisClient, AmazonDynamoDBClient dynamoDBClient, AmazonCloudWatchClient cloudWatchClient) This constructor is for binary compatibility with code compiled against version of the KCL that only have constructors taking "Client" objects.
Worker(IRecordProcessorFactory recordProcessorFactory, KinesisClientLibConfiguration config, AmazonKinesisClient kinesisClient, AmazonDynamoDBClient dynamoDBClient, AmazonCloudWatchClient cloudWatchClient, java.util.concurrent.ExecutorService execService) This constructor is for binary compatibility with code compiled against version of the KCL that only have constructors taking "Client" objects.
Worker(IRecordProcessorFactory recordProcessorFactory, KinesisClientLibConfiguration config, AmazonKinesisClient kinesisClient, AmazonDynamoDBClient dynamoDBClient, IMetricsFactory metricsFactory, java.util.concurrent.ExecutorService execService) This constructor is for binary compatibility with code compiled against version of the KCL that only have constructors taking "Client" objects.
Worker(IRecordProcessorFactory recordProcessorFactory, KinesisClientLibConfiguration config, java.util.concurrent.ExecutorService execService) Constructor.
Worker(IRecordProcessorFactory recordProcessorFactory, KinesisClientLibConfiguration config, IMetricsFactory metricsFactory)
Worker(IRecordProcessorFactory recordProcessorFactory, KinesisClientLibConfiguration config, IMetricsFactory metricsFactory, java.util.concurrent.ExecutorService execService)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getApplicationName()
void	run() Start consuming data from the stream, and pass it to the application record processors.
void	shutdown() Sets the killed flag so this worker will stop on the next iteration of its loop.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Worker

public Worker(IRecordProcessorFactory recordProcessorFactory,
      KinesisClientLibConfiguration config)

Constructor.

Parameters:

recordProcessorFactory - Used to get record processor instances for processing data from shards

config - Kinesis Client Library configuration

Worker

public Worker(IRecordProcessorFactory recordProcessorFactory,
      KinesisClientLibConfiguration config,
      java.util.concurrent.ExecutorService execService)

Constructor.

Parameters:

recordProcessorFactory - Used to get record processor instances for processing data from shards

config - Kinesis Client Library configuration

execService - ExecutorService to use for processing records (support for multi-threaded consumption)

Worker

public Worker(IRecordProcessorFactory recordProcessorFactory,
      KinesisClientLibConfiguration config,
      IMetricsFactory metricsFactory)

Parameters:

recordProcessorFactory - Used to get record processor instances for processing data from shards

config - Kinesis Client Library configuration

metricsFactory - Metrics factory used to emit metrics

Worker

public Worker(IRecordProcessorFactory recordProcessorFactory,
      KinesisClientLibConfiguration config,
      IMetricsFactory metricsFactory,
      java.util.concurrent.ExecutorService execService)

Parameters:

recordProcessorFactory - Used to get record processor instances for processing data from shards

config - Kinesis Client Library configuration

metricsFactory - Metrics factory used to emit metrics

execService - ExecutorService to use for processing records (support for multi-threaded consumption)

Worker

public Worker(IRecordProcessorFactory recordProcessorFactory,
      KinesisClientLibConfiguration config,
      AmazonKinesis kinesisClient,
      AmazonDynamoDB dynamoDBClient,
      AmazonCloudWatch cloudWatchClient)

Parameters:

recordProcessorFactory - Used to get record processor instances for processing data from shards

config - Kinesis Client Library configuration

kinesisClient - Kinesis Client used for fetching data

dynamoDBClient - DynamoDB client used for checkpoints and tracking leases

cloudWatchClient - CloudWatch Client for publishing metrics

Worker

public Worker(IRecordProcessorFactory recordProcessorFactory,
      KinesisClientLibConfiguration config,
      AmazonKinesis kinesisClient,
      AmazonDynamoDB dynamoDBClient,
      AmazonCloudWatch cloudWatchClient,
      java.util.concurrent.ExecutorService execService)

Parameters:

recordProcessorFactory - Used to get record processor instances for processing data from shards

config - Kinesis Client Library configuration

kinesisClient - Kinesis Client used for fetching data

dynamoDBClient - DynamoDB client used for checkpoints and tracking leases

cloudWatchClient - CloudWatch Client for publishing metrics

execService - ExecutorService to use for processing records (support for multi-threaded consumption)

Worker

public Worker(IRecordProcessorFactory recordProcessorFactory,
      KinesisClientLibConfiguration config,
      AmazonKinesis kinesisClient,
      AmazonDynamoDB dynamoDBClient,
      IMetricsFactory metricsFactory,
      java.util.concurrent.ExecutorService execService)

Parameters:

recordProcessorFactory - Used to get record processor instances for processing data from shards

config - Kinesis Client Library configuration

kinesisClient - Kinesis Client used for fetching data

dynamoDBClient - DynamoDB client used for checkpoints and tracking leases

metricsFactory - Metrics factory used to emit metrics

execService - ExecutorService to use for processing records (support for multi-threaded consumption)

Worker

public Worker(IRecordProcessorFactory recordProcessorFactory,
      KinesisClientLibConfiguration config,
      AmazonKinesisClient kinesisClient,
      AmazonDynamoDBClient dynamoDBClient,
      AmazonCloudWatchClient cloudWatchClient)

This constructor is for binary compatibility with code compiled against version of the KCL that only have constructors taking "Client" objects.

Parameters:

recordProcessorFactory - Used to get record processor instances for processing data from shards

config - Kinesis Client Library configuration

kinesisClient - Kinesis Client used for fetching data

dynamoDBClient - DynamoDB client used for checkpoints and tracking leases

cloudWatchClient - CloudWatch Client for publishing metrics

Worker

public Worker(IRecordProcessorFactory recordProcessorFactory,
      KinesisClientLibConfiguration config,
      AmazonKinesisClient kinesisClient,
      AmazonDynamoDBClient dynamoDBClient,
      AmazonCloudWatchClient cloudWatchClient,
      java.util.concurrent.ExecutorService execService)

This constructor is for binary compatibility with code compiled against version of the KCL that only have constructors taking "Client" objects.

Parameters:

recordProcessorFactory - Used to get record processor instances for processing data from shards

config - Kinesis Client Library configuration

kinesisClient - Kinesis Client used for fetching data

dynamoDBClient - DynamoDB client used for checkpoints and tracking leases

cloudWatchClient - CloudWatch Client for publishing metrics

execService - ExecutorService to use for processing records (support for multi-threaded consumption)

Worker

public Worker(IRecordProcessorFactory recordProcessorFactory,
      KinesisClientLibConfiguration config,
      AmazonKinesisClient kinesisClient,
      AmazonDynamoDBClient dynamoDBClient,
      IMetricsFactory metricsFactory,
      java.util.concurrent.ExecutorService execService)

This constructor is for binary compatibility with code compiled against version of the KCL that only have constructors taking "Client" objects.

Parameters:

recordProcessorFactory - Used to get record processor instances for processing data from shards

config - Kinesis Client Library configuration

kinesisClient - Kinesis Client used for fetching data

dynamoDBClient - DynamoDB client used for checkpoints and tracking leases

metricsFactory - Metrics factory used to emit metrics

execService - ExecutorService to use for processing records (support for multi-threaded consumption)

Method Detail

getApplicationName

public java.lang.String getApplicationName()

Returns:

the applicationName

run

public void run()

Start consuming data from the stream, and pass it to the application record processors.

Specified by:

run in interface java.lang.Runnable

shutdown

public void shutdown()

Sets the killed flag so this worker will stop on the next iteration of its loop.