Package com.priint.pubserver.comet.renderer

Class ReadDocumentJob

  • All Implemented Interfaces:
    DocumentJob, RendererJob
    @Deprecated
public abstract class ReadDocumentJob
extends java.lang.Object
implements DocumentJob
    Deprecated.
    The Class ReadDocumentJob.

    • Constructor Summary

      Constructors 
      Constructor Description
      ReadDocumentJob()
      Deprecated.
       

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean documentHasChanged()
      Deprecated.
      Gets, whether the document has changed.
      void executionFailed​(java.lang.String documentId, java.lang.Throwable cause)
      Deprecated.
      Called when job execution fails
      void finishingFailed​(java.lang.String documentId, java.lang.Throwable cause)
      Deprecated.
      Called when finishing the job fails
      void finishJob​(java.lang.String documentId, java.lang.String documentPath)
      Deprecated.
      Called after executing a job.
      java.lang.Object getJobExecutionFlag​(JobExecutionFlag flag)
      Deprecated.
      Gets execution flags for this job.
      java.lang.String getName()
      Deprecated.
      Gets the job name (e.g.
      void preconditionsFailed​(java.lang.String documentId, java.lang.Throwable cause)
      Deprecated.
      Called when checking preconditions fails
      void preparationFailed​(java.lang.String documentId, java.lang.Throwable cause)
      Deprecated.
      Called when preparing the job fails
      void prepareJob​(java.lang.String documentId, java.lang.String documentPath)
      Deprecated.
      Called before executing a job

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ReadDocumentJob

        public ReadDocumentJob()
        Deprecated.

    • Method Detail

      • getName

        public java.lang.String getName()
        Deprecated.
        Description copied from interface: RendererJob

        Gets the job name (e.g. for log output)

        Specified by:
        getName in interface RendererJob
        Returns:
        the job name

      • getJobExecutionFlag

        public java.lang.Object getJobExecutionFlag​(JobExecutionFlag flag)
        Deprecated.
        Description copied from interface: RendererJob

        Gets execution flags for this job.

        See the JobExecutionFlag enumeration for a list of available flags supported for DocumentJobs and the default value for these flags.

        Specified by:
        getJobExecutionFlag in interface RendererJob
        Parameters:
        flag - the flag
        Returns:
        value for this execution flag

      • prepareJob

        public void prepareJob​(java.lang.String documentId,
                       java.lang.String documentPath)
                throws PubServerException
        Deprecated.
        Description copied from interface: RendererJob

        Called before executing a job

        This method is called after checking preconditions and before locking a renderer instance for this job.
        A typical prepareJob implementation could delete a previous version of the document and copy again from master document (such as in CScript jobs).

        Specified by:
        prepareJob in interface RendererJob
        Parameters:
        documentId - Id of the document, which will be processed in this job
        documentPath - real path of the document
        Throws:
        PubServerException - the pub server exception

      • finishJob

        public void finishJob​(java.lang.String documentId,
                      java.lang.String documentPath)
               throws PubServerException
        Deprecated.
        Description copied from interface: RendererJob

        Called after executing a job.

        Called after (successfully) running the RendererJob.executeJob(String, String, Comet) method.
        This method allows implementation of cleanup or update tasks (e.g. "register in DB"). The method will be called only, when no exception was raised during job execution.

        Specified by:
        finishJob in interface RendererJob
        Parameters:
        documentId - Id of the document, which has been processed.
        documentPath - real path of the document
        Throws:
        PubServerException - the pub server exception

      • executionFailed

        public void executionFailed​(java.lang.String documentId,
                            java.lang.Throwable cause)
        Deprecated.
        Description copied from interface: RendererJob

        Called when job execution fails

        Called, when an exception was raised during the RendererJob.executeJob(String, String, Comet) call.

        Specified by:
        executionFailed in interface RendererJob
        Parameters:
        documentId - Id of the document, which should be processed.
        cause - exception caught during job execution

      • preconditionsFailed

        public void preconditionsFailed​(java.lang.String documentId,
                                java.lang.Throwable cause)
        Deprecated.
        Description copied from interface: RendererJob

        Called when checking preconditions fails

        Called, when an exception was raised during checking job preconditions.

        Specified by:
        preconditionsFailed in interface RendererJob
        Parameters:
        documentId - Id of the document, which should be processed.
        cause - exception caught during job execution

      • preparationFailed

        public void preparationFailed​(java.lang.String documentId,
                              java.lang.Throwable cause)
        Deprecated.
        Description copied from interface: RendererJob

        Called when preparing the job fails

        Called, when an exception was raised during the RendererJob.prepareJob(String, String) call.

        Specified by:
        preparationFailed in interface RendererJob
        Parameters:
        documentId - Id of the document, which should be processed.
        cause - exception caught during job preparation

      • finishingFailed

        public void finishingFailed​(java.lang.String documentId,
                            java.lang.Throwable cause)
        Deprecated.
        Description copied from interface: RendererJob

        Called when finishing the job fails

        Called, when an exception was raised during the RendererJob.finishJob(String, String) call.

        Specified by:
        finishingFailed in interface RendererJob
        Parameters:
        documentId - Id of the document, which should be processed.
        cause - exception caught during job finishing

      • documentHasChanged

        public boolean documentHasChanged()
        Deprecated.
        Description copied from interface: DocumentJob

        Gets, whether the document has changed.

        Gets, whether the document has changed. This method should return true, if the document has changed and therefore caches / database information for this document must be updated after execution.

        Specified by:
        documentHasChanged in interface DocumentJob
        Returns:
        true, if the document has changed, false otherwise