Package com.priint.pubserver.comet.renderer

Class PublicationJobImpl

java.lang.Object
com.priint.pubserver.comet.renderer.PublicationJobImpl
All Implemented Interfaces:
PublicationJob
@Deprecated public abstract class PublicationJobImpl extends Object implements PublicationJob
Deprecated.
The Class PublicationJobImpl.

  • Constructor Details

    • PublicationJobImpl

      public PublicationJobImpl()
      Deprecated.

  • Method Details

    • getName

      public String getName()
      Deprecated.
      Description copied from interface: PublicationJob

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

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

    • getJobExecutionFlag

      public Object getJobExecutionFlag(JobExecutionFlag flag)
      Deprecated.
      Description copied from interface: PublicationJob

      Gets execution flags for this job.

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

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

    • prepareJob

      public void prepareJob(String publicationId, List<Publication> publications) throws PubServerException
      Deprecated.
      Description copied from interface: PublicationJob

      Called before executing a job

      This method is called before locking a renderer instance for this job and only, if the job mode for this publication job is PUBLICATION_ALL_IN_ONE.

      Specified by:
      prepareJob in interface PublicationJob
      Parameters:
      publicationId - Id of the publication, which will be processed in this job
      publications - the publications
      Throws:
      PubServerException - the pub server exception

    • executeJob

      public abstract jakarta.activation.DataHandler executeJob(String publicationId, List<Publication> publications, Comet renderer) throws PubServerException
      Deprecated.
      Description copied from interface: PublicationJob

      Runs a job for the publication described by publicationId with the renderer instance provided.

      When this method is called,

      • all preconditions have been checked
      • job preparations implemented in #prepareJob(String, String) have been executed
      • a renderer instance has been locked for this job
      It is guaranteed, that no other process will use this renderer instance, until the method has finished. It is also guaranteed, that all documents of the publication are available, before this method is called. Opening and closing these documents is subject to the job implementation respectively the script that is called on the renderer

      Specified by:
      executeJob in interface PublicationJob
      Parameters:
      publicationId - TODO
      publications - the publications
      renderer - the renderer
      Returns:
      arbitrary String with job result or result description
      Throws:
      PubServerException - the pub server exception

    • finishJob

      public void finishJob(String publicationId, List<Publication> publications) throws PubServerException
      Deprecated.
      Description copied from interface: PublicationJob

      Called after executing a job.

      Called after (successfully) running the #executeJob(String, List<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 PublicationJob
      Parameters:
      publicationId - Id of the document, which has been processed.
      publications - the publications
      Throws:
      PubServerException - the pub server exception

    • executionFailed

      public void executionFailed(String publicationId, List<Publication> publications, Throwable cause)
      Deprecated.
      Description copied from interface: PublicationJob

      Called when job execution fails

      Called, when an exception was raised during the #executeJob(String, List<String>, Comet) call.

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

    • preconditionsFailed

      public void preconditionsFailed(String publicationId, List<Publication> publications, Throwable cause)
      Deprecated.
      Description copied from interface: PublicationJob

      Called when checking preconditions fails

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

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

    • preparationFailed

      public void preparationFailed(String publicationId, List<Publication> publications, Throwable cause)
      Deprecated.
      Description copied from interface: PublicationJob

      Called when preparing the job fails

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

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

    • finishingFailed

      public void finishingFailed(String publicationId, List<Publication> publications, Throwable cause)
      Deprecated.
      Description copied from interface: PublicationJob

      Called when finishing the job fails

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

      Specified by:
      finishingFailed in interface PublicationJob
      Parameters:
      publicationId - Id of the document, which should be processed.
      publications - the publications
      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