Package com.priint.pubserver.comet.renderer

Class DocumentJobImpl

java.lang.Object
com.priint.pubserver.comet.renderer.DocumentJobImpl
All Implemented Interfaces:
DocumentJob, RendererJob
@Deprecated public abstract class DocumentJobImpl extends Object implements DocumentJob
Deprecated.
The Class DocumentJobImpl.

  • Constructor Details

    • DocumentJobImpl

      public DocumentJobImpl()
      Deprecated.

  • Method Details

    • getJobExecutionFlag

      public 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

    • getName

      public 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

    • 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

    • prepareJob

      public void prepareJob(String documentId, 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(String documentId, 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(String documentId, 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(String documentId, 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(String documentId, 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(String documentId, 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

    • hasSucceeded

      public boolean hasSucceeded()
      Deprecated.
      Checks for succeeded.
      Returns:
      true, if successful

    • getFailureCause

      public Throwable getFailureCause()
      Deprecated.
      Gets the failure cause.
      Returns:
      the failure cause