Package org.opencms.publish

Class CmsPublishEventAdapter

java.lang.Object

org.opencms.publish.CmsPublishEventAdapter

All Implemented Interfaces:

I_CmsPublishEventListener

public class CmsPublishEventAdapter
extends java.lang.Object
implements I_CmsPublishEventListener

Default implementation for the I_CmsPublishEventListener.

Since:

6.5.5

Constructor Summary

Constructors

Constructor	Description
CmsPublishEventAdapter()

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsPublishEventAdapter

public CmsPublishEventAdapter()

Method Detail

onAbort

public void onAbort(CmsUUID userId,
                    CmsPublishJobEnqueued publishJob)

Description copied from interface: I_CmsPublishEventListener

Called when the job is going to be aborted, this may happen during the shutdown And can only happen if the job is waiting.

Specified by:

onAbort in interface I_CmsPublishEventListener

Parameters:

userId - the id of the user that aborted the job

publishJob - the publish job that is going to be aborted

See Also:

I_CmsPublishEventListener.onAbort(CmsUUID, org.opencms.publish.CmsPublishJobEnqueued)

onEnqueue

public void onEnqueue(CmsPublishJobBase publishJob)

Description copied from interface: I_CmsPublishEventListener

Called once the job is going to be enqueued.

Specified by:

onEnqueue in interface I_CmsPublishEventListener

Parameters:

publishJob - the publish job that is going to be enqueued

See Also:

I_CmsPublishEventListener.onEnqueue(org.opencms.publish.CmsPublishJobBase)

onFinish

public void onFinish(CmsPublishJobRunning publishJob)

Description copied from interface: I_CmsPublishEventListener

Called once the job has finished.

Specified by:

onFinish in interface I_CmsPublishEventListener

Parameters:

publishJob - the publish job that has finished

See Also:

I_CmsPublishEventListener.onFinish(org.opencms.publish.CmsPublishJobRunning)

onRemove

public void onRemove(CmsPublishJobFinished publishJob)

Description copied from interface: I_CmsPublishEventListener

Called once the job is going to be removed from the history.

Specified by:

onRemove in interface I_CmsPublishEventListener

Parameters:

publishJob - the publish job that is going to be removed from the history

See Also:

I_CmsPublishEventListener.onRemove(org.opencms.publish.CmsPublishJobFinished)

onStart

public void onStart(CmsPublishJobEnqueued publishJob)

Description copied from interface: I_CmsPublishEventListener

Called once the job is going to start.

Specified by:

onStart in interface I_CmsPublishEventListener

Parameters:

publishJob - the publish job that is going to start

See Also:

I_CmsPublishEventListener.onStart(org.opencms.publish.CmsPublishJobEnqueued)