Package org.ametys.runtime.plugins.admin.system

Class SystemHelper

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.runtime.plugins.admin.system.SystemHelper

All Implemented Interfaces:

Initializable, Component, Contextualizable, LogEnabled, Serviceable

public class SystemHelper
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable, Initializable

Helper for manipulating system announcement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemHelper.SystemAnnouncement	Class representing the system announcement file

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADMINISTRATOR_SYSTEM_FILENAME	The relative path to the file where system information are saved (announcement, maintenance...)
static final String	ROLE	Avalon role

Constructor Summary

Constructors

Constructor	Description
SystemHelper()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
Map	deleteAnnouncement(String language)	Delete a announcement
Map<String,Object>	editAnnouncement(String language, String message, boolean override)	Add or edit a system announcement
long	getSystemAnnoucementLastModificationDate()	Return the date of the last modification of the annonce
String	getSystemAnnouncement(String languageCode)	Returns the system announcement for the given language code, or for the default language code if there is no specified announcement for the given language code. Returns null if the system announcements are not activated.
Map<String,Object>	getSystemAnnouncementAvailability()	Get the system announcement availability
void	initialize()
boolean	isSystemAnnouncementAvailable()	Tests if system announcements are active.
SystemHelper.SystemAnnouncement	readValues()	Read the system announcement's values
void	scheduleAnnouncement(String startDateStr, String endDateStr)	Schedule a system announcement
void	service(ServiceManager serviceManager)
void	setAnnouncementAvailable(boolean available)	Enables or disable system announcement

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

ADMINISTRATOR_SYSTEM_FILENAME

public static final String ADMINISTRATOR_SYSTEM_FILENAME

The relative path to the file where system information are saved (announcement, maintenance...)

See Also:

• Constant Field Values

ROLE

public static final String ROLE

Avalon role

Constructor Details

SystemHelper

public SystemHelper()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

setAnnouncementAvailable

public void setAnnouncementAvailable(boolean available)
                              throws ProcessingException

Enables or disable system announcement

Parameters:

available - true to enable system announcement

Throws:

ProcessingException - if an error occurred

scheduleAnnouncement

public void scheduleAnnouncement(String startDateStr,
 String endDateStr)
                          throws ProcessingException

Schedule a system announcement

Parameters:

startDateStr - the planned start date. Can be null for no start date

endDateStr - the planned end date. Can be null for no end date

Throws:

ProcessingException - if an error occurred

editAnnouncement

public Map<String,Object> editAnnouncement(String language,
 String message,
 boolean override)
                                    throws Exception

Add or edit a system announcement

Parameters:

language - the language typed in by the user or "*" if modifying the default message

message - the message to add nor edit

override - true to override the existing value if exists

Returns:

the result map

Throws:

Exception - if an exception occurs

deleteAnnouncement

public Map deleteAnnouncement(String language)
                       throws ProcessingException

Delete a announcement

Parameters:

language - the language of the announcement to delete

Returns:

an empty map

Throws:

ProcessingException - if an exception occurs

isSystemAnnouncementAvailable

public boolean isSystemAnnouncementAvailable()

Tests if system announcements are active.

Returns:

true if system announcements are active.

getSystemAnnouncementAvailability

public Map<String,Object> getSystemAnnouncementAvailability()

Get the system announcement availability

Returns:

a map with the state, start date and end date

getSystemAnnoucementLastModificationDate

public long getSystemAnnoucementLastModificationDate()

Return the date of the last modification of the annonce

Returns:

The date of the last modification or 0 if there is no announce file

getSystemAnnouncement

public String getSystemAnnouncement(String languageCode)

Returns the system announcement for the given language code, or for the default language code if there is no specified announcement for the given language code.
Returns null if the system announcements are not activated.

Parameters:

languageCode - the desired language code of the system announcement

Returns:

the system announcement in the specified language code, or in the default language code, or null if announcements are not active.

readValues

public SystemHelper.SystemAnnouncement readValues()

Read the system announcement's values

Returns:

The system announcement values;