com.endeca.cas.extension
Interface ErrorChannel

public interface ErrorChannel

The ErrorChannel provides methods for discarding records that are deemed invalid. Calling any of the discard methods in this class will increment the FAILED_RECORDS ("Failed Records") metric, stop further processing of the discarded record, and log a truncated version of the record. The messages are logged at the WARN level.

An instance of this class is accessible through PipelineComponentRuntimeContext

See Also:

ManipulatorRuntime.processRecord(Record)

Method Summary

void	discard(Record record, String error) Discards an invalid record created by a DataSourceRuntime or processed by a ManipulatorRuntime.
void	discard(Record record, String error, Throwable t) Discards an invalid record created by a DataSourceRuntime or processed by a ManipulatorRuntime.
void	discard(Record record, Throwable t) Discards an invalid record created by a DataSourceRuntime or processed by a ManipulatorRuntime.

Method Detail

discard

void discard(Record record,
             String error)

Discards an invalid record created by a DataSourceRuntime or processed by a ManipulatorRuntime. A discarded record will not continue through the pipeline.

Parameters:

record - the record to discard

error - the error associated with this record

discard

void discard(Record record,
             Throwable t)

Discards an invalid record created by a DataSourceRuntime or processed by a ManipulatorRuntime. A discarded record will not continue through the pipeline.

Parameters:

record - the record to discard

t - the Throwable associated with this record

discard

void discard(Record record,
             String error,
             Throwable t)

Discards an invalid record created by a DataSourceRuntime or processed by a ManipulatorRuntime. A discarded record will not continue through the pipeline.

Parameters:

record - the record to discard

error - the error associated with this record

t - the Throwable associated with this record