com.northconcepts.datapipeline.eventbus.EventBusWriter

public class EventBusWriter extends DataWriter

Writes records to an event bus under a specific topic.

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

Description

EventBusWriter(EventBus eventBus, Object topic)

Creates a new EventBusWriter.
Method Summary

Modifier and Type

Method

Description

DataException

addExceptionProperties(DataException exception)

Adds this endpoint's current state to a DataException.

void

close()

Indicates that this endpoint has finished reading or writing.

EventBus

getEventBus()

Object

getEventSource()

Returns the source attached to this writer's events (defaults to the writer itself).

Object

getTopic()

void

open()

Makes this endpoint ready for reading or writing.

EventBusWriter

setEventSource(Object eventSource)

Sets the source attached to this writer's events (defaults to the writer itself); must be called before opening.

EventBusWriter

setTopic(Object topic)

Sets the topic the records are published under; must be called before opening.

String

toString()

protected void

writeImpl(Record record)

Overridden by subclasses to write the specified record to this DataWriter.

Methods inherited from class com.northconcepts.datapipeline.core.DataWriter
available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter, getWriter, write

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint
decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount

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 Details
- EventBusWriter
  
  public EventBusWriter(EventBus eventBus, Object topic)
  
  Creates a new EventBusWriter.
  
  Parameters:
  
  eventBus - the target event bus this instance writes to.
  
  topic - a string, enum, or other object used to distinguish one stream of records from another.
Method Details
- getEventBus
  
  public EventBus getEventBus()
- getEventSource
  
  public Object getEventSource()
  
  Returns the source attached to this writer's events (defaults to the writer itself).
- setEventSource
  
  public EventBusWriter setEventSource(Object eventSource)
  
  Sets the source attached to this writer's events (defaults to the writer itself); must be called before opening.
- getTopic
  
  public Object getTopic()
- 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 DataWriter
- setTopic
  
  public EventBusWriter setTopic(Object topic)
  
  Sets the topic the records are published under; must be called before opening.
- open
  
  public void open() throws DataException
  
  Description copied from class: DataEndpoint
  
  Makes this endpoint ready for reading or writing.
  
  Overrides:
  
  open in class DataEndpoint
  
  Throws:
  
  DataException
- close
  
  public void close() throws DataException
  
  Description copied from class: DataEndpoint
  
  Indicates that this endpoint has finished reading or writing.
  
  Overrides:
  
  close in class DataEndpoint
  
  Throws:
  
  DataException
- writeImpl
  
  protected void writeImpl(Record record) throws Throwable
  
  Description copied from class: DataWriter
  Overridden by subclasses to write the specified record to this DataWriter.
  Contract for subclasses (see also docs/authoring/DataWriter.md):
  
  Do not call this method directly — DataWriter.write(Record) is the template method that wraps exceptions, increments the record count, and attaches the offending record to thrown DataExceptions.
  
  Do not call DataEndpoint.incrementRecordCount() here; DataWriter.write(Record) already does.
  
  Throw raw exceptions; DataWriter.write(Record) wraps them via exception(throwable).setRecord(record).
  Specified by:
  
  writeImpl in class DataWriter
  
  Throws:
  
  Throwable
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class DataEndpoint

Class EventBusWriter

Nested Class Summary

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

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Constructor Details

EventBusWriter

Method Details

getEventBus

getEventSource

setEventSource

getTopic

addExceptionProperties

setTopic

open

close

writeImpl

toString