com.northconcepts.datapipeline.core

Class AsyncWriter

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.core.AsyncWriter

public class AsyncWriter
extends ProxyWriter

A proxy that writes data asynchronously using a separate thread.

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
AsyncWriter(DataWriter nestedDataWriter) Creates an AsyncWriter object, with the given DataWriter and default capacity of 500 records that can be queued.
AsyncWriter(DataWriter nestedDataWriter, int maxQueuedRecords) Creates an AsyncWriter object, with the given DataWriter and maximum number of records that can be queued.

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
protected DataException	addExceptionPropertiesImpl(DataException exception)
int	available() Returns the number of records that can probably be written without blocking.
void	close() Indicates that this endpoint has finished reading or writing.
DataException	exception(String message) Creates an exception with the specified message and containing this endpoint's properties (name-value pairs).
DataException	exception(String message, Throwable exception) Converts an exception to a DataException, prefixing the original message with the specified text and adding this endpoint's properties (name-value pairs).
DataException	exception(Throwable exception) Converts an exception to a DataException and adds this endpoint's properties (name-value pairs).
long	getBufferSizeInBytes()
DataException	getException()
long	getPeakBufferSizeInBytes()
int	getPriority()
void	open() Makes this endpoint ready for reading or writing.
void	rethrowAsyncException() Rethrows the exception thrown by the internal thread or returns silently if no exception was thrown.
AsyncWriter	setPriority(int priority)
void	write(Record record) Writes the specified record to this DataWriter and increases the record-count by 1.
protected void	writeImpl(Record record) Overridden by subclasses to write the specified record to this DataWriter.

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

getNestedWriter, interceptRecord, map, map, setNestedDataWriter, setNestedDataWriter

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

getNestedEndpoint, getRootEndpoint, getRootWriter

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

getId, getName, resetID

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncWriter

public AsyncWriter(DataWriter nestedDataWriter,
                   int maxQueuedRecords)

Creates an AsyncWriter object, with the given DataWriter and maximum number of records that can be queued.

AsyncWriter

public AsyncWriter(DataWriter nestedDataWriter)

Creates an AsyncWriter object, with the given DataWriter and default capacity of 500 records that can be queued.

Method Detail

getBufferSizeInBytes

public long getBufferSizeInBytes()

getPeakBufferSizeInBytes

public long getPeakBufferSizeInBytes()

getPriority

public int getPriority()

setPriority

public AsyncWriter setPriority(int priority)

getException

public DataException getException()

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class ProxyWriter

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 ProxyWriter

Throws:

DataException

available

public int available()
              throws DataException

Description copied from class: DataWriter

Returns the number of records that can probably be written without blocking.

Overrides:

available in class ProxyWriter

Throws:

DataException

write

public void write(Record record)
           throws DataException

Description copied from class: DataWriter

Writes the specified record to this DataWriter and increases the record-count by 1. Any exception raised while writing will be converted to a DataException using DataObject.exception(Throwable).

Subclasses generally do not need to override this method, instead they should implement DataWriter.writeImpl(Record).

Overrides:

write in class DataWriter

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.

Overrides:

writeImpl in class ProxyWriter

Throws:

Throwable

rethrowAsyncException

public void rethrowAsyncException()

Rethrows the exception thrown by the internal thread or returns silently if no exception was thrown.

exception

public final DataException exception(String message,
                                     Throwable exception)

Description copied from class: DataObject

Converts an exception to a DataException, prefixing the original message with the specified text and adding this endpoint's properties (name-value pairs).

The returned exception can then be thrown in the normal way.

If the supplied exception is an instanceof DataException, it will be returned, otherwise it will be nested inside a DataException. In either case the result message will contain the new prefix along with this endpoint properties.

Overrides:

exception in class DataObject

exception

public final DataException exception(Throwable exception)

Description copied from class: DataObject

Converts an exception to a DataException and adds this endpoint's properties (name-value pairs).

The returned exception can then be thrown in the normal way.

If the supplied exception is an instanceof DataException, it will be returned, otherwise it will be nested inside a DataException. In either case the result message will contain this endpoint properties.

Overrides:

exception in class DataObject

exception

public final DataException exception(String message)

Description copied from class: DataObject

Creates an exception with the specified message and containing this endpoint's properties (name-value pairs).

The returned exception can then be thrown in the normal way.

Overrides:

exception in class DataObject

addExceptionProperties

public final 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 ProxyWriter

addExceptionPropertiesImpl

protected DataException addExceptionPropertiesImpl(DataException exception)