Web container custom properties

You can configure name-value pairs of data, where the name is a property key and the value is a string value that you can use to set internal system configuration properties. Defining a new property enables you to configure a setting beyond that which is available in the administrative console. The following is a list of some of the available Web container custom properties.

To specify Web container custom properties:

  1. In the administrative console click Servers > Server Types > WebSphere application servers > server_name > Web Container Settings > Web container .
  2. Under Additional Properties select Custom Properties.
  3. On the Custom Properties page, click New.
  4. On the settings page, enter the name of the custom property that you want to configure in the Name field and the value that you want to set it to in the Value field.
  5. Click Apply or OK.
  6. Click Save on the console task bar to save your configuration changes.
  7. Restart the server.

The following is a list of custom properties provided with the Application Server. The topics, JavaServer Pages specific Web container custom properties and HTTP transport custom properties, are listed in a separate topic.

You can use the Custom properties page to define the following properties for use by the Java™ virtual machine.

BodyContentBuffSize

The size of the body content buffer for a JavaServer Pages (JSP) file can affect the performance of some applications. By default, the body content buffer size is 512 bytes. However, you can use the BodyContentBuffSize custom property to set a different buffer value.

Name Value
BodyContentBuffSize 512

com.ibm.ws.jsp.enableDefaultIsELIgnoredInTag

[Fix Pack 11 or later]

Typically WebSphere® Application Server, Expression Language (EL) expressions in tag files get evaluated before the tag files a JavaServer Page (JSP) is compiled. However, under certain conditions these EL expressions in a tag file do not get evaluated if the <el-ignored> attribute is set to true.

To ensure that EL expressions are always evaluated, set the com.ibm.ws.jsp.enableDefaultIsELIgnoredInTag custom property to true. The default value for this property is false.

Name Value
com.ibm.ws.jsp.enableDefaultIsELIgnoredInTag true

com.ibm.ws.jsp.getWriterOnEmptyBuffer

[Fix Pack 7 or later]

The dynamic cache service uses flushes to determine when one cacheable Web fragment, such as a JSP include or a c:import, ends and the next Web fragment begins. If you set the com.ibm.wsspi.jsp.usecdatatrim custom property to true for your JSP engine, all of the white space and extra lines in the generated Java code are stripped out. In this situation, there might not be any content to write before the first flush. If the generated Java code contains text or other code before the first flush then normal dynamic cache service processing occurs.

If you set the com.ibm.wsspi.jsp.usecdatatrim custom property to true, and are using the dynamic cache service, you must also set the com.ibm.ws.jsp.getWriterOnEmptyBuffer custom property to true. This custom property requires the JSP Engine to call the flush function when it reaches the end of the first cachable Web fragments even if there is not any data to flush. The default value for this property is false.

Name Value
com.ibm.ws.jsp.getWriterOnEmptyBuffer true

com.ibm.ws.jsp.limitBuffer

[Fix Pack 9 or later]

The body content buffer size of the tag bodies for a JavaServer Pages (JSP) file are reused to optimize performance. If the size of a tag body increases beyond the default body content buffer size, the buffer is resized to accommodate the tag body. However, the buffer is not reset to the default size after serving a request. As a result, the heap memory that is used by org.apache.jasper.runtime.BodyContentImpl implementation might increase over time. You can configure the body content buffer size by setting an integer value for the BodyContentBuffSize custom property. For more information, see BodyContentBuffSize.

Use the com.ibm.ws.jsp.limitBuffer custom property to deallocate large body content buffer sizes and create a new buffer with the default buffer size.

The default value is false.

Name Value
com.ibm.ws.jsp.limitBuffer true

com.ibm.ws.jsp.throwExceptionForAddELResolver

[Fix Pack 11 or later]

Set the com.ibm.ws.jsp.throwExceptionForAddELResolver property to true if you do not want to allow an ELResolver to be registered from a servlet or a filter after the application has received a request from the client. When this property is set to true, an IllegalStateException is thrown as specified by the JSP(Java Server Pages) specification for addELResolver() method of the JspApplicationContext interface.

The default value for this property is false.

Name Value
com.ibm.ws.jsp.throwExceptionForAddELResolver true

com.ibm.ws.jsp.zosFileLockRetrying

[z/OS] [Fix Pack 3 or later]

Use the com.ibm.ws.jsp.zosFileLockRetrying property to specify, in seconds, the amount of time during which a thread continues to try to obtain a lock on a JSP.

A JSP file is locked prior to the start of the compile process, and unlocked after the compile process completes. If a thread fails to lock a JSP, the thread continues to try to obtain the file lock for that JSP for up to 240 seconds. If the thread cannot obtains the lock during this time interval, an error message is issued. The thread does not make any additional attempts to obtain a lock for the JSP.

Data type Integer
Default 240

com.ibm.ws.jsp.zosReCompile

[z/OS] [Fix Pack 3 or later]

Use the com.ibm.ws.jsp.zosReCompile property to specify how many times a thread should attempt to lock a JSP.

After a thread obtains the lock for a JSP, the thread determines whether the JSP is already compiled. If the JSP is not compiled, the thread tries to compile the JSP.

If after the specified number of tries, the thread cannot compile the JSP, an error message is issued. The thread does not make any additional attempts to compile the JSP.

Data type Integer
Default 5

com.ibm.ws.webcontainer.assumefiltersuccessonsecurityerror

[Fix Pack 5 or later]

