Package org.camunda.bpm.webapp.impl.util

Class ServletContextUtil

java.lang.Object

org.camunda.bpm.webapp.impl.util.ServletContextUtil

public class ServletContextUtil
extends Object

With Camunda Platform 7.13 we introduced the application path prefix /camunda to Spring Boot. The application path is set in Spring Boot's servlet context and is consumed by filters and servlets of the Camunda Platform Webapp. This util class holds the methods to get and set the application path.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	APP_PATH_ATTR_NAME
protected static final String	AUTH_CACHE_TTL_ATTR_NAME
protected static final String	SUCCESSFUL_ET_ATTR_NAME

Constructor Summary

Constructors

Constructor	Description
ServletContextUtil()

Method Summary

Modifier and Type	Method	Description
protected static String	buildTelemetrySentAttribute(String webappName, String engineName)
static String	getAppPath(jakarta.servlet.ServletContext servletContext)	Consumed by Camunda Platform CE & EE Webapp: Retrieves the application path from Spring Boot's servlet context.
static Date	getAuthCacheValidationTime(jakarta.servlet.ServletContext servletContext)	Returns authCacheValidationTime from servlet context to be used on initial login authentication.
static boolean	isTelemetryDataSentAlready(String webappName, String engineName, jakarta.servlet.ServletContext servletContext)
static void	setAppPath(String applicationPath, jakarta.servlet.ServletContext servletContext)	Sets an application path into Spring Boot's servlet context.
static void	setCacheTTLForLogin(long cacheTimeToLive, jakarta.servlet.ServletContext servletContext)	Sets in the AuthenticationFilter to be used on initial login authentication.
static void	setTelemetryDataSent(String webappName, String engineName, jakarta.servlet.ServletContext servletContext)	Marks the web application as successfully sent to the engine as telemetry info

Methods inherited from class java.lang.Object

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

Field Details

APP_PATH_ATTR_NAME

protected static final String APP_PATH_ATTR_NAME

See Also:

• Constant Field Values

SUCCESSFUL_ET_ATTR_NAME

protected static final String SUCCESSFUL_ET_ATTR_NAME

See Also:

• Constant Field Values

AUTH_CACHE_TTL_ATTR_NAME

protected static final String AUTH_CACHE_TTL_ATTR_NAME

See Also:

• Constant Field Values

Constructor Details

ServletContextUtil

public ServletContextUtil()

Method Details

getAppPath

public static String getAppPath(jakarta.servlet.ServletContext servletContext)

Consumed by Camunda Platform CE & EE Webapp: Retrieves the application path from Spring Boot's servlet context.

Parameters:

servletContext - that holds the application path

Returns:

a non-empty String containing the application path or an empty String when no application path was set.

setAppPath

public static void setAppPath(String applicationPath,
 jakarta.servlet.ServletContext servletContext)

Sets an application path into Spring Boot's servlet context.

Parameters:

applicationPath - to be set into Spring Boot's servlet context

servletContext - of Spring Boot the application path should be set into

isTelemetryDataSentAlready

public static boolean isTelemetryDataSentAlready(String webappName,
 String engineName,
 jakarta.servlet.ServletContext servletContext)

Returns:

whether the web application has already successfully been sent to the engine as telemetry info or not.

setTelemetryDataSent

public static void setTelemetryDataSent(String webappName,
 String engineName,
 jakarta.servlet.ServletContext servletContext)

Marks the web application as successfully sent to the engine as telemetry info

buildTelemetrySentAttribute

protected static String buildTelemetrySentAttribute(String webappName,
 String engineName)

setCacheTTLForLogin

public static void setCacheTTLForLogin(long cacheTimeToLive,
 jakarta.servlet.ServletContext servletContext)

Sets in the AuthenticationFilter to be used on initial login authentication. See AuthenticationFilter.doFilter(ServletRequest, ServletResponse, FilterChain)

getAuthCacheValidationTime

public static Date getAuthCacheValidationTime(jakarta.servlet.ServletContext servletContext)

Returns authCacheValidationTime from servlet context to be used on initial login authentication. See UserAuthenticationResource.doLogin(String, String, String, String)