Package com.jalios.jcms.fileprocessor

Class ProcessingException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    ProcessingPostponedException
    public class ProcessingException
extends java.lang.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

      Fields 
      Modifier and Type Field Description
      static java.lang.String REVISION  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.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​(java.lang.Class<? extends FileActionComponent> processorBlackListedClass)  

      • Methods inherited from class java.lang.Throwable

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ProcessingException

        public ProcessingException​(java.lang.Throwable cause)

      • ProcessingException

        public ProcessingException​(java.lang.String message)

      • ProcessingException

        public ProcessingException​(java.lang.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​(java.lang.String message,
                           boolean globalBlacklist)
        Parameters:
        message -
        globalBlacklist -

      • ProcessingException

        public ProcessingException​(java.lang.Throwable cause,
                           java.lang.Class<? extends FileActionComponent> processorBlackListedClass)
        Parameters:
        cause -
        processorBlackListedClass -

      • ProcessingException

        public ProcessingException​(java.lang.String message,
                           java.lang.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 java.lang.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​(java.lang.Class<? extends FileActionComponent> processorBlackListedClass)

      • isIgnoreExceptionInLog

        public boolean isIgnoreExceptionInLog()

      • setIgnoreExceptionInLog

        public void setIgnoreExceptionInLog​(boolean ignoreExceptionInLog)