Package org.camunda.bpm.webapp.impl.engine

Class ProcessEnginesFilter

java.lang.Object

org.camunda.bpm.webapp.impl.filter.AbstractTemplateFilter

org.camunda.bpm.webapp.impl.engine.ProcessEnginesFilter

All Implemented Interfaces:

jakarta.servlet.Filter

Direct Known Subclasses:

ResourceLoadingProcessEnginesFilter

public class ProcessEnginesFilter
extends AbstractTemplateFilter

Author:

nico.rehwaldt, Daniel Meyer, Roman Smirnov, Sebastian Stamm

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ADMIN_APP_NAME
protected final AdminRuntimeDelegate	adminRuntimeDelegate
static Pattern	APP_PREFIX_PATTERN
static final String	APP_ROOT_PLACEHOLDER
static final String	BASE_PLACEHOLDER
protected static final String	COCKPIT_APP_NAME
protected final CockpitRuntimeDelegate	cockpitRuntimeDelegate
static final String	CSP_NONCE_PLACEHOLDER
protected static final String	DEFAULT_APP
protected static final String	INDEX_PAGE
static final String	PLUGIN_DEPENDENCIES_PLACEHOLDER
static final String	PLUGIN_PACKAGES_PLACEHOLDER
protected final String	pluginDependencyFormat
protected final String	pluginPackageFormat
protected static final String	SETUP_PAGE
protected static final String	TASKLIST_APP_NAME
protected final TasklistRuntimeDelegate	tasklistRuntimeDelegate
protected static final String	WELCOME_APP_NAME
protected final WelcomeRuntimeDelegate	welcomeRuntimeDelegate

Constructor Summary

Constructors

Constructor	Description
ProcessEnginesFilter()

Method Summary

Modifier and Type	Method	Description
protected void	applyFilter(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)	Apply the filter to the given request/response.
protected <T extends AppPlugin> CharSequence	createPluginDependenciesStr(String appName)
protected <T extends AppPlugin> CharSequence	createPluginPackagesStr(String appName, String applicationPath, String contextPath)
protected String	getDefaultEngineName()
protected <T extends AppPlugin> List<T>	getPlugins(String appName)
protected boolean	needsInitialUser(String engineName)
protected String	replacePlaceholder(String data, String appName, String engineName, String applicationPath, String contextPath, String cspNonce)
protected void	serveIndexPage(String appName, String engineName, String applicationPath, String contextPath, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.ServletContext servletContext)
protected void	serveIndexPage(String appName, String engineName, String pageUri, String applicationPath, String contextPath, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected void	serveTemplate(String requestUri, String appName, String pageUri, String applicationPath, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
protected void	setWebappInTelemetry(String engineName, String appName, jakarta.servlet.ServletContext servletContext)

Methods inherited from class org.camunda.bpm.webapp.impl.filter.AbstractTemplateFilter

destroy, doFilter, getWebResourceContents, hasWebResource, init

Methods inherited from class java.lang.Object

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

Field Details

COCKPIT_APP_NAME

protected static final String COCKPIT_APP_NAME

See Also:

• Constant Field Values

ADMIN_APP_NAME

protected static final String ADMIN_APP_NAME

See Also:

• Constant Field Values

TASKLIST_APP_NAME

protected static final String TASKLIST_APP_NAME

See Also:

• Constant Field Values

WELCOME_APP_NAME

protected static final String WELCOME_APP_NAME

See Also:

• Constant Field Values

DEFAULT_APP

protected static final String DEFAULT_APP

See Also:

• Constant Field Values

INDEX_PAGE

protected static final String INDEX_PAGE

See Also:

• Constant Field Values

SETUP_PAGE

protected static final String SETUP_PAGE

See Also:

• Constant Field Values

APP_ROOT_PLACEHOLDER

public static final String APP_ROOT_PLACEHOLDER

See Also:

• Constant Field Values

BASE_PLACEHOLDER

public static final String BASE_PLACEHOLDER

See Also:

• Constant Field Values

PLUGIN_DEPENDENCIES_PLACEHOLDER

public static final String PLUGIN_DEPENDENCIES_PLACEHOLDER

See Also:

• Constant Field Values

PLUGIN_PACKAGES_PLACEHOLDER

public static final String PLUGIN_PACKAGES_PLACEHOLDER

See Also:

• Constant Field Values

CSP_NONCE_PLACEHOLDER

public static final String CSP_NONCE_PLACEHOLDER

See Also:

• Constant Field Values

APP_PREFIX_PATTERN

public static Pattern APP_PREFIX_PATTERN

cockpitRuntimeDelegate

protected final CockpitRuntimeDelegate cockpitRuntimeDelegate

adminRuntimeDelegate

protected final AdminRuntimeDelegate adminRuntimeDelegate

tasklistRuntimeDelegate

protected final TasklistRuntimeDelegate tasklistRuntimeDelegate

welcomeRuntimeDelegate

protected final WelcomeRuntimeDelegate welcomeRuntimeDelegate

pluginPackageFormat

protected final String pluginPackageFormat

pluginDependencyFormat

protected final String pluginDependencyFormat

Constructor Details

ProcessEnginesFilter

public ProcessEnginesFilter()

Method Details

applyFilter

protected void applyFilter(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)
                    throws IOException,
jakarta.servlet.ServletException

Description copied from class: AbstractTemplateFilter

Apply the filter to the given request/response. This method must be provided by subclasses to perform actual work.

Specified by:

applyFilter in class AbstractTemplateFilter

Throws:

IOException

jakarta.servlet.ServletException

serveIndexPage

protected void serveIndexPage(String appName,
 String engineName,
 String pageUri,
 String applicationPath,
 String contextPath,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                       throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

getDefaultEngineName

protected String getDefaultEngineName()

serveTemplate

protected void serveTemplate(String requestUri,
 String appName,
 String pageUri,
 String applicationPath,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)
                      throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

needsInitialUser

protected boolean needsInitialUser(String engineName)
                            throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

serveIndexPage

protected void serveIndexPage(String appName,
 String engineName,
 String applicationPath,
 String contextPath,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.ServletContext servletContext)
                       throws IOException

Throws:

IOException

setWebappInTelemetry

protected void setWebappInTelemetry(String engineName,
 String appName,
 jakarta.servlet.ServletContext servletContext)

replacePlaceholder

protected String replacePlaceholder(String data,
 String appName,
 String engineName,
 String applicationPath,
 String contextPath,
 String cspNonce)

createPluginPackagesStr

protected <T extends AppPlugin> CharSequence createPluginPackagesStr(String appName,
 String applicationPath,
 String contextPath)

createPluginDependenciesStr

protected <T extends AppPlugin> CharSequence createPluginDependenciesStr(String appName)

getPlugins

protected <T extends AppPlugin> List<T> getPlugins(String appName)