When a request is received for a static file which does not exist, the Web container calls defined servlet filters. If the filters do no successfully complete, a 404 error code is set. In a situation where application security is enabled, a security check is performed as part of filter invocation. Typically if the security check fails the Web Container considers the filters to have failed and still sets a 404 error code instead of the 401 error code that indicates the failure of a security check. The 404 error code enables the requester to access the static file without logging on.

If you are running on Version 7.0.0.5, or later, you can set the com.ibm.ws.webcontainer.assumefiltersuccessonsecurityerror custom property to true, to prevent the 401 error code from being replaced with a 404 error code, and thereby ensure that a user must enter a valid userid and password before he can access a static file. The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.assumefiltersuccessonsecurityerror true

com.ibm.ws.webcontainer.channelwritetype

By default, the Web container uses asynchronous writes to write response data in chunks up to the response buffer size. For larger responses that are greater than the response buffer size, the Web container continues to buffer response data into memory while waiting for an asynchronous write of a response data chunk to complete. This can result in part of a large response held in memory, which can lead to high memory usage and potentially an out of memory error. An application server hang may also occur when a server is simultaneously processing more requests than Web container defined threads.

If the com.ibm.ws.webcontainer.channelwritetype property is set to sync, synchronous writing is used, otherwise asynchronous writing is used by default. With synchronous writing, response data are written synchronously in chunks of up to the value of responsebuffersize and no response data are buffered into memory while waiting for a synchronous write of a response data chunk to complete. As a result, the approximate maximum amount of response data that is held in memory is equal to the responsebuffersize multiplied by the number of Web container threads. The maximum number of requests that can be processed simultaneously by the Web container is limited by the number of Web container threads. Additional requests are queued, waiting for a request that is in process to complete.

The responsebuffersize Web container custom property defines the maximum amount of response data written by the Web container in a single chunk, and is 32k by default. As a result, it is used to change the number of writes needed by the Web container to send complete response data. However, if an application flushes response data, any response data held by the Web container is immediately written irrespective of the responsebuffersize.

Use the following name-value pair to write chunks of data using synchronous writes.

Name Value
com.ibm.ws.webcontainer.channelwritetype sync

com.ibm.ws.webcontainer.copyattributeskeyset

[Fix Pack 5 or later]

This custom property addresses a situation where the request.getAttributeNames method returns a list of values. If a servlet modifies the list using the request.removeAttribute method, subsequent calls to the nextElement method causes a java.util.ConcurrentModificationException exception. To enable a servlet to modify the list, set the com.ibm.ws.webcontainer.copyattributeskeyset custom property to true. When you set this custom property to true, a copy of the list of attributes is returned, which enables the servlet to modify the list without resulting in a java.util.ConcurrentModificationException exception when the nextElement method is called.

Name Default value
com.ibm.ws.webcontainer.copyattributeskeyset false

com.ibm.ws.webcontainer.disableSetCharacterEncodingAfterParametersRead

[Fix Pack 11 or later]

The Web container processes a setCharacterEncoding(String) method of the ServletRequest API even if it is called after the post data is parsed. According to the Java Servlet Specification, the Web container should ignore a setCharacterEncoding(String) method if the method is called after the data is parsed.

If you want the Web container to ignore a setCharacterEncoding(String) method if the method is called after the data is parsed, add the com.ibm.ws.webcontainer.disableSetCharacterEncodingAfterParamete rsRead custom property to your Web container configuration settings and set this property to true.

The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.disableSetCharacterEncodingAfterParametersRead true

com.ibm.ws.webcontainer.disableSystemAppGlobalListenerLoading

If a system application is the first to start, and the application attempts to load a global listener in a shared library that is associated with the server classloader, the application does not load that listener and prevents the listener from being loaded or invoked by a later non-system application. Set the com.ibm.ws.webcontainer.disableSystemAppGlobalListenerLoading custom property to true to prevent system applications from loading global listeners. When this property is set to true, the system application does not attempt to load the global listeners and later non-system applications can load them from a shared library associated with a server class loader.

Name Value
com.ibm.ws.webcontainer.disableSystemAppGlobalListenerLoading true

com.ibm.ws.webcontainer.disallowAllFileServing

Use the com.ibm.ws.webcontainer.disallowAllFileServing custom property to disable file serving on all applications on a specific application server.

You can enable file serving on a global level across a given application server by using the fileServingEnabled custom property. However, the fileServingEnabled property is overridden by the specific deployment information of each application. Therefore, the current fileServingEnabled custom property only applies as a backup in case an application does not define the fileServingEnabled setting itself.

To globally override this setting on a specific application server to prevent the application server from serving static files regardless of their individual deployment settings, set the com.ibm.ws.webcontainer.disallowAllFileServing Web container custom property to true using the following name-value pair.

Name Value
com.ibm.ws.webcontainer.disallowAllFileServing true

com.ibm.ws.webcontainer.disallowserveservletsbyclassname

When the serveServletsByClassnameEnabled property is enabled, it is possible to access servlets directly, resulting in a possible security exposure. Define the following custom property to disallow the use of the serveServletsByClassnameEnabled property across the entire application server level.

Name Value
com.ibm.ws.webcontainer.disallowserveservletsbyclassname true

com.ibm.ws.webcontainer.discernUnavailableServlet

[Fix Pack 5 or later]

Typically, when the Web container receives an UnavailableException, it cannot determine whether the exception was issued from a servlet or a dispatched resource. Therefore, the Web container automatically marks the servlet unavailable even if it is the dispatched resource that is unavailable.

If you are running on Version 7.0.0.5 or later, and have set the com.ibm.ws.webcontainer.discernUnavailableServlet custom property to true, any UnavailableException that is issued from a dispatched resource is placed in a wrapper. This wrapper enables the Web container to determine whether the exception was issued from the servlet or a dispatched resource. If the exception is not issued by the servlet, the Web container does not mark the servlet unavailable.

