senselogic.sitevision.api.versioning

Interface PublishingUtil

@Requireable(value="PublishingUtil")
public interface PublishingUtil

Publishing/unpublishing utility interface.

Note that when publishing a child node and the parent node hasn't been published, the child node publishing will be put on hold (marked with a pause sign in editor) until the parent is published.

When publishing a page - consider use of Publisher instead, which is a more powerful and flexible publishing interface.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getPublishingUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 2.6.1_04

Author:

Mikael Wikblom

See Also:

Publisher

Method Summary

Modifier and Type	Method and Description
void	clearPublishingSchedule(Node aNode) Clears the publish and unpublish schedule for a node.
PublisherBuilder	getPublisherBuilder() Gets a PublisherBuilder instance that offers more flexible publishing options than the publish methods in this interface.
PublishStatus	getPublishStatus(Node aNode) Gets the publish status of a node.
void	publishNode(Node aNode) Publishes a node.
void	publishNode(Node aNode, Date aPublishDate) Schedules a node publish job for execution at a specified date.
void	publishNode(Node aNode, Date aPublishDate, Date aUnpublishDate) Schedules a node publish job for execution at a specified date and a node unpublish job for execution at another date.
void	publishNodeWithNotification(Node aNode, Date aNotificationDate) Publishes a node instantly with a best before notification date.
void	publishNodeWithNotification(Node aNode, Date aPublishDate, Date aNotificationDate) Schedules a node publish job for execution at a specified date with a best before notification date.
void	publishNodeWithNotification(Node aNode, Date aPublishDate, Date aUnpublishDate, Date aNotificationDate) Schedules a node publish job for execution at a specified date and a node unpublish job for execution at a later date and a best before notification date.
void	unpublishNode(Node aNode) Unpublishes a node.
void	unpublishNode(Node aNode, Date aUnpublishDate) Schedules a node unpublish job for execution at a specified date.

Method Detail

publishNode

void publishNode(Node aNode)
          throws ConstraintViolationException,
                 RepositoryException

Publishes a node.

Valid nodes are sv:sitePage, sv:page, sv:article, sv:collaborationGroupPage, sv:template and sv:link (must be a "page link", a stand-alone link in the page tree). If another node is specified an IllegalArgumentException is thrown.

If no node is specified a NullPointerException is thrown.

The current user must be authorized to publish nodes or a ConstraintViolationException will be thrown.

Parameters:

aNode - the node that should be published. May not be null

Throws:

ConstraintViolationException - if current user is not authorized to publish nodes

RepositoryException - if something else goes wrong

See Also:

PermissionUtil.hasEffectivePublishPermission(Node, Node), Publisher

publishNode

void publishNode(Node aNode,
                 Date aPublishDate)
          throws ConstraintViolationException,
                 RepositoryException

Schedules a node publish job for execution at a specified date.

Valid nodes are sv:sitePage, sv:page, sv:article, sv:collaborationGroupPage, sv:template and sv:link (must be a "page link", a stand-alone link in the page tree). If another node is specified an IllegalArgumentException is thrown.

If no node is specified a NullPointerException is thrown.

The current user must be authorized to publish nodes or a ConstraintViolationException will be thrown.

Parameters:

aNode - the node that should be published

aPublishDate - the publish date

Throws:

ConstraintViolationException - if current user is not authorized to publish nodes

RepositoryException - if something else goes wrong

See Also:

PermissionUtil.hasEffectivePublishPermission(Node, Node), Publisher

publishNode

void publishNode(Node aNode,
                 Date aPublishDate,
                 Date aUnpublishDate)
          throws ConstraintViolationException,
                 RepositoryException

Schedules a node publish job for execution at a specified date and a node unpublish job for execution at another date.

Valid nodes are sv:sitePage, sv:page, sv:article, sv:collaborationGroupPage, sv:template and sv:link (must be a "page link", a stand-alone link in the page tree). If another node is specified an IllegalArgumentException is thrown.

If no node is specified a NullPointerException is thrown.

