Package org.ametys.runtime.servlet

Class RuntimeServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.ametys.runtime.servlet.RuntimeServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public class RuntimeServlet
extends HttpServlet

Main entry point for applications.
Overrides the CocoonServlet to add some initialization.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RuntimeServlet.ForcedMainteanceInformations	Informations about the maintenance status when forced
static enum	RuntimeServlet.MaintenanceStatus	The maintenance status of Ametys
static enum	RuntimeServlet.RunMode	The run modes

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AMETYS_HOME_DEFAULT	The default ametys home path (relative to the servlet context)
static final String	AMETYS_HOME_PROPERTY	Name of the servlet initialization parameter for the ametys home property
static final String	COCOON_CONF_URL	The cocoon.xconf URL
static final String	CONFIG_FILE_NAME	The config file name
static final String	CONTEXT_CONTEXT_ROOT	Constant for storing the servlet context URL in the Avalon context
static final String	CONTEXT_SERVLET_CONFIG	Constant for storing the ServletConfig in the Avalon context
static final int	DEFAULT_MAX_UPLOAD_SIZE	Default max upload size (10 Mb)
static final String	EXTERNAL_LOCATIONS	The optional location (relative to application context) of the file that configures the list of plugins/workspaces/kernel to get somewhere else
static final String	INSTANCE_FILENAME	File name in the administrator folder of the ametys home
static final String	MAINTENANCE_FILENAME	The maintenance file name

Constructor Summary

Constructors

Constructor	Description
RuntimeServlet()

Method Summary

Modifier and Type	Method	Description
void	destroy()
static boolean	doMigrationAndInit(PluginsComponentManager pluginCM)	Init migration and plugins
static String	getInstanceId()	Get the instance identifier
static RuntimeServlet.MaintenanceStatus	getMaintenanceStatus()	Get the current maintenance status
static RuntimeServlet.ForcedMainteanceInformations	getMaintenanceStatusForcedInformations()	When maintenance status is forced, this comment may explains why
static RuntimeServlet.RunMode	getRunMode()	Get the run mode
void	init()
void	restartCocoon(HttpServletRequest req)	Restart cocoon
final void	service(HttpServletRequest req, HttpServletResponse res)
static void	setMaintenanceStatus(RuntimeServlet.MaintenanceStatus maintenanceStatus, RuntimeServlet.ForcedMainteanceInformations forcedMainteanceInformations)	Set the maintenance status
static void	setRunMode(RuntimeServlet.RunMode mode)	Set the run mode

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Details

CONTEXT_SERVLET_CONFIG

public static final String CONTEXT_SERVLET_CONFIG

Constant for storing the ServletConfig in the Avalon context

See Also:

• Constant Field Values

CONTEXT_CONTEXT_ROOT

public static final String CONTEXT_CONTEXT_ROOT

Constant for storing the servlet context URL in the Avalon context

See Also:

• Constant Field Values

COCOON_CONF_URL

public static final String COCOON_CONF_URL

The cocoon.xconf URL

See Also:

• Constant Field Values

DEFAULT_MAX_UPLOAD_SIZE

public static final int DEFAULT_MAX_UPLOAD_SIZE

Default max upload size (10 Mb)

See Also:

• Constant Field Values

MAINTENANCE_FILENAME

public static final String MAINTENANCE_FILENAME

The maintenance file name

See Also:

• Constant Field Values

CONFIG_FILE_NAME

public static final String CONFIG_FILE_NAME

The config file name

See Also:

• Constant Field Values

AMETYS_HOME_PROPERTY

public static final String AMETYS_HOME_PROPERTY

Name of the servlet initialization parameter for the ametys home property

See Also:

• Constant Field Values

AMETYS_HOME_DEFAULT

public static final String AMETYS_HOME_DEFAULT

The default ametys home path (relative to the servlet context)

See Also:

• Constant Field Values

EXTERNAL_LOCATIONS

public static final String EXTERNAL_LOCATIONS

The optional location (relative to application context) of the file that configures the list of plugins/workspaces/kernel to get somewhere else

See Also:

• Constant Field Values

INSTANCE_FILENAME

public static final String INSTANCE_FILENAME

File name in the administrator folder of the ametys home

See Also:

• Constant Field Values

Constructor Details

RuntimeServlet

public RuntimeServlet()

Method Details

init

public void init()
          throws ServletException

Overrides:

init in class GenericServlet

Throws:

ServletException

getInstanceId

public static String getInstanceId()

Get the instance identifier

Returns:

The UUID of the Ametys instance or null if the id could not be generated at startup

Throws:

IllegalStateException - If the file cannot be read

doMigrationAndInit

public static boolean doMigrationAndInit(PluginsComponentManager pluginCM)
                                  throws Exception

Init migration and plugins

Parameters:

pluginCM - Plugins Component Manager

Returns:

true if a server restart is required

Throws:

Exception - Something went wrong

destroy

public void destroy()

Specified by:

destroy in interface Servlet

Overrides:

destroy in class GenericServlet

service

public final void service(HttpServletRequest req,
 HttpServletResponse res)
                   throws ServletException,
IOException

Overrides:

service in class HttpServlet

Throws:

ServletException

IOException

restartCocoon

public void restartCocoon(HttpServletRequest req)

Restart cocoon

Parameters:

req - The http servlet request, used to read safeMode and normalMode request attribute if possible. If null, safe mode will be forced only if it was already forced.

setMaintenanceStatus

public static void setMaintenanceStatus(RuntimeServlet.MaintenanceStatus maintenanceStatus,
 RuntimeServlet.ForcedMainteanceInformations forcedMainteanceInformations)

Set the maintenance status

Parameters:

maintenanceStatus - The new maintenance status. Cannot be null.

forcedMainteanceInformations - The informations if the mode is FORCED. Can be null.

getMaintenanceStatus

public static RuntimeServlet.MaintenanceStatus getMaintenanceStatus()

Get the current maintenance status

Returns:

The maintenance status

getMaintenanceStatusForcedInformations

public static RuntimeServlet.ForcedMainteanceInformations getMaintenanceStatusForcedInformations()

When maintenance status is forced, this comment may explains why

Returns:

The comment. Can be null even in forced mode.

setRunMode

public static void setRunMode(RuntimeServlet.RunMode mode)

Set the run mode

Parameters:

mode - the running mode

getRunMode

public static RuntimeServlet.RunMode getRunMode()

Get the run mode

Returns:

the current run mode