com.levigo.jadice.server.core

Interface WorkerController<N extends Node>

Type Parameters:

N -

All Known Implementing Classes:

AbstractMSWorker, CobraHTMLRendererWorker, DemultiplexerWorker, DocumentPrintWorker, DummyWorker, DynamicPipelineWorker, EmbedAttachmentsWorker, ExternalProcessCallWorker, GhostscriptWorker, HTML2TextWorker, JadiceDocumentInfoWorker, JadiceServerInfoWorker, JadiceToTiffWorker, JavamailInputWorker, LibreOfficeConversionWorker, MailBodyCreatorWorker, MessageRFC822Worker, MSExcelWorker, MSOutlookWorker, MSPowerpointWorker, MSProjectWorker, MSVisioWorker, MSWordWorker, MultipartAlternativeWorker, MultipartAppleDoubleWorker, MultipartEncryptedWorker, MultipartMixedWorker, MultipartRelatedWorker, MultipartSignedWorker, MultiplexerWorker, NodeWorker, NotificationWorker, NullWorker, OLEExtractorWorker, PDFAnnotationRemoverWorker, PDFCompositeWorker, PDFDecryptWorker, PDFImageOptimizationWorker, PDFMergeWorker, PDFMetadataWorker, PDFRotationWorker, PDFSplitWorker, PlaintextToXMLWorker, PortableCollectionDisassemblingWorker, ReshapeWorker, RouterWorker, ScriptWorker, SeparatorPageWorker, StreamAnalysisWorker, StreamInputWorker, StreamOutputWorker, StreamWorker, TIFFMergeWorker, TIFFSplitWorker, TNEFWorker, UnGZIPWorker, UnRARWorker, UnSevenZIPWorker, UnTARWorker, UnZIPWorker, URLInputWorker, URLOutputWorker, XSLFOFormatterWorker, XSLTransformationWorker, ZIPWorker

public interface WorkerController<N extends Node>

Using this interface, Workers can hand over some control over their execution to other classes.

Method Summary

Methods

Modifier and Type	Method and Description
void	error(com.levigo.util.log.qualified.MessageID messageId, Object... args) Emit a non-fatal error to be ultimately propagated to JobListener.
void	error(com.levigo.util.log.qualified.MessageID messageId, Throwable cause, Object... args) Emit a non-fatal error to be ultimately propagated to JobListener.
void	error(com.levigo.util.log.qualified.QualifiedLogEvent event) Emit a non-fatal error to be ultimately propagated to JobListener.
void	fail(com.levigo.util.log.qualified.MessageID messageId, Object... args) Make the worker (and subsequently the node) fail due to the specified reason.
void	fail(com.levigo.util.log.qualified.MessageID messageId, Throwable cause, Object... args) Make the worker (and subsequently the node) fail due to the specified reason.
void	fail(com.levigo.util.log.qualified.QualifiedLogEvent event) Make the worker (and subsequently the node) fail due to the specified reason.
N	getNode() Get the Node.
ServerJob	getServerJob() Get the ServerJob associated with this worker controller.
void	warn(com.levigo.util.log.qualified.MessageID messageId, Object... args) Emit a warning to be ultimately propagated to JobListener.
void	warn(com.levigo.util.log.qualified.MessageID messageId, Throwable cause, Object... args) Emit a warning to be ultimately propagated to JobListener.
void	warn(com.levigo.util.log.qualified.QualifiedLogEvent event) Emit a warning to be ultimately propagated to JobListener.

Method Detail

warn

void warn(com.levigo.util.log.qualified.QualifiedLogEvent event)

Emit a warning to be ultimately propagated to JobListener.

Parameters:

event - the reason of the warning

warn

void warn(com.levigo.util.log.qualified.MessageID messageId,
        Throwable cause,
        Object... args)

Emit a warning to be ultimately propagated to JobListener.

Parameters:

messageId - The messageID of the reason

cause - a Throwable that caused the warning

args - optional arguments that will be resolved in an QualifiedLogEvent

warn

void warn(com.levigo.util.log.qualified.MessageID messageId,
        Object... args)

Emit a warning to be ultimately propagated to JobListener.

Parameters:

messageId - The messageID of the reason

args - optional arguments that will be resolved in an QualifiedLogEvent

error

void error(com.levigo.util.log.qualified.QualifiedLogEvent event)

Emit a non-fatal error to be ultimately propagated to JobListener.

Parameters:

event - the reason of the error

error

void error(com.levigo.util.log.qualified.MessageID messageId,
         Throwable cause,
         Object... args)

Emit a non-fatal error to be ultimately propagated to JobListener.

Parameters:

messageId - The messageID of the reason

cause - a Throwable that caused the error

args - optional arguments that will be resolved in an QualifiedLogEvent

error

void error(com.levigo.util.log.qualified.MessageID messageId,
         Object... args)

Emit a non-fatal error to be ultimately propagated to JobListener.

Parameters:

messageId - The messageID of the reason

args - optional arguments that will be resolved in an QualifiedLogEvent

fail

void fail(com.levigo.util.log.qualified.QualifiedLogEvent event)

Make the worker (and subsequently the node) fail due to the specified reason. This method will always throw a special kind of RuntimeException used to bubble-up the failure information.

Parameters:

event - the reason of the failure

fail

void fail(com.levigo.util.log.qualified.MessageID messageId,
        Throwable cause,
        Object... args)

Make the worker (and subsequently the node) fail due to the specified reason. This method will always throw a special kind of RuntimeException used to bubble-up the failure information.

Parameters:

messageId - The messageID of the reason

cause - a Throwable that caused the failure

args - optional arguments that will be resolved in an QualifiedLogEvent

fail

void fail(com.levigo.util.log.qualified.MessageID messageId,
        Object... args)

Make the worker (and subsequently the node) fail due to the specified reason. This method will always throw a special kind of RuntimeException used to bubble-up the failure information.

Parameters:

messageId - The messageID of the reason

args - optional arguments that will be resolved in an QualifiedLogEvent

getNode

N getNode()

Get the Node.

getServerJob

ServerJob getServerJob()

Get the ServerJob associated with this worker controller.