Interface I_CmsPublishEventListener

All Known Implementing Classes:
CmsPublishEventAdapter

public interface I_CmsPublishEventListener
This interface listens to events for a specific publish job.

The life cycle of publish is following:

  • created, getting immediatly
  • enqueued, getting the state waiting
  • during waiting it could be aborted, getting removed (only the abort event is triggered)
  • started, getting the state running
  • finished, getting the state finished
  • removed
During the waiting state a publish job can be aborted for shutdown.

Since:
6.5.5
  • Method Details

    • onAbort

      void onAbort(CmsUUID userId, CmsPublishJobEnqueued publishJob)
      Called when the job is going to be aborted, this may happen during the shutdown And can only happen if the job is waiting.

      Parameters:
      userId - the id of the user that aborted the job
      publishJob - the publish job that is going to be aborted
    • onEnqueue

      void onEnqueue(CmsPublishJobBase publishJob)
      Called once the job is going to be enqueued.

      Parameters:
      publishJob - the publish job that is going to be enqueued
    • onFinish

      void onFinish(CmsPublishJobRunning publishJob)
      Called once the job has finished.

      Parameters:
      publishJob - the publish job that has finished
    • onRemove

      void onRemove(CmsPublishJobFinished publishJob)
      Called once the job is going to be removed from the history.

      Parameters:
      publishJob - the publish job that is going to be removed from the history
    • onStart

      void onStart(CmsPublishJobEnqueued publishJob)
      Called once the job is going to start.

      Parameters:
      publishJob - the publish job that is going to start