org.opencms.publish

Class CmsPublishListVerifier

java.lang.Object

org.opencms.publish.CmsPublishListVerifier

public class CmsPublishListVerifier
extends java.lang.Object

Performs some additional checks on publish lists to prevent inconsistent VFS states.

Constructor Summary

Constructors

Constructor and Description
CmsPublishListVerifier() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
CmsUUID	addForbiddenParentFolder(java.lang.String parentFolder, java.lang.String reason) Adds a forbidden parent folder.
void	checkPublishList(CmsPublishList publishList) Checks whether the given publish job is OK, and throws an exception otherwise.
void	removeForbiddenParentFolder(CmsUUID id) Removes the forbidden parent folder using the id obtained while it was added.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsPublishListVerifier

public CmsPublishListVerifier()

Creates a new instance.

Method Detail

addForbiddenParentFolder

public CmsUUID addForbiddenParentFolder(java.lang.String parentFolder,
                                        java.lang.String reason)

Adds a forbidden parent folder.

Parameters:

parentFolder - the forbidden parent folder

reason - the reason why publishing is not allowed

Returns:

an ID which can be used later to remove the forbidden parent folder

checkPublishList

public void checkPublishList(CmsPublishList publishList)
                      throws CmsException

Checks whether the given publish job is OK, and throws an exception otherwise.

Parameters:

publishList - the publish list

Throws:

CmsException - if there's something wrong with the publish job

removeForbiddenParentFolder

public void removeForbiddenParentFolder(CmsUUID id)

Removes the forbidden parent folder using the id obtained while it was added.

Parameters:

id - the id to remove the parent folder