Package 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 Description CmsPublishListVerifier()
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
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 folderreason
- 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
-
-