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:

javax.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 java.lang.String	ADMIN_APP_NAME
protected AdminRuntimeDelegate	adminRuntimeDelegate
static java.util.regex.Pattern	APP_PREFIX_PATTERN
static java.lang.String	APP_ROOT_PLACEHOLDER
static java.lang.String	BASE_PLACEHOLDER
protected static java.lang.String	COCKPIT_APP_NAME
protected CockpitRuntimeDelegate	cockpitRuntimeDelegate
protected static java.lang.String	DEFAULT_APP
protected static java.lang.String	INDEX_PAGE
static java.lang.String	PLUGIN_DEPENDENCIES_PLACEHOLDER
static java.lang.String	PLUGIN_PACKAGES_PLACEHOLDER
protected java.lang.String	pluginDependencyFormat
protected java.lang.String	pluginPackageFormat
protected static java.lang.String	SETUP_PAGE
protected static java.lang.String	TASKLIST_APP_NAME
protected TasklistRuntimeDelegate	tasklistRuntimeDelegate
protected static java.lang.String	WELCOME_APP_NAME
protected WelcomeRuntimeDelegate	welcomeRuntimeDelegate

Constructor Summary

Constructors

Constructor	Description
ProcessEnginesFilter()

Method Summary

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

COCKPIT_APP_NAME

protected static final java.lang.String COCKPIT_APP_NAME

See Also:

Constant Field Values

ADMIN_APP_NAME

protected static final java.lang.String ADMIN_APP_NAME

See Also:

Constant Field Values

TASKLIST_APP_NAME

protected static final java.lang.String TASKLIST_APP_NAME

See Also:

Constant Field Values

WELCOME_APP_NAME

protected static final java.lang.String WELCOME_APP_NAME

See Also:

Constant Field Values

DEFAULT_APP

protected static final java.lang.String DEFAULT_APP

See Also:

Constant Field Values

INDEX_PAGE

protected static final java.lang.String INDEX_PAGE

See Also:

Constant Field Values

SETUP_PAGE

protected static final java.lang.String SETUP_PAGE

See Also:

Constant Field Values

APP_ROOT_PLACEHOLDER

public static final java.lang.String APP_ROOT_PLACEHOLDER

See Also:

Constant Field Values

BASE_PLACEHOLDER

public static final java.lang.String BASE_PLACEHOLDER

See Also:

Constant Field Values

PLUGIN_DEPENDENCIES_PLACEHOLDER

public static final java.lang.String PLUGIN_DEPENDENCIES_PLACEHOLDER

See Also:

Constant Field Values

PLUGIN_PACKAGES_PLACEHOLDER

public static final java.lang.String PLUGIN_PACKAGES_PLACEHOLDER

See Also:

Constant Field Values

APP_PREFIX_PATTERN

public static java.util.regex.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 java.lang.String pluginPackageFormat

pluginDependencyFormat

protected final java.lang.String pluginDependencyFormat

Constructor Detail

ProcessEnginesFilter

public ProcessEnginesFilter()

Method Detail

applyFilter

protected void applyFilter(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           javax.servlet.FilterChain chain)
                    throws java.io.IOException,
                           javax.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:

java.io.IOException

javax.servlet.ServletException

serveIndexPage

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

Throws:

java.io.IOException

javax.servlet.ServletException

getDefaultEngineName

protected java.lang.String getDefaultEngineName()

serveTemplate

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

Throws:

java.io.IOException

javax.servlet.ServletException

needsInitialUser

protected boolean needsInitialUser(java.lang.String engineName)
                            throws java.io.IOException,
                                   javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

serveIndexPage

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

Throws:

java.io.IOException

setWebappInTelemetry

protected void setWebappInTelemetry(java.lang.String engineName,
                                    java.lang.String appName,
                                    javax.servlet.ServletContext servletContext)

replacePlaceholder

protected java.lang.String replacePlaceholder(java.lang.String data,
                                              java.lang.String appName,
                                              java.lang.String engineName,
                                              java.lang.String applicationPath,
                                              java.lang.String contextPath)

createPluginPackagesStr

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

createPluginDependenciesStr

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

getPlugins

protected <T extends AppPlugin> java.util.List<T> getPlugins(java.lang.String appName)