uCosminexus Application Server, Web Container Functionality Guide

[Contents][Glossary][Index][Back][Next]

3.5.2 Proprietary context parameters of Application Server

The following table describes proprietary context parameters of Application Server.

Table 3-11 Proprietary context parameters of Application Server

Parameter name Date type Specifiable value Behavior when an invalid value is specified Default value Explanation
com.sun.faces.clientStateTimeout Long -9223372036854775808
to 9223372036854775807
Timeout does not work. Timeout does not work. Specifies the timeout value for the view state. If the time consumed between the present view and the next view exceeds the timeout value, the next view is not displayed, and javax.faces.application.ViewExpiredException is thrown. This parameter is enabled if the value of javax.faces.STATE_SAVING_METHOD is "client". If this parameter is not set, the timeout does not occur. The parameter value + 1 is considered as the valid timeout value.
For example, if you set the parameter value as 0, the timeout occurs in 1 minute. If you specify a negative value, the view is definitely disabled after submit.
com.sun.faces.disableUnicodeEscaping#1 String auto, true, or false false auto Determines the output method for non-ASCII characters of the response page to be returned to the client. There are two types of output methods of non-ASCII characters, either output the characters as it is or output as the character reference.
The encoding set in the response page has an impact on this functionality. The extent of the impact of this functionality differs for JSP and Facelets respectively.
In JSP, characters specified in JSF tags (HTML tags or core tags) are targeted. While in Facelets, all the characters described in a page are targeted.
com.sun.faces.numberOfLogicalViews int 0 to 2147483647 15 15 Specifies the count of logical views. #2 This parameter is enabled if the value of javax.faces.STATE_SAVING_METHOD is "server". If you access a view that exceeds the value set in this parameter, the logical view that is not referenced for the longest period of time is replaced with the currently accessed logical view. The result page does not appear even if you submit the replaced view. If you set 0 in this parameter, the view is definitely disabled after you perform submit. If a negative value is set, the behavior differs for JSP and Facelets respectively.
In JSP, although an exception occurs, the view is displayed and you can also submit the view. Note that you cannot save the view state.
In Facelets, an exception occurs and the view is not displayed.
com.sun.faces.numberOfViewsInSession int 0 to 2147483647 15 15 Specifies the number of view states that you can register in a logical view. #2 This parameter is enabled if the value of javax.faces.STATE_SAVING_METHOD is "server".
If you submit the same view for a number of times more than the value set in this parameter, the state of the view that is not referenced for the longest period of time is replaced with the state of the currently accessed view. The result page does not appear even if you submit the view that has the replaced state.
If you set 0 in this parameter, the view is definitely disabled after you perform submit. If you set a negative value, the behavior differs for JSP and the Facelets.
In JSP, although an exception occurs, the view is displayed and you can also submit the view. Note that you cannot save the view state.
In Facelets, an exception occurs and the view is not displayed.

#1
The following table describes the mapping between the values set for the com.sum.faces.disableUnicode.Escaping parameter and the output of the response page.

Table 3-12 Mapping between the values set for the com.sum.faces.disableUnicode.Escaping parameter and the output of the response page

Value set for the com.sun.faces.disableUnicodeEscaping Response page encoding is in UTF, or ISO-8859-1 Response page encoding is other than UTF, or ISO-8859-1
true Character Character
false Character reference Character reference
auto Character Character reference

#2
The Logical view indicates response pages saved by the JSF. A logical view is used to identify the views accessed so far by the client. A logical view is created when the client accesses a view. The logical view also holds the view states. A view state is incremented by one every time you submit the same view.
The following figure shows the relationship of the view and the values specified for numberOfLogicalViews and numberOfViewsInSession.

Figure 3-2 2Relationship of the view and the values specified for numberOfLogicalViews and numberOfViewsInSession

[Figure]

The number of states specified for numberOfViewsInSession is stored for each logical view included in the number of logical views specified in numberOfLogicalViews.

When a client machine submits a value to the server machine, the server machine saves a new state of the view. Note that a state indicates the information about the UI components defined in a logical view.

In JSF, the window information (View state) of Facelets files created by the user or HTML pages created based on JSP files and the objects of the ManagedBean class that define SessionScope, are registered in the HTTP session.