senselogic.sitevision.api.versioning

Interface Publisher

public interface Publisher

A publisher with configurable publishing behavior.

The Publisher is the powerful big brother of PublishingUtil when it comes to publishing. When the publish convenience methods in PublishingUtil doesn't fit your needs, you can always use the Publisher instead!

Example of how to use PublisherBuilder and Publisher to publish a page at a given time using server-side JavaScript:

   // 1. Import PublishingUtil in apps (WebApp, RESTApp, Widget, MCPServer etc)
   // NOTE! Use the require function instead in other server-side JavaScripts (e.g. Script module), i.e:
   // const publishingUtil = require("PublishingUtil");
   import publishingUtil from "@sitevision/api/server/PublishingUtil";

   // 2. Create a publisher builder instance
   const publisherBuilder = publishingUtil.getPublisherBuilder();

   const page = ... // Get the page node to publish
   const date = ... // Create a specific publish date, or null for imminent publishing

   // 3. Create a publisher
   const publisher = publisherBuilder
                        .setPublishDate(date)
                        .build();

   // 4. Publish
   try {
      publisher.publish(page);
      console.log("Page published successfully!");
   } catch (e) {
      console.log("Failed to publish page");
   }
 

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

Since:

Sitevision 2026.08.1

Author:

Magnus Lövgren

See Also:

PublishingUtil

Method Summary

Modifier and Type	Method and Description
void	publish(Node aPageNode) Publish a given page node, using the state that was specified when the Publisher was created.

Method Detail

publish

void publish(Node aPageNode)
      throws IllegalArgumentException,
             ConstraintViolationException,
             RepositoryException

Publish a given page node, using the state that was specified when the Publisher was created.

Valid node types to publish are:

• sv:page
• sv:article
• sv:collaborationGroupPage
• sv:sitePage
• sv:template
• sv:link (must be a "page link", a stand-alone link in the page tree)

If a node of another node type is specified an IllegalArgumentException is thrown.

Parameters:

aPageNode - the node that should be published.

Throws:

IllegalArgumentException - if aPageNode is null or of invalid type.

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

RepositoryException - for other problems occur, such as locking failed, immutable PublishStatus or such.

See Also:

PermissionUtil.hasEffectivePublishPermission(Node, Node), PublishingUtil.getPublishStatus(Node)