The default value for the com.ibm.ws.webcontainer.discernUnavailableServlet custom property is false.

Name Value
com.ibm.ws.webcontainer.discernUnavailableServlet true

com.ibm.ws.webcontainer.dispatcherRethrowSER

[Fix Pack 5 or later]

Typically, the RequestDispatcher does not propagate exceptions thrown from dispatched servlets, including JavaServer Pages, back to the servlet doing the dispatching. If you want the RequestDispatcher to throw exceptions back to the servlet doing the dispatching, add the com.ibm.ws.webcontainer.dispatcherRethrowSER custom property to the settings for the Web container, and set the property to true. The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.dispatcherRethrowSER true

com.ibm.ws.webcontainer.divertrecursiveexceptiontoerrorlog

[z/OS]

When a recursive error occurs in an application, the exception message is logged by the trace audit method, which directs the message to the system console. If you need the message to be logged in the error log instead, add the com.ibm.ws.webcontainer.divertrecursiveexceptiontoerrorlog custom property to the Web container configuration settings, and set the property to true. When the com.ibm.ws.webcontainer.divertrecursiveexceptiontoerrorlog property is set to true, exception messages are sent to the error log instead of to the system console.

Name Value
com.ibm.ws.webcontainer.divertrecursiveexceptiontoerrorlog true

com.ibm.ws.webcontainer.donotservebyclassname

The com.ibm.ws.webcontainer.donotservebyclassname custom property specifies a list of classes that cannot be served by the class name.

Name Value
com.ibm.ws.webcontainer.donotservebyclassname A semi-colon delimited list of classes to be completely disallowed from being served by class name.

com.ibm.ws.webcontainer.enabledefaultservletrequestpathelements

[Fix Pack 5 or later]
To correctly map a request to a default servlet, you need to determine the proper servlet path and PathInfo values. The following table shows the affects on the Servlet Path and PathInfo values when you set the com.ibm.ws.webcontainer.enabledefaultservletrequestpathelements custom property to a true or false value.
Table 1. Servlet Path and PathInfo values. Values for Servlet Path and PathInfo
Value Servlet Path value PathInfo value
true Set to the contents of the URI after the Context Path Set to a null value
false (Default) Set to an empty string Set based on the contents of the URI after the Context Path
[oct2010]

com.ibm.ws.webcontainer.enableErrorExceptionTypeFirst

[oct2010]
oct2010
When an exception occurs, the Web container searches for an error page to handle that exception. The default searching order is:
  1. Any matching error-code error page
  2. Any matching exception-type error page

The matched error-code page is always returned even if there is also a matching exception type error page defined in the web.xml file. To have the Web container search and use the exception-type before the error-code, use the following name-value pair:

Name Value
com.ibm.ws.webcontainer.enableErrorExceptionTypeFirst true

com.ibm.ws.webcontainer.enableJspMappingOverride

[Fix Pack 11 or later]

When a url-pattern is defined in the jsp-property-group of the web.xml, file, it is typically mapped to, and handled by the JavaServer Page (JSP) engine. If you have applications that need to override this mapping so that they can handle and serve the JSP content themselves, set the com.ibm.ws.webcontainer.enableJspMappingOverride property to true.

The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.enableJspMappingOverride true

com.ibm.ws.webcontainer.enableMultiReadOfPostData

[Fix Pack 9 or later]

Set the com.ibm.ws.webcontainer.enableMultiReadOfPostData custom property to true if you want to enable multiple reads of post data. When this property is set to , the post data can be read multiple times as either an InputStream or Reader, and as parameters.

When the Web container is enabled for multiple reads of post data, you can set up an application to complete the following actions if you want that application to re-read post data from the beginning using either an InputStream or Reader:
  1. Obtain the InputStream or Reader
  2. Read the data
  3. Close the InputStrean or Reader

If either the first or third action does not occur, the next read of the post data is not reset to the beginning of that data.

The Web container automatically completes this sequence if an application re-reads the post data as parameters.

The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.enableMultiReadOfPostData true

com.ibm.ws.webcontainer.extractHostHeaderPort and trusthostheaderport

The getServerPort method relies on the getVirtualPort method of the channel, which returns a port number in the following order:
  1. Port number from the request URL
  2. Port number from the request host header
This order is compliant with HTTP/1.1 RFC but not with the Java Servlet Specification Version 2.4 API, which requires the port number from the host header to be returned first, if any, or the request URL. The correct returned URL for the above example is: http://ProxyServer:8888. The Web container was modified to return a port number from the host header, if any, or the URL port that accepted the client connection. You must set the trusthostheaderport and the com.ibm.ws.webcontainer.extractHostHeaderPort custom property to true to return the port number from the request host header first. For example, set these properties in the web.xml file using:
trusthostheaderport = true     
com.ibm.ws.webcontainer.extractHostHeaderPort = true

Or you can set these properties as Web container custom properties in the administrative console using the following two sets of name-value pairs:

Name Value
com.ibm.ws.webcontainer.extractHostHeaderPort true
trusthostheaderport true

com.ibm.ws.webcontainer.fileWrapperEvents

[z/OS]

In WebSphere Application Server Version 5.1 processing of static files is performed by SimpleFileServlet which generates both SMF and PMI data. In Version 6.0.1 and later, static files are handled by a file wrapper that does not generate SMF and PMI data for static files. If you need to generate SMF and PMI data when serving static files, add the com.ibm.ws.webcontainer.fileWrapperEvents custom property to you Web container configuration settings, and set the property to true.

