Web Application Deployment Descriptor

The web.xml file is the standard Web application deployment descriptor file of your project. You find it in your WebContent/WEB-INF folder of your Web project. It contains entries, like initialization parameters, servlets and other components.

Default Parameters
Additional Customizing Parameters
Security Issue with WebDav Servlets

Default Parameters

The following sections provide lists of the default entries required for running the Stardust Portal.

context parameter
filter
filter-mapping
servlet
servlet-mappings
welcome-file-list
resource-ref

Note that some parameters differ for usage in an external environment. These parameters are provided with a comment in the table entries.

context-parameter

The following context parameters are available:

Name	Default Value
ag.carnot.processportal.integration.LIVE_DIAGRAMS_URL	/eclipse/servlet/DiagramServlet
BIRT_VIEWER_LOCALE	en_US
BIRT_VIEWER_WORKING_FOLDER
BIRT_VIEWER_DOCUMENT_FOLDER
WORKING_FOLDER_ACCESS_ONLY	false
BIRT_VIEWER_IMAGE_DIR
BIRT_VIEWER_LOG_DIR
BIRT_VIEWER_LOG_LEVEL	INFO
BIRT_VIEWER_SCRIPTLIB_DIR
BIRT_RESOURCE_PATH
BIRT_VIEWER_MAX_ROWS
BIRT_VIEWER_MAX_CUBE_LEVELS
BIRT_VIEWER_CUBE_MEMORY_SIZE
BIRT_OVERWRITE_DOCUMENT	true
BIRT_VIEWER_CONFIG_FILE	WEB-INF/viewer.properties
BIRT_VIEWER_PRINT_SERVERSIDE	ON
HTML_ENABLE_AGENTSTYLE_ENGINE	true
URL_REPORT_PATH_POLICY	all
javax.faces.STATE_SAVING_METHOD	server
facelets.DEVELOPMENT	true
facelets.SKIP_COMMENTS	true
facelets.VIEW_MAPPINGS	.xhtml;.jspx
javax.faces.CONFIG_FILES	/WEB-INF/config/ipp/jsf/faces-config.xml,/WEB-INF/config/ipp/jsf/processportal-beans.xml
carnot.login.APPLICATION_ID	processPortal
carnot.login.ADMINISTRATOR_ROLE_REQUIRED	false
carnot.login.MODEL_REQUIRED	true
carnot.login.HEADING	portal-common-messages#portalFramework.title
com.infinity.bpm.portal.common.logoutURI	/ipp/common/ippPortalLogout.jsp
carnot.SESSION_LISTENERS	ippRADProcessPortalSessionInitializer,businessControlCenterInitializer, ippAdmPortalSessionListenerBean
ag.carnot.processportal.integration.BUSINESSCONTROLCENTER_URL	../../../plugins/common/portalFramework.iface
com.icesoft.faces.uploadMaxFileSize	10485760
facelets.RESOURCE_RESOLVER	org.eclipse.stardust.ui.web.viewscommon.common.PortalPluginFaceletsResourceResolver
javax.faces.DEFAULT_SUFFIX	.xhtml
com.icesoft.faces.delegateNonIface	true
com.icesoft.faces.synchronousUpdate	false
com.icesoft.faces.concurrentDOMViews	true
com.icesoft.faces.ignoreUserRoleAttributes	true
org.apache.myfaces.trinidad.DISABLE_DIALOG_OUTCOMES	true
contextConfigLocation	WEB-INF/config/ipp/spring/-context.xml,WEB-INF/jax-ws-cxf-context.xml,classpath:META-INF/spring/*-context.xml

filter

The filters used for the portal are:

Name	Class
BirtSessionFilter	org.eclipse.stardust.ui.web.bcc.reporting.BirtSessionFilter
portalPluginContentFilter	org.eclipse.stardust.ui.web.plugin.support.PortalPluginContentFilter
IppPortalLoginFilter	org.eclipse.stardust.ui.web.viewscommon.login.filter.LoginFilter
IppPortalCharsetFilter	org.eclipse.stardust.ui.web.viewscommon.common.CharsetFilter

filter-mapping

The following filter-mapping entries are required:

Name	Servlet Name / URL Pattern
BirtSessionFilter	/frameset
portalPluginContentFilter	/plugins/*
portalPluginContentFilter	/skins/*
IppPortalLoginFilter	*.iface (Dispatcher: REQUEST, FORWARD)
IppPortalCharsetFilter	/uploadHtml

listener

The following listener classes should be included:

org.eclipse.birt.report.listener.ViewerServletContextListener
org.eclipse.birt.report.listener.ViewerHttpSessionListener
org.apache.myfaces.webapp.StartupServletContextListener
org.eclipse.stardust.ui.web.viewscommon.common.listener.SessionContextListener
com.icesoft.faces.util.event.servlet.ContextEventRepeater
org.springframework.web.context.ContextLoaderListener
org.springframework.web.context.request.RequestContextListener

servlet

The following servlets are used for the portals:

faces
jackrabbitRepositoryStartupServlet
jackrabbitRepositoryServlet
jackrabbitSimpleWebdavServlet
jackrabbitJcrWebdavServlet
ViewerServlet
EngineServlet
MailConfirmationServlet
DmsContentServlet
Persistent Faces Servlet
Blocking Servlet
cxf-jaxws-servlet
cxf-jaxrs-servlet
carnot-spring-remoting
IppPdfRendererServlet
IppTiffRendererServlet
IppUploadServlet
FsdContentServlet

faces

Servlet class: javax.faces.webapp.FacesServlet.

equinoxbridgeservlet

Servlet class: org.eclipse.equinox.servletbridge.BridgeServlet.

Initialization Parameters:

Parameter Name	Value
commandline
enableFrameworkControls	true
extendedFrameworkExports
frameworkLauncherClass	org.eclipse.equinox.servletbridge.FrameworkLauncher
carnotPlatformDir	carnot-diagrams

jackrabbitRepositoryStartupServlet

Servlet class: org.apache.jackrabbit.j2ee.RepositoryStartupServlet.

Initialization Parameters:

Parameter Name	Value
repository-config	/WEB-INF/jackrabbit/repository-full-text-search.xml
repository-home	c:/tmp/repository
repository-name	jackrabbit.repository
java.naming.provider.url

jackrabbitRepositoryServlet

Servlet class: org.apache.jackrabbit.j2ee.RepositoryAccessServlet.

Initialization Parameters:

Parameter Name	Value
repository-name	jackrabbit.repository
java.naming.provider.url

jackrabbitSimpleWebdavServlet

Servlet class: org.apache.jackrabbit.j2ee.SimpleWebdavServlet.

Initialization Parameters:

Parameter Name	Value
resource-path-prefix	/jackrabbit/repository
missing-auth-mapping	anonymous:anonymous
resource-config	/WEB-INF/jackrabbit/webdav-config.xml

jackrabbitJcrWebdavServlet

Servlet class: org.apache.jackrabbit.j2ee.JCRWebdavServerServlet.

Initialization Parameters:

Parameter Name	Value
resource-path-prefix	/jackrabbit/server
missing-auth-mapping	anonymous:anonymous

ViewerServlet

Servlet class: org.eclipse.stardust.reporting.app.web.servlet.ViewerServlet.

Initialization Parameters:

Parameter Name	Value
INFINITY_REPORTING_DIAGRAM_BASE_URL	..${LIVE_DIAGRAMS_URL}

EngineServlet

Servlet class: org.eclipse.stardust.reporting.app.web.servlet.BirtEngineServlett.

Initialization Parameters:

Parameter Name	Value
INFINITY_REPORTING_DIAGRAM_BASE_URL	..${LIVE_DIAGRAMS_URL}

MailConfirmationServlet

Servlet class: org.eclipse.stardust.engine.extensions.mail.web.servlet.MailApplicationReceptionServlet.

Initialization Parameters:

Parameter Name	Value
successPage
errorPage
user	motu
password	motu

DmsContentServlet

Servlet class: org.eclipse.stardust.engine.api.web.dms.DmsContentServlet.

Persistent Faces Servlet

Servlet class: com.icesoft.faces.webapp.xmlhttp.PersistentFacesServlet.

Blocking Servlet

Servlet class: com.icesoft.faces.webapp.xmlhttp.BlockingServlet.

cxf-jaxws-servlet

Servlet class: org.eclipse.stardust.engine.ws.servlet.DynamicCXFServlet.

Initialization Parameters:

Parameter Name	Value
config-location	classpath:META-INF/spring/cxf/ws-cxf-context.xml,WEB-INF/jax-ws-cxf-context.xml

cxf-jaxrs-servlet

Servlet class: org.apache.cxf.transport.servlet.CXFServlet.

Initialization Parameters:

Parameter Name	Value
config-location	classpath:META-INF/spring/cxf/rs-cxf-context.xml

carnot-spring-remoting

Servlet class: org.springframework.web.servlet.DispatcherServlet.

Parameter Name	Value
contextConfigLocation	/WEB-INF/config/ipp/spring/carnot-spring-remoting-servlet.xml

IppPdfRendererServlet

Servlet class: org.eclipse.stardust.ui.web.viewscommon.views.document.pdf.viewer.PdfRenderer.

IppTiffRendererServlet

Servlet class: org.eclipse.stardust.ui.web.viewscommon.views.document.tiff.TiffRenderer.

FsdContentServlet

Servlet class: org.eclipse.stardust.ui.web.viewscommon.docmgmt.FileSystemDocumentServlet.

IppUploadServlet

Servlet class: com.icesoft.faces.component.inputfile.FileUploadServlet.

servlet-mappings

Name	URL Pattern
faces	/faces/*
jackrabbitSimpleWebdavServlet	/jackrabbit/repository/*
jackrabbitJcrWebdavServlet	/jackrabbit/server/*
ViewerServlet	/frameset/*
ViewerServlet	/run/*
EngineServlet	/preview
EngineServlet	/download
EngineServlet	/parameter
EngineServlet	/document
EngineServlet	/output
EngineServlet	/extract
equinoxbridgeservlet	/eclipse/*
MailConfirmationServlet	/mail-confirmation
DmsContentServlet	/dms-content/*
FsdContentServlet	/fsd-content/*
Persistent Faces Servlet	*.iface
Persistent Faces Servlet	/xmlhttp/*
Blocking Servlet	/block/*
cxf-jaxws-servlet	/services/soap/*
cxf-jaxrs-servlet	/services/rest/*
carnot-spring-remoting	/remoting/*
IppPdfRendererServlet	/IppPdfRenderer
IppTiffRendererServlet	/IppTiffRenderer
IppUploadServlet	/uploadHtml

welcome-file-list

Specify the following welcome file: index.jsp.

<welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
</welcome-file-list>

resource-ref

The following resource-ref element is added to define a JNDI name for the database connection and the according data source:

<resource-ref>
    <res-ref-name>jdbc/AuditTrail.DataSource</res-ref-name>
    <res-type>javax.sql.DataSource</res-type>
    <res-auth>Container</res-auth>
    <res-sharing-scope>Shareable</res-sharing-scope>
</resource-ref>

Additional Customizing Parameters

The following parameters can be used to customize the Stardust Portal:

Name	Default Value	Description
com.icesoft.faces.connectionTimeout	60000 (ms)	This parameter defines how long, in milliseconds, the bridge will wait for a response from the server for a user-initiated request before declaring a connection lost.

Security Issue with WebDav Servlets

Note that Jackrabbit WebDav servlets compromise security by allowing read access on the complete repository. They should be removed for productive environments!

In a productive environment, remove the following entries from your web.xml:

...
  <servlet>
  	<display-name>Jackrabbit Repository Servlet (Simple Webdav)</display-name>
  	<servlet-name>jackrabbitSimpleWebdavServlet</servlet-name>
  	<servlet-class>org.apache.jackrabbit.j2ee.SimpleWebdavServlet</servlet-class>
  	<init-param>
  		<param-name>resource-path-prefix</param-name>
  		<param-value>/jackrabbit/repository</param-value>
  	</init-param>
  	<init-param>
  		<param-name>missing-auth-mapping</param-name>
  		<param-value>anonymous:anonymous</param-value>
  	</init-param>
  	<init-param>
  		<param-name>resource-config</param-name>
  		<param-value>/WEB-INF/jackrabbit/webdav-config.xml</param-value>
  	</init-param>
  	<load-on-startup>4</load-on-startup>
  </servlet>
  <servlet>
  	<display-name>Jackrabbit Repository Servlet (JCR over Webdav)</display-name>
  	<servlet-name>jackrabbitJcrWebdavServlet</servlet-name>
  	<servlet-class>org.apache.jackrabbit.j2ee.JCRWebdavServerServlet</servlet-class>
  	<init-param>
  		<param-name>resource-path-prefix</param-name>
  		<param-value>/jackrabbit/server</param-value>
  	</init-param>
  	<init-param>
  		<param-name>missing-auth-mapping</param-name>
  		<param-value>anonymous:anonymous</param-value>
  	</init-param>
  	<load-on-startup>5</load-on-startup>
  </servlet>
...
  <servlet-mapping>
  	<servlet-name>jackrabbitSimpleWebdavServlet</servlet-name>
  	<url-pattern>/jackrabbit/repository/*</url-pattern>
  </servlet-mapping>
  <servlet-mapping>
  	<servlet-name>jackrabbitJcrWebdavServlet</servlet-name>
  	<url-pattern>/jackrabbit/server/*</url-pattern>
  </servlet-mapping>
...