org.opencms.publish

类 CmsPublishQueue

java.lang.Object

org.opencms.publish.CmsPublishQueue

public class CmsPublishQueue
extends java.lang.Object

This queue contains all not jet started publish jobs.

从以下版本开始:

6.5.5

字段概要

字段

限定符和类型	字段和说明
protected CmsPublishEngine	m_publishEngine The publish engine.

构造器概要

构造器

限定符	构造器和说明
protected	CmsPublishQueue(CmsPublishEngine publishEngine) Default constructor, for an empty queue.

方法概要

方法

限定符和类型	方法和说明
protected boolean	abortPublishJob(CmsPublishJobInfoBean publishJob) Aborts the given publish job.
protected void	add(CmsPublishJobInfoBean publishJob) Pushes a new publish job with the given information in publish queue.
protected java.util.List<CmsPublishJobEnqueued>	asList() Returns an unmodifiable list representation of this queue.
protected boolean	contains(CmsPublishJobInfoBean publishJob) Checks if the given job is already in the queue, this does only check for the identical job.
static org.apache.commons.collections.Buffer	getQueue() Creates the buffer used as publish queue.
protected void	initialize(CmsObject adminCms, boolean revive) Initializes the internal FIFO queue with publish jobs from the database.
protected boolean	isEmpty() Checks if the queue is empty.
protected CmsPublishJobInfoBean	next() Returns the next publish job to be published, removing it from the queue, or null if the queue is empty.
protected void	remove(CmsPublishJobInfoBean publishJob) Removes the given job from the list.
protected void	update(CmsPublishJobInfoBean publishJob) Updates the given job in the list.

从类继承的方法 java.lang.Object

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

字段详细资料

m_publishEngine

protected final CmsPublishEngine m_publishEngine

The publish engine.

构造器详细资料

CmsPublishQueue

protected CmsPublishQueue(CmsPublishEngine publishEngine)

Default constructor, for an empty queue.

参数:

publishEngine - the publish engine instance

方法详细资料

getQueue

public static org.apache.commons.collections.Buffer getQueue()

Creates the buffer used as publish queue.

返回:

the queue buffer

abortPublishJob

protected boolean abortPublishJob(CmsPublishJobInfoBean publishJob)

Aborts the given publish job.

参数:

publishJob - the publish job to abort

返回:

true if the publish job was found

add

protected void add(CmsPublishJobInfoBean publishJob)
            throws CmsException

Pushes a new publish job with the given information in publish queue.

If possible, the publish job starts immediately.

参数:

publishJob - the publish job to enqueue

抛出:

CmsException - if something goes wrong

asList

protected java.util.List<CmsPublishJobEnqueued> asList()

Returns an unmodifiable list representation of this queue.

返回:

a list of CmsPublishJobEnqueued objects

contains

protected boolean contains(CmsPublishJobInfoBean publishJob)

Checks if the given job is already in the queue, this does only check for the identical job.

参数:

publishJob - the publish job to check for

返回:

true if the given job is already in the queue

initialize

protected void initialize(CmsObject adminCms,
              boolean revive)

Initializes the internal FIFO queue with publish jobs from the database.

参数:

adminCms - an admin cms object

revive - true if the publish queue should be revived from the database

isEmpty

protected boolean isEmpty()

Checks if the queue is empty.

返回:

true if the queue is empty

next

protected CmsPublishJobInfoBean next()

Returns the next publish job to be published, removing it from the queue, or null if the queue is empty.

返回:

the next publish job to be published

remove

protected void remove(CmsPublishJobInfoBean publishJob)
               throws CmsException

Removes the given job from the list.

参数:

publishJob - the publish job to remove

抛出:

CmsException - if something goes wrong

update

protected void update(CmsPublishJobInfoBean publishJob)

Updates the given job in the list.

参数:

publishJob - the publish job to