Name Value
com.ibm.ws.webcontainer.fileWrapperEvents true

com.ibm.ws.webcontainer.FileWrapperEventsLessDetail

[z/OS] [Fix Pack 11 or later]

Starting with Version 6.1, the SMF type 120 record displays the name of the static resource instead of FileServletWrapper in the name field of a static file report. If you migrated from an earlier version of the product, and want your SMF type 120 record to display FileServletWrapper in the name field of a static file report, add the com.ibm.ws.webcontainer.FileWrapperEventsLessDetail custom property to your Web container settings and set it to true. The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.FileWrapperEventsLessDetail false

com.ibm.ws.webcontainer.finishresponseonclose

[Fix Pack 7 or later]

Use the com.ibm.ws.webcontainer.finishresponseonclose custom property to indicate that you want the Web container to close a connection when a servlet calls close() on a writer or output stream.

Typically, when a servlet calls close() on a writer or output stream, the Web container sends the data that has been written to the writer or output stream to the client, and then waits for the servlet service() method to finish before it closes the connection. This delay might be interpreted as a response completion delay, especially if a servlet service() method does not complete until sometime after the writer or output stream is closed.

Name Value
com.ibm.ws.webcontainer.finishresponseonclose true

com.ibm.ws.webcontainer.HTTPOnlyCookies

[Fix Pack 9 or later]
The [jul2010] com.ibm.ws.webcontainer.HTTPOnlyCookies [jul2010]
jul2010
custom property provides a level of defense against a client-side script accessing a protected cookie and acquiring its content. By using this custom property you can prevent Java scripts that run in a browser from accessing all cookies or a particular list of cookies of your choosing. The HTTPOnly attribute is added to each cookie specified in this custom property and enables protection from client-side script access.
Avoid trouble: Specifying [jul2010] com.ibm.ws.webcontainer.HTTPOnlyCookies [jul2010]
jul2010
with no operands means that the HTTPOnly attribute will NOT be added to any cookie, and any client-side Java script running in a browser can access the content of any and all cookies.gotcha
The following examples illustrate setting this custom property.
com.ibm.ws.webcontainer.HTTPOnlyCookies = *
com.ibm.ws.webcontainer.HTTPOnlyCookies =  cookieName1, Account3Cookie, JsessionID 
Note: Cookie names used in specifying [jul2010] com.ibm.ws.webcontainer.HTTPOnlyCookies [jul2010]
jul2010
are case-insensitive.
Name Value
[jul2010] com.ibm.ws.webcontainer.HTTPOnlyCookies [jul2010]
jul2010
  • * An asterisk value means that all cookies are given the HTTPOnly attribute.
  • or
  • A comma delimited list of the specific cookies that are given the HTTPOnly attribute. The HTTPOnly attribute is only given to cookies that are on this list.

com.ibm.ws.webcontainer.ignoreinjectionfailure

[Fix Pack 9 or later]

If a resource or Enterprise JavaBeans (EJB) injection fails during the servlet initialization process, an error message is written to the server log files. However, the error message is not propagated to the client. In addition, the servlet is put into service and it is not reinitialized until its application is restarted. During this time, if a request is received that references the resource, which previously failed to inject, a NullPointerException exception results. Similarly, this problem can occur during the filter and listener initialization processes.

The com.ibm.ws.webcontainer.ignoreinjectionfailure custom property enables you to specify whether to propagate these error messages and whether to put a servlet into service. By default, the custom property has a default value of true, which retains the previously described behavior. To enable the propagation of these injection exceptions to the client and to not put the servlet into service, you must set this custom property to false.

Name Value
com.ibm.ws.webcontainer.ignoreinjectionfailure true

com.ibm.ws.webcontainer.ignoreInvalidQueryString

[Fix Pack 5 or later]

When the Web container encounters an encoding character in a query string pair that is not valid, it throws an IllegalArgumentException exception and, by default, ignores the entire query string. In applications where every field in the query string is an essential resource, it might not be desirable to ignore the entire query string. If you set the com.ibm.ws.webcontainer.ignoreInvalidQueryString custom property to true, the Web container ignores query string pairs that are not valid and continues to process valid query string pairs.

Name Default value
com.ibm.ws.webcontainer.ignoreInvalidQueryString false

com.ibm.ws.webcontainer.IgnoreSessiononStaticFileRequest

[Fix Pack 7 or later]

The Web container accesses a session for the static file requests involving filters. This action can result in a performance degradation, for example, when running with database session persistence. If you set the com.ibm.ws.webcontainer.IgnoreSessiononStaticFileRequest custom property to true, the Web container cannot access a session for the static files requests involving filters. The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.IgnoreSessiononStaticFileRequest true

com.ibm.ws.webcontainer.invokeFilterInitAtStartup

[Fix Pack 7 or later]

The com.ibm.ws.webcontainer.invokeFilterInitAtStartup custom property enables the Web container to invoke the init method and initialize a filter during the startup process for an application. The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.invokeFilterInitAtStartup true

com.ibm.ws.webcontainer.invokeFiltersCompatibility

You might need use a custom servlet filter with Web applications to map files from a one URI to another URI that points to a particular resource. For example, you might map URIs that start with my_company to the my_company/external directory. Without enabling the com.ibm.ws.webcontainer.invokeFiltersCompatibility custom property, the Web container does not call any custom servlet filters.

With this custom property, the Web container calls custom servlet filters before looking for welcome files. Also, if the Web container cannot find a resource, it calls the custom servlet filters before creating a FileNotFoundException exception. This change enables the Web container to verify whether the custom servlet filters modify the path to a resource.

