com.jalios.jcms.fileprocessor
Class ProcessingException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.jalios.jcms.fileprocessor.ProcessingException

All Implemented Interfaces:

Serializable

public class ProcessingException
extends Exception

Wrapping exception of exception happening during processing or indexing. (If an exception occurred as a FileActionComponent is invoked, not in the FileProcessor architecture). Used for Exception that can be explicitely defined. Exemple : to wrap IOException of the underlying API. While throwing such an exception, given the circonstances, you may :

• either blacklisting the file globally : exemple, the file is a password protected PDF;
• either blacklisting the file only for this processor : a Word95 doc file can't be processed by an OpenOffice processor;
• either not blacklisting the file : for un unknown underlying exception, or if the processor is waiting for external service.

Version:

$Revision: 26564 $

See Also:

Serialized Form

Field Summary

static String

REVISION

Constructor Summary

ProcessingException(String message)

ProcessingException(String message, boolean globalBlacklist)

ProcessingException(String message, Class<? extends FileActionComponent> processorBlackListedClass)

ProcessingException(Throwable cause)

ProcessingException(Throwable cause, boolean globalBlacklist)
A processingException instanciated with this cionstructor must be thrown if an exception occured while processing.

ProcessingException(Throwable cause, Class<? extends FileActionComponent> processorBlackListedClass)

Method Summary

Class<? extends FileActionComponent>	getProcessorBlackListedClass() For certain reason, one file may be blacklisted only for a FileActionComponent, not to cause the same exception, at each iteration.
boolean	isGlobalyBlacklisted() For certain reason, one file may be Globally blacklisted, not to cause the same exception, at each iteration.
boolean	isIgnoreExceptionInLog()
void	setGlobalBlacklist(boolean globalBlacklist) Set the glablal blacklist behaviour.
void	setIgnoreExceptionInLog(boolean ignoreExceptionInLog)
void	setProcessorBlackListedClass(Class<? extends FileActionComponent> processorBlackListedClass)

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

Constructor Detail

ProcessingException

public ProcessingException(Throwable cause)

ProcessingException

public ProcessingException(String message)

ProcessingException

public ProcessingException(Throwable cause,
                           boolean globalBlacklist)

A processingException instanciated with this cionstructor must be thrown if an exception occured while processing.

Parameters:

cause - a possible cause exception (eg. from a used library)

globalBlacklist - if true, the file will be globally blacklisted

ProcessingException

public ProcessingException(String message,
                           boolean globalBlacklist)

Parameters:

message -

globalBlacklist -

ProcessingException

public ProcessingException(Throwable cause,
                           Class<? extends FileActionComponent> processorBlackListedClass)

Parameters:

cause -

processorBlackListedClass -

ProcessingException

public ProcessingException(String message,
                           Class<? extends FileActionComponent> processorBlackListedClass)

Parameters:

message -

processorBlackListedClass -

Method Detail

isGlobalyBlacklisted

public boolean isGlobalyBlacklisted()

For certain reason, one file may be Globally blacklisted, not to cause the same exception, at each iteration.

Returns:

true if the file must be globaly blacklisted

setGlobalBlacklist

public void setGlobalBlacklist(boolean globalBlacklist)

Set the glablal blacklist behaviour.

Parameters:

globalBlacklist -

getProcessorBlackListedClass

public Class<? extends FileActionComponent> getProcessorBlackListedClass()

For certain reason, one file may be blacklisted only for a FileActionComponent, not to cause the same exception, at each iteration.

Returns:

true if the file must be globaly blacklisted

setProcessorBlackListedClass

public void setProcessorBlackListedClass(Class<? extends FileActionComponent> processorBlackListedClass)

isIgnoreExceptionInLog

public boolean isIgnoreExceptionInLog()

setIgnoreExceptionInLog

public void setIgnoreExceptionInLog(boolean ignoreExceptionInLog)