Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

The version cleaner module provides commands to remove old or duplicated versions from your version store. Which versions are selected for removal can be configured through voters.

Analyzing and removing unneeded versions can take a lot of time, the version cleanup command can be configured to examine a set number of versions (actually nodes in the version workspace) and then stop. The next run of the version cleanup command will resume from the node last analyzed.

The version cleaner can be configured to select which versions are deleted or retained. 

Installation

Maven is the easiest way to install the module. Add the following dependency to your bundle:

<dependency>
  <groupId>info.magnolia.services</groupId>
  <artifactId>versioncleaner</artifactId>
  <version>${freezeVersion}</version>
</dependency>

Versions

1.4Magnolia 5.5+
1.3Magnolia 5.5+
1.2Magnolia 5.5+

Usage

The module provides a set of commands for removing selected versions from the version history.

Commands

All the commands can be found in the freeze catalog: /module/freeze/commands/freeze

startGlobalFreeze

Start a global freeze, or continue a global freeze.

If called multiple times without a corresponding calls to stopGlobalFreeze or toggleGlobalFreeze, the freeze will stay in place until the same number of calls to stopGlobalFreeze are executed or a single call to toggleGlobalFreeze is made.

stopGlobalFreeze

Attempts to stop a global freeze.

The outcome of the attempt is dependent on sequence factors. The index in which the stop is called makes a difference in the default use case. However, using the force parameter in the command context can be used to end a freeze immediately. Set the boolean parameter to true to force the stop to be final.

toggleGlobalFreeze

Toggles the state of the flag.

Will start a global freeze if a freeze is not active or end a global freeze is one is currently active.

Using toggleGlobalFreeze will always start or stop a freeze, even if a freeze has been invoked by multiple sources.

checkGlobalFreeze

Check the state of the freeze flag.

Will return false if a global freeze is active and true if not. You can use this command in command chains to check if a global freeze is in place.

Command Endpoints

Using Magnolia's REST API it's possible to start. stop, or toggle a freeze. The command endpoint makes this possible. After installation of the freeze module you should see the commands enabled under rest-services.

Warnings

  • This module is at INCUBATOR level.
  • Versions prior to 1.3
    • Used a different groupid and artifactId. Please make note of the change.

Changelog

  • Version 1.6.1
    • Fixed  FREEZE-4 - Getting issue details... STATUS
  • Version 1.6
    • added notifications when freeze is started and ended
  • Version 1.5
    • Fixed widgetset warnings
  • Version 1.4
    • Freeze state now exposed through MgnlContext.
    • Commands changed to update freeze state parameter.
    • Rest endpoints update for freeze state parameter.
  • Version 1.3 - Initial release of the extensions version of the module.
  • No labels