Name Value
com.ibm.ws.webcontainer.invokeFiltersCompatibility true

com.ibm.ws.webcontainer.invokerequestlistenerforfilter

[Fix Pack 7 or later]

If a Web application has defined the listener in the Web deployment descriptor xml file, then you must set the com.ibm.ws.webcontainer.invokerequestlistenerforfilter custom property to true to have ServletRequestListener invoked when a request is about to enter the filter for that Web application.

According to the Java Servlet Specification, a ServletRequestListener should be invoked if a request is about to enter the filter for a Web application that has defined the listener in the Web deployment descriptor xml file.

The default value is false.

Name Value
com.ibm.ws.webcontainer.invokerequestlistenerforfilter true

com.ibm.ws.webcontainer.mapFiltersToAsterisk

When processing a request, the Web container recognizes servlet mappings to "*" as the same as servlet mappings to "/*". To provide the same behavior with filter mapping, set the com.ibm.ws.webcontainer.mapFiltersToAsterisk custom property to true. Setting the com.ibm.ws.webcontainer.mapFiltersToAsterisk custom property to true causes the Web container to recognize filter mappings to "*" as a filter mapping to "/*" . This custom property is not case sensitive.

Name Value
com.ibm.ws.webcontainer.mapFiltersToAsterisk true

com.ibm.ws.webcontainer.normalizerequesturi

[Fix Pack 4 or later]

Typically, request URI 404 errors do not occur if a request URI is submitted from a browser, because most modern browsers automatically normalizes a request URI prior to calling WebSphere Application Server. Therefore, by default, the Web container does not normalize a request URI before trying to resolve that URI to an application and servlet mapping.

A request URI, that includes /./ or /../ as part of an application context, that has not been normalized, might fail with a 404 error. Similarly, a request URI, that includes /./" or /../ as part of a servlet path, that has not been normalized, fails to match a servlet mapping, which also results in a 404 error, even though the URI is normalized prior to resolving the URI to a JavaServer Pages (JSP) or static file.

If you are running on Version 7.0.0.4, or later, you can set the com.ibm.ws.webcontainer.normalizerequesturi custom property to true, the Web container normalizes these types of request URIs.

Name Value
com.ibm.ws.webcontainer.normalizerequesturi true

com.ibm.ws.webcontainer.provideQStringToWelcomeFile

[Fix Pack 5 or later]

Typically, when a request is initially sent to the context root of the application, the request is forwarded to a welcome file. If a query string is included in an initial request, it is not available to the welcome file if you included the request.getQueryString() attribute in the welcome file. However, the query string is available to the welcome file if you included the javax.servlet.forward.query_string attribute in the welcome file.

If you need to use the request.getQueryString() attribute, instead of the javax.servlet.forward.query_string attribute, to make the query string available to the welcome file, add the com.ibm.ws.webcontainer.provideQStringToWelcomeFile custom property to your Web container configuration and set the property to true. The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.provideQStringToWelcomeFile true

com.ibm.ws.webcontainer.reInitServletOnInitUnavailableException

[Fix Pack 9 or later]

The Web container, by default, sets a servlet as unavailable when an UnavailableException is thrown from an init method for that servlet. As a result, on a subsequent request, the init method is not called, and the servlet is treated as either permanently or temporarily unavailable, depending on whether a permanent or temporary UnavailableException is thrown. However, the Java Servlet Specification states that a new instance of a servlet might be instantiated and initialized by the container after a failed initialization.

If you want the Web container to treat a servlet as uninitialized after an initialization failure, such as when an UnavailableException is thrown from the servlet init method, set the com.ibm.ws.webcontainer.reInitServletOnInitUnavailableException Web container custom property to true. When this property is set to true, if the Web container receives a request for a servlet after a permanent UnavailableException is thrown from the init method for that servlet, the Web container loads and initializes the servlet. However If the int method throws a temporary UnavailableException, the Web container does not load and initialize the servlet until the associated timer expires.

The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.reInitServletOnInitUnavailableException false

com.ibm.ws.webcontainer.ServeWelcomeFileFromExtendedDocumentRoot

[Fix Pack 11 or later]

Typically, the first time the Web container handles a request for a static welcome page that is not a JavaServer Pages (JSP) file, the Web container does not search the ExtendedDocumentRoot for the welcome file unless the request for that welcome file is fully-qualified. If the request is fully-qualified, the Web container serves the welcome file, and the context root of the application displays the welcome file. If the request for the static welcome file is not fully-qualified, the Web container returns a 404 error, which indicates that the Web container did not fine the welcome file.

After the Web container successfully serves a welcome file, the Web container creates a mapping for that welcome file. The Web container then uses this mapping to handle future requests for the welcome file, thereby eliminating the need for subsequent requests to be fully-qualified.

If you want the Web container to always search an application defined ExtendedDocumentRoot for a welcome file, even if the request is not fully-qualified, you can add the com.ibm.ws.webcontainer.ServeWelcomeFileFromExtendedDocumentRoot custom property to your Web container settings, and set this property to true.

The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.ServeWelcomeFileFromExtendedDocumentRoot false

com.ibm.ws.webcontainer.ServletDestroyWaitTime

By default, when an application is stopped the Web container waits up to 60 seconds for each active request for a resource of that application to complete. You can now define the com.ibm.ws.webcontainer.ServletDestroyWaitTime Web container custom property to control the amount of time that the Web container waits for an active request to complete when the owning application is stopped.

