Class RetryingReader

Method Details

• getMaxRetryCount

  public int getMaxRetryCount()

  Returns the number of retries allowed for any individual read attempt (default 5).

• setMaxRetryCount

  public RetryingReader setMaxRetryCount(int maxRetryCount)

  Sets the number of retries allowed for any individual read attempt (default 5).

• getMaxErrorCount

  public long getMaxErrorCount()

  Returns the number of retries allowed across all read attempts (default max long - 1).

• setMaxErrorCount

  public RetryingReader setMaxErrorCount(long maxErrorCount)

  Sets the number of retries allowed across all read attempts (default max long -1).

• getInitialRetryDelay

  public long getInitialRetryDelay()

  Returns the amount of time to wait (in milliseconds) after the first error, before retrying (default 1 second).

• setInitialRetryDelay

  public RetryingReader setInitialRetryDelay(long initialRetryDelay)

  Sets the amount of time to wait (in milliseconds) after the first error, before retrying (default 1 second).

• getStrategy

  public IRetryStrategy getStrategy()

  Returns the retry strategy (default RetryStrategy.EXPONENTIAL_BACKOFF).

• setStrategy

  public RetryingReader setStrategy(IRetryStrategy strategy)

  Sets the retry strategy (default RetryStrategy.EXPONENTIAL_BACKOFF).

• getExceptionCount

  public long getExceptionCount()

  Returns the total number of exceptions/failures seen by this reader. This value is also the number of retries as long as maxErrorCount hasn't been exceeded.

• getFirstException

  public Throwable getFirstException()

  Returns the first exception thrown for any individual read attempt. This value will reset on the next read attempt after a successful retry.

• getLastException

  public Throwable getLastException()

  Returns the last exception thrown for any individual read attempt. This value will reset on the next read attempt after a successful retry.

• getDiscardWriter

  public DataWriter getDiscardWriter()

  Returns the discard sink for failing records or null if one was not assigned.

• setDiscardWriter

  public RetryingReader setDiscardWriter(DataWriter writer)

  Assign a discard sink for failing records.

  Parameters:

  writer - the discard sink

• getDiscardReasonFieldName

  public String getDiscardReasonFieldName()

  Returns the field in the record to place the description of the exception that was thrown by the failing read or null if one should not be added.

• setDiscardReasonFieldName

  public RetryingReader setDiscardReasonFieldName(String discardReasonFieldName)

  Specifies the field in the record to place the description of the exception that was thrown by the failing read or null if one should not be added.

• open

  public void open() throws DataException

  Description copied from class: DataEndpoint

  Makes this endpoint ready for reading or writing.

  Overrides:

  open in class ProxyReader

  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 ProxyReader

  Throws:

  DataException

• readImpl

  protected Record readImpl() throws Throwable

  Description copied from class: DataReader

  Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

  If no record is available, null will be returned.

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

  • Return null exactly once to signal end-of-stream.
  • Do not call this method directly — DataReader.read() is the template method that wraps exceptions, increments the record count, and tracks lineage.
  • Do not call DataEndpoint.incrementRecordCount() here; DataReader.read() already does.
  • Throw raw exceptions; DataReader.read() wraps them via exception(throwable).

  Overrides:

  readImpl in class ProxyReader

  Throws:

  Throwable

• onFailure

  protected void onFailure(Record record, Throwable exception)

  Called after each failed read attempt; writes the failing record (when known) to the discard writer, if set, and throws once getMaxErrorCount() is exceeded.

• 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 ProxyReader