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

Version 1 Next »

Freeze allows you to stop all publication activity on a Magnolia instance temporarily. Authors can continue to work in the system during the freeze but they cannot version content or publish content. Freeze is useful when you want to swap author instances or you want to make sure that public instances stay in sync during an upscaling event.

The Freeze module provides commands for managing a global freeze flag. Using these commands it's possible to set and unset the freeze flag.

JIRAFREEZE
Gitfreeze

Installation

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

<dependency>
  <groupId>info.magnolia.freeze</groupId>
  <artifactId>magnolia-freeze</artifactId>
  <version>${freezeVersion}</version>
</dependency>

Versions

1.6.1Magnolia 5.6
1.6Magnolia 5.6
1.5Magnolia 5.6

Usage

The module provides a set of commands useful for controlling and reading the freeze flag. These command can be used in a variety of ways to create a freeze event. A freeze is cumulative. Meaning, successive calls to freeze start must be followed by the same number of calls to stop before the freeze is lifted.

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