org.jahia.settings.readonlymode

Class ReadOnlyModeController

java.lang.Object

org.jahia.settings.readonlymode.ReadOnlyModeController

All Implemented Interfaces:

Serializable

public final class ReadOnlyModeController
extends Object
implements Serializable

The read-only mode controller service that is responsible for performing mode switch and ensuring an appropriate event is broadcasted and the related services are "notified".

Author:

Sergiy Shyrkov

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadOnlyModeController.ReadOnlyModeStatus Read only mode status.

Constructor Summary

Constructors

Constructor and Description
ReadOnlyModeController()

Method Summary

Modifier and Type	Method and Description
void	addStatusSupplier(ReadOnlyModeStatusSupplier supplier) Registers a ReadOnlyModeStatusSupplier with this instance.
void	addSwitchListener(ReadOnlyModeSwitchListener listener) Registers a ReadOnlyModeSwitchListener with this instance.
static ReadOnlyModeController	getInstance()
ReadOnlyModeController.ReadOnlyModeStatus	getReadOnlyStatus()
List<ReadOnlyModeStatusInfo>	getReadOnlyStatuses() Returns a list of read-only statuses from multiple origins
static void	readOnlyModeViolated(String message) Handles the case, when a service encounters read-only mode violation, i.e.
void	removeStatusSupplier(ReadOnlyModeStatusSupplier supplier) Unregisters a ReadOnlyModeStatusSupplier from this instance.
void	removeSwitchListener(ReadOnlyModeSwitchListener listener) Unregisters a ReadOnlyModeSwitchListener from this instance.
void	switchReadOnlyMode(boolean enable) Performs the switch of all DX services into read-only mode or back.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadOnlyModeController

public ReadOnlyModeController()

Method Detail

readOnlyModeViolated

public static void readOnlyModeViolated(String message)
                                 throws ReadOnlyModeException

Handles the case, when a service encounters read-only mode violation, i.e. a data or state modification is requested.

Parameters:

message - the detailed error message from the service

Throws:

ReadOnlyModeException - as a result of violation of read-only mode

getInstance

public static ReadOnlyModeController getInstance()

switchReadOnlyMode

public void switchReadOnlyMode(boolean enable)

Performs the switch of all DX services into read-only mode or back.

Parameters:

enable - true if the read-only mode should be enabled; false if it should be disabled

Throws:

IllegalStateException - if switching to the specified mode is not permitted

getReadOnlyStatus

public ReadOnlyModeController.ReadOnlyModeStatus getReadOnlyStatus()

getReadOnlyStatuses

public List<ReadOnlyModeStatusInfo> getReadOnlyStatuses()

Returns a list of read-only statuses from multiple origins

The returned list will always contain at least one element which is the read-only status of the current instance. Additional statuses can be provided by ReadOnlyModeStatusSupplier.

Returns:

a list of ReadOnlyModeStatusInfo

Since:

7.3.2.1

See Also:

addStatusSupplier(ReadOnlyModeStatusSupplier), removeStatusSupplier(ReadOnlyModeStatusSupplier)

addSwitchListener

public void addSwitchListener(ReadOnlyModeSwitchListener listener)

Registers a ReadOnlyModeSwitchListener with this instance.

ReadOnlyModeSwitchListener.onReadOnlyModeSwitched(boolean) will be fire once read only mode switch has completed.

Parameters:

listener - the listener to register

Since:

7.3.2.1

removeSwitchListener

public void removeSwitchListener(ReadOnlyModeSwitchListener listener)

Unregisters a ReadOnlyModeSwitchListener from this instance.

Parameters:

listener - the listener to unregister

Since:

7.3.2.1

addStatusSupplier

public void addStatusSupplier(ReadOnlyModeStatusSupplier supplier)

Registers a ReadOnlyModeStatusSupplier with this instance.

Parameters:

supplier - the supplier to register

Since:

7.3.2.1

removeStatusSupplier

public void removeStatusSupplier(ReadOnlyModeStatusSupplier supplier)

Unregisters a ReadOnlyModeStatusSupplier from this instance.

Parameters:

supplier - the supplier to unregister

Since:

7.3.2.1