Package org.opencms.publish

Class CmsPublishHistory

java.lang.Object

org.opencms.publish.CmsPublishHistory

public class CmsPublishHistory
extends Object

List of already finished publish jobs.

Since:

6.5.5

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.commons.logging.Log	LOG	The log object for this class.
protected final CmsPublishEngine	m_publishEngine	The publish engine.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsPublishHistory(CmsPublishEngine publishEngine)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected void	add(CmsPublishJobInfoBean publishJob)	Adds the given publish job to the list.
protected List<CmsPublishJobFinished>	asList()	Returns an unmodifiable list representation of this list.
static org.apache.commons.collections.Buffer	getQueue(int size)	Returns (and initializes) the queue.
protected void	initialize()	Initializes the internal FIFO queue with publish jobs from the database.
protected void	remove(CmsPublishJobInfoBean publishJob)	Removes the given job from the list.

Methods inherited from class java.lang.Object

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

Field Details

LOG

protected static final org.apache.commons.logging.Log LOG

The log object for this class.

m_publishEngine

protected final CmsPublishEngine m_publishEngine

The publish engine.

Constructor Details

CmsPublishHistory

protected CmsPublishHistory(CmsPublishEngine publishEngine)

Default constructor.

Parameters:

publishEngine - the publish engine instance

Method Details

getQueue

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

Returns (and initializes) the queue.

Parameters:

size - the history size

Returns:

the queue buffer

add

protected void add(CmsPublishJobInfoBean publishJob)
            throws CmsException

Adds the given publish job to the list.

Parameters:

publishJob - the publish job object to add

Throws:

CmsException - if something goes wrong

asList

protected List<CmsPublishJobFinished> asList()

Returns an unmodifiable list representation of this list.

Returns:

a list of CmsPublishJobFinished objects

initialize

protected void initialize()

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

remove

protected void remove(CmsPublishJobInfoBean publishJob)
               throws CmsException

Removes the given job from the list.

Parameters:

publishJob - the publish job to remove

Throws:

CmsException - if something goes wrong