com.northconcepts.datapipeline.throttle

Class ThrottledWriter

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataWriter

com.northconcepts.datapipeline.core.ProxyWriter

com.northconcepts.datapipeline.meter.MeteredWriter

com.northconcepts.datapipeline.throttle.ThrottledWriter

All Implemented Interfaces:

Metered, Throttled

public class ThrottledWriter
extends MeteredWriter
implements Throttled

A proxy that limits the rate (bytes/second) at which data is written.

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

DataEndpoint.State

Field Summary

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
ThrottledWriter(DataWriter writer, int bytesPerSecond)
ThrottledWriter(DataWriter writer, int unitsPerSecond, RecordMeter.MeterUnit units)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
RecordMeter.MeterUnit	getMeasure()
Throttle	getThrottle()
protected Record	interceptRecord(Record record) Overridden by subclasses to transform, drop, or observe a record on its way through this proxy.
ThrottledWriter	setMeasure(RecordMeter.MeterUnit measure)

Methods inherited from class com.northconcepts.datapipeline.meter.MeteredWriter

close, getMeter

Methods inherited from class com.northconcepts.datapipeline.core.ProxyWriter

available, getNestedWriter, map, map, open, setNestedDataWriter, setNestedDataWriter, writeImpl

Methods inherited from class com.northconcepts.datapipeline.core.DataWriter

getNestedEndpoint, getRootEndpoint, getRootWriter, getWriter, write

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrottledWriter

public ThrottledWriter(DataWriter writer,
                       int bytesPerSecond)

ThrottledWriter

public ThrottledWriter(DataWriter writer,
                       int unitsPerSecond,
                       RecordMeter.MeterUnit units)

Method Detail

getThrottle

public Throttle getThrottle()

Specified by:

getThrottle in interface Throttled

getMeasure

public RecordMeter.MeterUnit getMeasure()

setMeasure

public ThrottledWriter setMeasure(RecordMeter.MeterUnit measure)

interceptRecord

protected Record interceptRecord(Record record)
                          throws Throwable

Description copied from class: ProxyWriter

Overridden by subclasses to transform, drop, or observe a record on its way through this proxy.

Contract for subclasses (see also docs/authoring/ProxyWriter.md):

• Return the record (possibly modified) to forward it to the nested DataWriter.
• Return null to drop the record; the framework will not write it downstream.
• Throw to fail the pipeline; the framework wraps the throwable in a DataException with .setRecord(record).
• The nested DataWriter is opened and closed for you; do not write to it here.
• Do not call DataEndpoint.incrementRecordCount() here.

Overrides:

interceptRecord in class MeteredWriter

Throws:

Throwable

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: Endpoint

Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

Overrides:

addExceptionProperties in class MeteredWriter