The current user must be authorized to publish nodes or a ConstraintViolationException will be thrown.

Parameters:

aNode - the node that should be published

aPublishDate - the publish date

aUnpublishDate - the unpublish date

Throws:

ConstraintViolationException - if current user is not authorized to publish nodes

RepositoryException - if something else goes wrong

See Also:

PermissionUtil.hasEffectivePublishPermission(Node, Node), Publisher

publishNodeWithNotification

void publishNodeWithNotification(Node aNode,
                                 Date aNotificationDate)
                          throws ConstraintViolationException,
                                 IllegalArgumentException,
                                 RepositoryException

Publishes a node instantly with a best before notification date.

Valid nodes are sv:sitePage, sv:page, sv:article, sv:collaborationGroupPage, sv:template and sv:link (must be a "page link", a stand-alone link in the page tree). If another node is specified an IllegalArgumentException is thrown.

If a aNotificationDate is before current date a notification will be sent instantly. If aNotificationDate is null, no notification will be sent.

The current user must be authorized to publish nodes or a ConstraintViolationException will be thrown.

Parameters:

aNode - the node that should be published. Valid nodes are sv:sitePage, sv:page, sv:article and sv:template.

aNotificationDate - best-before notification date.

Throws:

NullPointerException - if aNode is null.

IllegalArgumentException - if aNode is of invalid type.

ConstraintViolationException - if current user is not authorized to publish nodes.

RepositoryException - on unexpected failures.

Since:

Sitevision 2.6.2_05

See Also:

PermissionUtil.hasEffectivePublishPermission(Node, Node), Publisher

publishNodeWithNotification

void publishNodeWithNotification(Node aNode,
                                 Date aPublishDate,
                                 Date aNotificationDate)
                          throws ConstraintViolationException,
                                 IllegalArgumentException,
                                 RepositoryException

Schedules a node publish job for execution at a specified date with a best before notification date.

Valid nodes are sv:sitePage, sv:page, sv:article, sv:collaborationGroupPage, sv:template and sv:link (must be a "page link", a stand-alone link in the page tree). If another node is specified an IllegalArgumentException is thrown.

If aNotificationDate is null no notification will be sent. If aNotificationDate is before aPublishDate no notification will be sent since node hasn't been published yet. If a aNotificationDate is before current date, a notification will be sent instantly.

If aPublishDate is null or before current time, the node will be published instantly.

The current user must be authorized to publish nodes or a ConstraintViolationException will be thrown.

Parameters:

aNode - the node that should be published. Valid nodes are sv:sitePage, sv:page, sv:article and sv:template.

aPublishDate - the publish date for the node.

aNotificationDate - best-before notification date.

Throws:

NullPointerException - if aNode is null.

IllegalArgumentException - if aNode is of invalid type.

ConstraintViolationException - if current user is not authorized to publish nodes.

RepositoryException - on unexpected failures.

Since:

Sitevision 2.6.2_05

See Also:

PermissionUtil.hasEffectivePublishPermission(Node, Node), Publisher

publishNodeWithNotification

void publishNodeWithNotification(Node aNode,
                                 Date aPublishDate,
                                 Date aUnpublishDate,
                                 Date aNotificationDate)
                          throws ConstraintViolationException,
                                 IllegalArgumentException,
                                 RepositoryException

Schedules a node publish job for execution at a specified date and a node unpublish job for execution at a later date and a best before notification date.

Valid nodes are sv:sitePage, sv:page, sv:article, sv:collaborationGroupPage, sv:template and sv:link (must be a "page link", a stand-alone link in the page tree). If another node is specified an IllegalArgumentException is thrown.

If aNotificationDate is null, no notification will be sent. If aNotificationDate is before aPublishDate no notification will be sent since node hasn't been published yet. If a aNotificationDate is before current date, a notification will be sent instantly.

If aPublishDate is null or before current time, the node will be published instantly.

If aUnpublishDate is before aPublishDate the unpublish job will run but won't affect the publishing, i.e. the node will be published at the given publish date.

The current user must be authorized to publish nodes or a ConstraintViolationException will be thrown.