Set the com.ibm.ws.webcontainer.ServletDestroyWaitTime custom property to an integer value, which specifies the number of seconds to wait for a request to complete. The default value is 60 seconds.

Name Value
com.ibm.ws.webcontainer.ServletDestroyWaitTime integer

com.ibm.ws.webcontainer.setUnencodedHTMLinsendError

[Fix Pack 11 or later]

Typically, the Web container encodes the specified error messages prior to formatting them, to prevent Cross-Site Scripting (XSS) attacks on the client if the application does not sanitize these messages. However the the Java Servlet Specification for the sendError(int, String) method, indicates that the server should create the response to look like an HTML-formatted server error page.

If you do not want the Web container to encode the specified error messages prior to formatting them, add the com.ibm.ws.webcontainer.setUnencodedHTMLinsendError custom property to your Web container configuration settings, and set the property to true.

The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.setUnencodedHTMLinsendError true

com.ibm.ws.webcontainer.suppressheadersinrequest

[Fix Pack 5 or later]

The com.ibm.ws.webcontainer.suppressheadersinrequest custom property can be used to suppress the inclusion of request headers that start with special characters, such as "$" or "_" . Some applications do not handle request headers that start with special characters.

Name Value
com.ibm.ws.webcontainer.suppressheadersinrequest Delimited list of header prefixes to be suppressed.

Example: $WS,_WS

com.ibm.ws.webcontainer.suppressHtmlRecursiveErrorOutput

During a recursive error that an application specified error page cannot handle, the stack trace and error message are outputted as an HTML page. This information includes class names and program information that the application developer does not want expose to the user.

You can set the com.ibm.ws.webcontainer.suppressHtmlRecursiveErrorOutput Web container custom property to suppress the HTML output of the error text, without changing the internal logging of the message. Set the custom property com.ibm.ws. webcontainer.suppressHtmlRecursiveErrorOutput to true to disable the HTML output of the error message to the user and present the user with blank page with a 500 error code.

Name Value
com.ibm.ws.webcontainer.suppressHtmlRecursiveErrorOutput true

com.ibm.ws.webcontainer.suppressLastZeroBytePackage

[Fix Pack 7 or later]

Typically, the last zero byte chunk is used to indicate, to a client, the end of the response data in a chunked encoded transmission. Some applications use this last zero to determine when the response data is completely received, and they can start processing it. If an error occurs in the application after the response headers are sent, the last chunk of data is still sent to the client. The client might not realize that an error has occurred, and attempt to process incomplete data.

If you set the com.ibm.ws.webcontainer.suppressLastZeroBytePackage custom property to true, if an error occurs in the application after the response headers are sent, the last chunk of data is not sent to the client. The default value for this property is false.

Name Value
com.ibm.ws.webcontainer.suppressLastZeroBytePackage true

com.ibm.ws.webcontainer.suppressServletExceptionLogging

If a servlet creates an exception, it is logged to the system console. If you do not want the Web container to log servlet- created exceptions, add the com.ibm.ws.webcontainer.suppressServletExceptionLogging custom property to the Web container configuration settings, and set the property to true.

Name Value
com.ibm.ws.webcontainer.suppressServletExceptionLogging true

com.ibm.ws.webcontainer.throwMissingJspException

Set the com.ibm.ws.webcontainer.throwMissingJspException custom property to true to create a FileNotFoundException when a resource that is included by a JSP file is missing. If this property is not set to true, an error page is displayed.

Name Value
com.ibm.ws.webcontainer.throwMissingJspException true

com.ibm.ws.webcontainer.tolerateLocaleMismatchForServingFiles

[AIX] [Fix Pack 13 or later]
You might encounter a FileNotFound 404 error from the Web container and the request is not served when the following encodings do not match:

For example, if the request is for a double-byte character set (DBCS)-encoded file name and the file system locale is en_US, which is a ISO-8859 encoding, the match fails.

To resolve this issue, set the com.ibm.ws.webcontainer.tolerateLocaleMismatchForServingFiles custom property to true. By default, the value is false. When you set this custom property, the Web container tolerates the mismatch of the file system and requested file name encodings. The Web container then servers the request for a valid file.

Name Value
com.ibm.ws.webcontainer.tolerateLocaleMismatchForServingFiles true

com.ibm.ws.webcontainer.webgroupvhostnotfound

[Fix Pack 7 or later]

Error message SRVE0017W states "Web Group not found: {0}", and error message SRVE0255 states "A WebGroup/Virtual Host to handle {0} has not been defined". These messages might be returned when the application that is called to process the request serviced by IBM WebSphere Application Server is not found. You can use the com.ibm.ws.webcontainer.webgroupvhostnotfound custom property to change the text of these message to text that is more suitable for your environment.

Name Value
com.ibm.ws.webcontainer.webgroupvhostnotfound String

Example: Application not found.

com.ibm.wsspi.jsp.convertAttrValueToString

Set the com.ibm.wsspi.jsp.convertAttrValueToString Web container custom property to true to convert start and end attributes of the repeat tag to strings before they are used.

Name Value
com.ibm.wsspi.jsp.convertAttrValueToString true

com.ibm.wsspi.jsp.disableElCache

Set the com.ibm.wsspi.jsp.disableElCache Web container custom property to true to disable the commons-el expression cache if you are experiencing out of memory conditions because the hash maps are held by the expression evaluator.

Name Value
com.ibm.wsspi.jsp.disableElCache true

com.ibm.wsspi.jsp.disableResourceInjection

[Fix Pack 11 or later]

