Package com.priint.pubserver.comet.renderer

Interface PublicationJob

  • All Known Implementing Classes:
    PublicationJobImpl
    @Deprecated
public interface PublicationJob
    Deprecated.
    The Interface PublicationJob.

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      javax.activation.DataHandler executeJob​(java.lang.String publicationId, java.util.List<Publication> publications, Comet renderer)
      Deprecated.
      Runs a job for the publication described by publicationId with the renderer instance provided.
      void executionFailed​(java.lang.String publicationId, java.util.List<Publication> publications, java.lang.Throwable cause)
      Deprecated.
      Called when job execution fails
      void finishingFailed​(java.lang.String publicationId, java.util.List<Publication> publications, java.lang.Throwable cause)
      Deprecated.
      Called when finishing the job fails
      void finishJob​(java.lang.String publicationId, java.util.List<Publication> publications)
      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 publicationId, java.util.List<Publication> publications, java.lang.Throwable cause)
      Deprecated.
      Called when checking preconditions fails
      void preparationFailed​(java.lang.String publicationId, java.util.List<Publication> publications, java.lang.Throwable cause)
      Deprecated.
      Called when preparing the job fails
      void prepareJob​(java.lang.String publicationId, java.util.List<Publication> publications)
      Deprecated.
      Called before executing a job

    • Method Detail

      • getName

        java.lang.String getName()
        Deprecated.

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

        Returns:
        the job name

      • getJobExecutionFlag

        java.lang.Object getJobExecutionFlag​(JobExecutionFlag flag)
        Deprecated.

        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.

        Parameters:
        flag - the flag
        Returns:
        value for this execution flag

      • prepareJob

        void prepareJob​(java.lang.String publicationId,
                java.util.List<Publication> publications)
         throws PubServerException
        Deprecated.

        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.

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

      • executeJob

        javax.activation.DataHandler executeJob​(java.lang.String publicationId,
                                        java.util.List<Publication> publications,
                                        Comet renderer)
                                 throws PubServerException
        Deprecated.

        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

        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

        void finishJob​(java.lang.String publicationId,
               java.util.List<Publication> publications)
        throws PubServerException
        Deprecated.

        Called after executing a job.

        Called after (successfully) running the #executeJob(String, List, 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.

        Parameters:
        publicationId - Id of the document, which has been processed.
        publications - the publications
        Throws:
        PubServerException - the pub server exception

      • executionFailed

        void executionFailed​(java.lang.String publicationId,
                     java.util.List<Publication> publications,
                     java.lang.Throwable cause)
        Deprecated.

        Called when job execution fails

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

        Parameters:
        publicationId - Id of the document, which should be processed.
        publications - the publications
        cause - exception caught during job execution

      • preconditionsFailed

        void preconditionsFailed​(java.lang.String publicationId,
                         java.util.List<Publication> publications,
                         java.lang.Throwable cause)
        Deprecated.

        Called when checking preconditions fails

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

        Parameters:
        publicationId - Id of the document, which should be processed.
        publications - the publications
        cause - exception caught during job execution

      • preparationFailed

        void preparationFailed​(java.lang.String publicationId,
                       java.util.List<Publication> publications,
                       java.lang.Throwable cause)
        Deprecated.

        Called when preparing the job fails

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

        Parameters:
        publicationId - Id of the document, which should be processed.
        publications - the publications
        cause - exception caught during job preparation

      • finishingFailed

        void finishingFailed​(java.lang.String publicationId,
                     java.util.List<Publication> publications,
                     java.lang.Throwable cause)
        Deprecated.

        Called when finishing the job fails

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

        Parameters:
        publicationId - Id of the document, which should be processed.
        publications - the publications
        cause - exception caught during job finishing