co.cask.cdap.data.stream.service

Class AbstractStreamService

java.lang.Object

com.google.common.util.concurrent.AbstractScheduledService

co.cask.cdap.data.stream.service.AbstractStreamService

All Implemented Interfaces:

StreamService, com.google.common.util.concurrent.Service

Direct Known Subclasses:

DistributedStreamService, LocalStreamService

public abstract class AbstractStreamService
extends com.google.common.util.concurrent.AbstractScheduledService
implements StreamService

Stream service meant to run in an HTTP service.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.util.concurrent.AbstractScheduledService

com.google.common.util.concurrent.AbstractScheduledService.CustomScheduler, com.google.common.util.concurrent.AbstractScheduledService.Scheduler

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStreamService(StreamCoordinatorClient streamCoordinatorClient, StreamFileJanitorService janitorService, StreamWriterSizeCollector sizeCollector, MetricStore metricStore)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doShutdown() Children classes should implement this method to add logic to the shutdown of this Service.
protected ScheduledExecutorService	executor()
protected StreamCoordinatorClient	getStreamCoordinatorClient()
protected long	getStreamEventsSize(Id.Stream streamId) Get the size of events ingested by a stream since its creation, in bytes.
protected abstract void	initialize() Children classes should implement this method to add logic to the start of this Service.
protected com.google.common.util.concurrent.AbstractScheduledService.Scheduler	scheduler()
protected void	shutDown()
protected void	startUp()

Methods inherited from class com.google.common.util.concurrent.AbstractScheduledService

addListener, isRunning, runOneIteration, start, startAndWait, state, stop, stopAndWait, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, isRunning, start, startAndWait, state, stop, stopAndWait

Constructor Detail

AbstractStreamService

protected AbstractStreamService(StreamCoordinatorClient streamCoordinatorClient,
                     StreamFileJanitorService janitorService,
                     StreamWriterSizeCollector sizeCollector,
                     MetricStore metricStore)

Method Detail

initialize

protected abstract void initialize()
                            throws Exception

Children classes should implement this method to add logic to the start of this Service.

Throws:

Exception - in case of any error while initializing

doShutdown

protected abstract void doShutdown()
                            throws Exception

Children classes should implement this method to add logic to the shutdown of this Service.

Throws:

Exception - in case of any error while shutting down

getStreamCoordinatorClient

protected StreamCoordinatorClient getStreamCoordinatorClient()

Returns:

The StreamCoordinatorClient used by this StreamService.

startUp

protected final void startUp()
                      throws Exception

Overrides:

startUp in class com.google.common.util.concurrent.AbstractScheduledService

Throws:

Exception

shutDown

protected final void shutDown()
                       throws Exception

Overrides:

shutDown in class com.google.common.util.concurrent.AbstractScheduledService

Throws:

Exception

scheduler

protected com.google.common.util.concurrent.AbstractScheduledService.Scheduler scheduler()

Specified by:

scheduler in class com.google.common.util.concurrent.AbstractScheduledService

executor

protected ScheduledExecutorService executor()

Overrides:

executor in class com.google.common.util.concurrent.AbstractScheduledService

getStreamEventsSize

protected long getStreamEventsSize(Id.Stream streamId)
                            throws IOException

Get the size of events ingested by a stream since its creation, in bytes.

Parameters:

streamId - id of the stream

Returns:

Size of events ingested by a stream since its creation

Throws:

IOException - when getting an error retrieving the metric