The resource injection feature accesses resources in applications differently then it did in earlier versions of the product, and causes the compiled method output to be larger than it was previously. If you have large JSPs that in earlier releases pushed the 65535 byte limit in the translated service method, they might now exceed this limit, causing the compile to fail

If you encounter this situation, you can either break a large JSP into smaller JSPs, and use <jsp:include> statements to combine them after they are compiled, or you can add the com.ibm.wsspi.jsp.disableResourceInjection custom property to your Web container settings to disable the resource injection function during the JSP translation process. When the com.ibm.wsspi.jsp.disableResourceInjection custom property is set to true, the resource injection function is disabled for all applications.

If you only want to disable the resource injection function for specific applications, you can add the disableResourceInjection JSP attribute to the ibm-web-ext.xmi files for those specific applications.

The default value for the com.ibm.wsspi.jsp.disableResourceInjection custom property is false.

Name Value
com.ibm.wsspi.jsp.disableResourceInjection true

com.ibm.wsspi.jsp.disableTldSearch

The com.ibm.wsspi.jsp.disableTldSearch custom property can be used to improve application startup time. By default, when an application starts, the JSP engine searches the application installation directories for the taglib descriptor (TLD) files. This search process might increase the startup time for large applications with a large number of files and directories. To disable this search process, use the following name-value pair:

Name Value
com.ibm.wsspi.jsp.disableTldSearch true

DebugSessionCrossover

[AIX Solaris HP-UX Linux Windows] [iSeries]

The DebugSessionCrossover custom property enables the Web container to perform additional checks to verify that only the session associated with the request is accessed or referenced. Messages are logged if any discrepancies are detected.

Note: The use of the DebugSessionCrossover property as a Web container custom property is deprecated. You should define it as a session management custom property.

To enable session data crossover detection, use the following name-value pair:

Name Value
DebugSessionCrossover true

Refer to the HTTP session problems article for additional information.

DecodeUrlAsUTF8

The UTF-8 encoded URL feature, which provides UTF-8 encoded Uniform Resource Locators (URLs) to support the double-byte characters in URLs is enabled by default. You can prevent the Web container from explicitly decoding URLs in UTF-8 and have them use the ISO-8859 standard as per the current HTTP specification by using the following name-value pair.

Name Value
DecodeUrlAsUTF8 false

enableInProcessConnections

Use the enableInProcessConnections custom property to reduce response times and to reduce the number of threads that are used to service a request, which reduces the potential for a deadlock. There is an optimized communication path between a Web services client application and a Web container that are located in the same application server process. Requests from the Web services client that are normally sent to the Web container using a network connection are delivered directly to the Web container using an optimized communication path. The optimized communication path is available because the Web services client application and the Web container are running in the same process.

The optimized communication path cannot be used if the Web services client and Web service provider are running on different servers.

The optimized communication path is applicable to Web services clients sending requests to Web services that are in running on the same JVM. The optimized communication path always routes the request to a service on the same JVM. In this case, the Web service's virtual host needs to have an alias for localhost and the specific port specified. For example, if you want a Web services client to send a request to a Web service available at an endpoint URL, such as http://localhost:9080/Hello/HelloWorldService and use the optimized communication between client and service, then in addition to enabling the property (setting enableInProcessConnections = true), you would have to create an alias for "localhost" and "9080" for the virtual host that the Web service is using.

The Web services client uses the defined virtual host information to determine whether the request can be served by the local Web container. You must define unique values for the host and port on each application server. You cannot define the values of host and port as wild cards denoted by the asterisk symbol (*) when you enable the optimized communication between the Web services application and the Web container. Using wild cards indicate that the local Web container can handle Web services requests for all destinations.

This optimized communication path is disabled by default. Before enabling this property, make sure that you are not using wild cards for host names in your Web container end points and make sure that wild cards are not specified for the Web container ports. Use specific ports for the Web container when the optimized communication path is enabled. To enable the optimized communication path, use the following name-value pair:

Name Value
enableInProcessConnections true

Refer to the Web services client to Web container optimized communication article for additional information.

fileServingEnabled, directoryBrowsingEnabled, and serveServletsByClassnameEnabled

fileServingEnabled, directoryBrowsingEnabled, and similar properties are global settings for internal servlets. Web application archive (WAR) files that are packaged using third-party tools cannot specify behavior for the services that are exposed by the Web container internal servlets. You can globally enable and disable internal servlets for all Web applications at the Web container level by creating name-value pairs.

Name Value
fileServingEnabled true
directoryBrowsingEnabled true
serveServletsByClassnameEnabled true

Settings that are defined in an assembly tool take precedence over the global settings that are set through the custom properties at the Web container level.

Web application deployment extensions continue to hold configuration information for the services that are provided by the internal servlets, and take precedence over the global settings that are set through the custom properties at the Web container level.

ForceSessionIdLengthCheck

[Fix Pack 7 or later]

Newly generated session IDs are, by default, 23 characters in length, unless you use the HttpSessionIdLength custom property to specify a different maximum length for your session IDs.

When an incoming request has a session ID that is longer than the expected session ID length, and whose prefix is identical to a pre-existing session ID, the longer ID is used to return a new session. If the length of the session ID on the incoming request is significantly larger then the maximum length specified for your system, such that it exceeds the width of the ID column in the the session table column that is used in database persistence, an SQL0302 error occurs.

To prevent the occurrence of these SQL0302 errors, you can add the ForceSessionIdLengthCheck custom property to your Web container custom properties and set it to true. When this custom property is set to true, the length of a session ID cannot exceed 23 characters. If an incoming request has a session ID that is longer than 23 characters, the first 23 characters are used to return a new session.