Parameters:

aNode - the node that should be published. Valid nodes are sv:sitePage, sv:page, sv:article and sv:template.

aPublishDate - the publish date for the node.

aUnpublishDate - the unpublish date for the node.

aNotificationDate - best-before notification date.

Throws:

NullPointerException - if aNode or aUnpublishDate is null.

IllegalArgumentException - if aNode is of invalid type.

ConstraintViolationException - if current user is not authorized to publish nodes.

RepositoryException - on unexpected failures.

Since:

Sitevision 2.6.2_05

See Also:

PermissionUtil.hasEffectivePublishPermission(Node, Node), Publisher

getPublisherBuilder

PublisherBuilder getPublisherBuilder()

Gets a PublisherBuilder instance that offers more flexible publishing options than the publish methods in this interface.

Returns:

a PublisherBuilder instance

Since:

Sitevision 2026.08.1

unpublishNode

void unpublishNode(Node aNode)
            throws RepositoryException

Unpublishes a node.

Valid nodes are sv:sitePage, sv:page, sv:article, sv:collaborationGroupPage, sv:template and sv:link (must be a "page link", a stand-alone link in the page tree). If another node is specified an IllegalArgumentException is thrown.

If no node is specified a NullPointerException is thrown.

The current user must be authorized to publish nodes or a ConstraintViolationException will be thrown.

Parameters:

aNode - the node that should be unpublished

Throws:

ConstraintViolationException - if current user is not authorized to unpublish nodes

RepositoryException - if something else goes wrong

See Also:

PermissionUtil.hasEffectivePublishPermission(Node, Node)

unpublishNode

void unpublishNode(Node aNode,
                   Date aUnpublishDate)
            throws RepositoryException

Schedules a node unpublish job for execution at a specified date.

Valid nodes are sv:sitePage, sv:page, sv:article, sv:collaborationGroupPage, sv:template and sv:link (must be a "page link", a stand-alone link in the page tree). If another node is specified an IllegalArgumentException is thrown.

If no node is specified a NullPointerException is thrown.

The current user must be authorized to publish nodes or a ConstraintViolationException will be thrown.

Parameters:

aNode - the node that should be unpublished

aUnpublishDate - the unpublish date

Throws:

ConstraintViolationException - if current user is not authorized to unpublish nodes

RepositoryException - if something else goes wrong

See Also:

PermissionUtil.hasEffectivePublishPermission(Node, Node)

getPublishStatus

PublishStatus getPublishStatus(Node aNode)
                        throws RepositoryException

Gets the publish status of a node.

Valid nodes are sv:sitePage, sv:page, sv:article, sv:collaborationGroupPage, sv:template and sv:link (must be a "page link", a stand-alone link in the page tree). If another node is specified an IllegalArgumentException is thrown.

If no node is specified a NullPointerException is thrown.

Parameters:

aNode - the node whose publish status is to be checked

Returns:

the publish status for aNode

Throws:

NullPointerException - if aNode is null

IllegalArgumentException - if aNode is of invalid type

ConstraintViolationException - if current user is not authorized to publish nodes

RepositoryException - if something else goes wrong

Since:

Sitevision 2024.01.2

clearPublishingSchedule

void clearPublishingSchedule(Node aNode)
                      throws RepositoryException

Clears the publish and unpublish schedule for a node.

Valid nodes are sv:sitePage, sv:page, sv:article, sv:collaborationGroupPage, sv:template and sv:link (must be a "page link", a stand-alone link in the page tree). If another node is specified an IllegalArgumentException is thrown.

If no node is specified a NullPointerException is thrown.

The current user must be authorized to publish nodes and manage publishing locks or a ConstraintViolationException will be thrown.

Parameters:

aNode - that is scheduled for either publishing, unpublishing or both

Throws:

NullPointerException - if aNode is null

IllegalArgumentException - if aNode is of invalid type

ConstraintViolationException - if current user is not authorized to clear the schedule for aNode

RepositoryException - if something else goes wrong

Since:

Sitevision 2024.01.2