Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
Column
width70%

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

Code Block
languagexml
<dependency>
  <groupId>info.magnolia.services</groupId>
  <artifactId>versioncleaner</artifactId>
  <version>${freezeVersionversioncleanerVersion}</version>
</dependency>
Column
width30%

Versions

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

...

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

Commands

All the Which versions are selected for deletion are configurable through voters. You can define complex conditions to identify if a version should be deleted.

Cleanup Commands

The commands can be found in the freeze version cleaner catalog: /module/freezeversioncleaner/commands/freezecleanup

...

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.

...

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.

...

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.

Info

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

...

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.

Image Removed

cleanVersions

Remove unneeded versions according to its configuration.

cleanAllVersions

Remove all versions found except root and leaf versions.

Unlike cleanVersions, cleanAllVersions does not require possibly complicated configuration.

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 
      Jira
      serverMagnolia - Issue tracker
      serverId500b06a6-e204-3125-b989-2d75b973d05f
      keyFREEZE-4
  • 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.