org.opencms.publish
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:

During the waiting state a publish job can be aborted for shutdown.

Since:
6.5.5
Version:
$Revision: 1.4 $
Author:
Michael Moossen

Method Summary
 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.
 void onEnqueue(CmsPublishJobBase publishJob)
          Called once the job is going to be enqueued.
 void onFinish(CmsPublishJobRunning publishJob)
          Called once the job has finished.
 void onRemove(CmsPublishJobFinished publishJob)
          Called once the job is going to be removed from the history.
 void onStart(CmsPublishJobEnqueued publishJob)
          Called once the job is going to start.
 

Method Detail

onAbort

public 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

public 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

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

Parameters:
publishJob - the publish job that has finished

onRemove

public 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

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

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