Name Value
ForceSessionIdLengthCheck true

ForceSessionInvalidationMultiple

The ForceSessionInvalidationMultiple custom property indicates whether the session manager should wait indefinitely for a request to complete before attempting to invalidate the session, or attempt to invalidate a session after the specified time limit has elapsed. The default value for this property is 1.

Name Value
ForceSessionInvalidationMultiple 1

httpsIndicatorHeader

The custom property httpsIndicatorHeader manages HTTPS requests that are forwarded to an application server from an SSL offloader that is used in front of WebSphere Application Server. When an HTTPS request is received by a SSL offloader it is redirected over HTTP to an application server using WebSphere Application Server. The SSL offloader adds a header indicating the original request was over HTTP. The httpsIndicatorHeader property specifies the header name added by the SSL box. The application server checks this indicator to determine if SSL is required. If it determines the request is SSL over HTTP, an HTTPS scheme is chosen.

Name Value
httpsIndicatorHeader Request header key name

HttpSessionIdReuse

The custom property HttpSessionIdReuse determines whether the session manager can use the session ID sent from a browser to preserve session data across Web applications that are running in an environment that is not configured for session persistence. In a multi-JVM environment that is not configured for session persistence setting this property to true enables the session manager to use the same session information for all of a user's requests even if the Web applications that are handling these requests are governed by different JVMs. The default value for this property is false.

Note: The use of the HttpSessionIdReuse property as a Web container custom property is deprecated. You can now define it as a session management custom property.

To enable the session manager ton use the session ID sent from a browser to preserve session data across Web applications that are running in an environment that is not configured for session persistence, use the following name-value pair:

Name Value
HttpSessionIdReuse true

listeners

The servlet specification supports applications registering listeners for servlet-related events on an individual application basis through the web.xml descriptor. However, using the listeners custom property, a server can listen to servlet events across Web applications. To implement global listening, a listener is registered at the Web container level and is propagated to all of the installed and new Web applications. This global behavior of internal servlet listeners is controlled by the listeners custom property by using the following name-value pair format.

Name Value
listeners listener_class

The values for this property is a string specifying a comma separated list of listener classes. The listener supplied must implement standard listener classes from the Java Servlet API or IBM® listener extension classes.

MutualAuthCBindCheck

[z/OS]

This property is only valid on the z/OS platform. Use the MutualAuthCBindCheck property to specify whether or not a client certificate should be resolved to a SAF principal.

Use the MutualAuthCBindCheck property to specify whether or not a client certificate should be resolved to a SAF principal. If this property is set to true, all SSL connections from a browser must have a client certificate, and the user ID associated with that client certificate must have RACF CONTROL authority for CB.BIND.servername. Regardless whether client certificate authentication is being used in a SSL connection or not, if these conditions are not met, the connection will be closed. Issue the following RACF command to give the user ID associated with that client certificate RACF CONTROL authority:

PERMIT CB.BIND.<optional SAF profile prefix>.clustername CLASS(CBIND) ID(clientCertUserid) ACCESS(CONTROL)
Data type String
Value true or false
Default false
Avoid trouble: You can use HTTP transports on a V5.1 node in a mixed WebSphere Application Server environment. Refer to the HTTP transport custom properties topic for a description of these properties. However, you must use HTTP transport channels, instead of HTTP transports, to handle your HTTP requests on all of your other nodes. Refer to the HTTP transport channel custom properties topic for a description of the custom properties that you can specify for an HTTP transport channel.gotcha

prependSlashToResource

WebSphere Application Server 5.x supports Uniform Resource Locators (URLs) without leading front slashes ( / ) and to preserve compatibility, You can set the custom property, prependSlashToResource to true. To ignore the specification and consider URLs without the leading front slash, use the following name-value pair.

Name Value
prependSlashToResource true

trusted

The trusted custom property enables the application server to use inbound private headers from the Web server plug-in. These inbound private headers notify the application server about the connection to the Web server. When you set the custom property to true, the application server uses the asserted information on the client certificates. These client certificates are used by the end user to connect to the Web server and establish the client information, which is treated as the certificate for the end user. Then, the application server uses the certificate information for authentication purposes when client certificate authentication is used or when the application code accesses the javax.net.ssl.peer_certificates certificates. Because this information is asserted, it is insecure and potentially vulnerable to an attacker that is able to connect directly to the application server and bypass the Web server.

The default value for this property is true.

Important: If you allow direct connections to the application server and use client certificates, you need to set this custom property to false.
Name Value
trusted true

UseOracleBLOB

The UseOracleBLOB custom property creates the HTTP session database table using the Binary Large Object (BLOB) data type for the medium column. This property increases performance of persistent sessions when Oracle databases are used. Due to an Oracle restriction, BLOB support requires use of the oci database driver for Oracle for more than 4000 bytes of data. You must also ensure that a new sessions table is created before the server is restarted by dropping your old sessions table or by changing the datasource definition to reference a database that does not contain a sessions table.

Note: The use of the UseOracleBLOB property as a Web container custom property is deprecated. You can now define it as a session management custom property.

To create a sessions table using the BLOB data type, use the following name-value pair:

Name Value
UseOracleBLOB true



Related tasks
Modifying the default Web container configuration
Configuring transport chains
Related reference
HTTP transport custom properties
HTTP session problems
Web services client to Web container optimized communication
JavaServer Pages specific Web container custom properties
Web container custom properties
Reference topic    

Terms of Use | Feedback

Last updated: Oct 21, 2010 10:04:34 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=compass&product=was-nd-mp&topic=rweb_custom_props
File name: rweb_custom_props.html