sirius.web.security

Interface MaintenanceInfo

public interface MaintenanceInfo

A ScopeInfo can additionally implement this interface to signal the current maintenance status of a scope.

To keep the ScopeInfo class small and conceise, this interface is obtained via the Adapters framework by calling ScopeInfo.tryAs(Class). Therefore either a subclass implementing this interface has to be used or an appropriate Transformer has to be created.

Method Summary

Modifier and Type	Method and Description
boolean	isLocked() Determines if this scope is currently locked / closed for maintenance or disaster reasons.
Message	maintenanceMessage() Returns a message to be shown to all users indicating the current maintenance state of the current scope.

Method Detail

isLocked

boolean isLocked()

Determines if this scope is currently locked / closed for maintenance or disaster reasons.

Returns:

true if the scope is locked, false otherwise

maintenanceMessage

@Nullable
Message maintenanceMessage()

Returns a message to be shown to all users indicating the current maintenance state of the current scope.

Returns:

a message describing the current maintenance state of the scope