com.attivio.sdk.server.component.ingest

Interface ProcessingFeedbackHandler

All Known Implementing Classes:

MockProcessingFeedbackHandler

public interface ProcessingFeedbackHandler

Interface for ingest transformers to implement if they wish to pass additional feedback to the client about the processing of the message or document. The current document/message will automatically be inserted into the message results.

Method Summary

Modifier and Type	Method and Description
void	debug(IngestDocument doc, String message, Object... args) Return a debug message result to the client about the processing results of the current document.
void	drop(IngestDocument ingestDocument) Report a dropped document
void	drop(PlatformMessage message) Report a dropped message
void	error(IngestDocument doc, Exception e, String message, Object... args) Report an error to the client about the processing results of the current document.
void	fail(IngestDocument doc, ErrorCode code, Throwable e)
void	warn(IngestDocument doc, ErrorCode code, Throwable e)
void	warn(IngestDocument doc, Exception e, String message, Object... args) Warn the client about the processing results of the current document.

Method Detail

warn

void warn(IngestDocument doc,
          Exception e,
          String message,
          Object... args)

Warn the client about the processing results of the current document. Prints the most direct information when message is null and an AttivioException is provided.

Parameters:

doc -

e - if e is an AttivioException and message is null, then the warning is composed entirely of the exception. Otherwise the warning will reference the exception but the message will be used.

message -

args -

error

void error(IngestDocument doc,
           Exception e,
           String message,
           Object... args)

Report an error to the client about the processing results of the current document. Prints the most direct information when message is null and an AttivioException is provided.

Parameters:

doc -

e - if e is an AttivioException and message is null, then the error is composed entirely of the exception. Otherwise the error will reference the exception but the message will be used.

message -

args -

debug

void debug(IngestDocument doc,
           String message,
           Object... args)

Return a debug message result to the client about the processing results of the current document.

warn

void warn(IngestDocument doc,
          ErrorCode code,
          Throwable e)

fail

void fail(IngestDocument doc,
          ErrorCode code,
          Throwable e)

drop

void drop(IngestDocument ingestDocument)

Report a dropped document

Parameters:

ingestDocument -

drop

void drop(PlatformMessage message)

Report a dropped message

Parameters:

message -