Package org.joinfaces.autoconfigure.faces

Class JakartaFaces3Properties

java.lang.Object

org.joinfaces.autoconfigure.faces.JakartaFaces3Properties

All Implemented Interfaces:

ServletContextInitParameterProperties

@ConfigurationProperties("joinfaces.jsf")
public class JakartaFaces3Properties
extends Object
implements ServletContextInitParameterProperties

Configuration properties for JSF 3.0.

See Also:

• https://jakarta.ee/specifications/faces/3.0/jakarta-faces-3.0.html#a6088

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JakartaFaces3Properties.ValidatorProperties	Valitador class for disableDefaultBeanValidator parameter.

Constructor Summary

Constructors

Constructor	Description
JakartaFaces3Properties()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Boolean	getAlwaysPerformValidationWhenRequiredIsTrue()	If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, validation must be performed, even when there is no corresponding value for this component in the incoming request.
String	getClientWindowMode()	The context-param that controls the operation of the ClientWindow feature.
List<String>	getConfigFiles()	Comma-delimited list of context-relative resource paths under which the Jakarta Faces implementation will look for application configuration resources (see Application Configuration Resource Format), before loading a configuration resource named “/WEB-INF/faces-config.xml” (if such a resource exists).
Boolean	getDatetimeconverterDefaultTimezoneIsSystemTimezone()	Controls if DateTimeConverter instances use the system timezone (if true) or GMT (if false).
String	getDefaultSuffix()	Allow the web application to define an alternate suffix for Jakarta Server Pages pages containing Jakarta Faces content.
Boolean	getDisableFaceletJsfViewhandler()	If this param is set, and true, the default ViewHandler must behave as specified in the latest 1.2 version of this specification.
Boolean	getDisableFacesservletToXhtml()	The ServletContext init parameter consulted by the runtime to tell if the automatic mapping of the FacesServlet to the extension *.xhtml should be disabled.
Boolean	getEnableWebsocketEndpoint()	The boolean context parameter name to explicitly enable web socket endpoint during startup.
Integer	getFaceletsBufferSize()	The buffer size set on the response.
List<Class<? extends jakarta.faces.view.facelets.TagDecorator>>	getFaceletsDecorators()	TagDecorator implementations.
List<String>	getFaceletsLibraries()	Semicolon-separated list of paths to Facelet tag libraries.
Integer	getFaceletsRefreshPeriod()	Time in seconds that facelets should be checked for changes since last request.
Class<? extends jakarta.faces.view.facelets.ResourceResolver>	getFaceletsResourceResolver()	An implementation of javax.faces.view.facelets.ResourceResolver.
Boolean	getFaceletsSkipComments()	If true, strip XML comments out of Facelets before delivering to the client.
String	getFaceletsSuffix()	Set the suffix for Facelet xhtml files.
List<String>	getFaceletsViewMappings()	Semicolon-separated list of Facelet files that don't use the default facelets suffix.
List<String>	getFullStateSavingViewIds()	Semicolon-separated list of view IDs that must save state using the JSF 1.2-style state saving.
Boolean	getHonorCurrentComponentAttributes()	The ServletContext init parameter consulted by the UIComponent to tell whether or not the UIComponent.CURRENT_COMPONENT and UIComponent.CURRENT_COMPOSITE_COMPONENT attribute keys should be honored as specified.
Boolean	getInterpretEmptyStringSubmittedValuesAsNull()	If true, consider empty UIInput values to be null instead of empty string.
String	getLifecycleId()	ID for alternate Lifecycle implementations.
Boolean	getPartialStateSaving()	If true, use the JSF2 partial state saving for views.
jakarta.faces.application.ProjectStage	getProjectStage()	Set the project stage to "Development", "UnitTest", "SystemTest", or "Production".
List<String>	getResourceExcludes()	A space separated list of resource extensions for types that shouldn't be served by the ResourceHandler implementation.
String	getSeparatorChar()	The context-param that allows the separator char for clientId strings to be set on a per-web application basis.
Boolean	getSerializeServerState()	If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable.
String	getStateSavingMethod()	"server" or "client".
String	getValidateEmptyFields()	If "true", validate null and empty values.
JakartaFaces3Properties.ValidatorProperties	getValidator()
Boolean	getViewrootPhaseListenerQueuesExceptions()	If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, exceptions thrown by PhaseListeners installed on the UIViewRoot are queued to the ExceptionHandler instead of being logged and swallowed.
String	getWebappContractsDirectory()	If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resource library contracts are to be located.
String	getWebappResourcesDirectory()	If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resources are to be located.
Integer	getWebsocketEndpointPort()	The integer context parameter name to specify the websocket endpoint port when it's different from HTTP port.
int	hashCode()
void	setAlwaysPerformValidationWhenRequiredIsTrue(Boolean alwaysPerformValidationWhenRequiredIsTrue)	If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, validation must be performed, even when there is no corresponding value for this component in the incoming request.
void	setClientWindowMode(String clientWindowMode)	The context-param that controls the operation of the ClientWindow feature.
void	setConfigFiles(List<String> configFiles)	Comma-delimited list of context-relative resource paths under which the Jakarta Faces implementation will look for application configuration resources (see Application Configuration Resource Format), before loading a configuration resource named “/WEB-INF/faces-config.xml” (if such a resource exists).
void	setDatetimeconverterDefaultTimezoneIsSystemTimezone(Boolean datetimeconverterDefaultTimezoneIsSystemTimezone)	Controls if DateTimeConverter instances use the system timezone (if true) or GMT (if false).
void	setDefaultSuffix(String defaultSuffix)	Allow the web application to define an alternate suffix for Jakarta Server Pages pages containing Jakarta Faces content.
void	setDisableFaceletJsfViewhandler(Boolean disableFaceletJsfViewhandler)	If this param is set, and true, the default ViewHandler must behave as specified in the latest 1.2 version of this specification.
void	setDisableFacesservletToXhtml(Boolean disableFacesservletToXhtml)	The ServletContext init parameter consulted by the runtime to tell if the automatic mapping of the FacesServlet to the extension *.xhtml should be disabled.
void	setEnableWebsocketEndpoint(Boolean enableWebsocketEndpoint)	The boolean context parameter name to explicitly enable web socket endpoint during startup.
void	setFaceletsBufferSize(Integer faceletsBufferSize)	The buffer size set on the response.
void	setFaceletsDecorators(List<Class<? extends jakarta.faces.view.facelets.TagDecorator>> faceletsDecorators)	TagDecorator implementations.
void	setFaceletsLibraries(List<String> faceletsLibraries)	Semicolon-separated list of paths to Facelet tag libraries.
void	setFaceletsRefreshPeriod(Integer faceletsRefreshPeriod)	Time in seconds that facelets should be checked for changes since last request.
void	setFaceletsResourceResolver(Class<? extends jakarta.faces.view.facelets.ResourceResolver> faceletsResourceResolver)	An implementation of javax.faces.view.facelets.ResourceResolver.
void	setFaceletsSkipComments(Boolean faceletsSkipComments)	If true, strip XML comments out of Facelets before delivering to the client.
void	setFaceletsSuffix(String faceletsSuffix)	Set the suffix for Facelet xhtml files.
void	setFaceletsViewMappings(List<String> faceletsViewMappings)	Semicolon-separated list of Facelet files that don't use the default facelets suffix.
void	setFullStateSavingViewIds(List<String> fullStateSavingViewIds)	Semicolon-separated list of view IDs that must save state using the JSF 1.2-style state saving.
void	setHonorCurrentComponentAttributes(Boolean honorCurrentComponentAttributes)	The ServletContext init parameter consulted by the UIComponent to tell whether or not the UIComponent.CURRENT_COMPONENT and UIComponent.CURRENT_COMPOSITE_COMPONENT attribute keys should be honored as specified.
void	setInterpretEmptyStringSubmittedValuesAsNull(Boolean interpretEmptyStringSubmittedValuesAsNull)	If true, consider empty UIInput values to be null instead of empty string.
void	setLifecycleId(String lifecycleId)	ID for alternate Lifecycle implementations.
void	setPartialStateSaving(Boolean partialStateSaving)	If true, use the JSF2 partial state saving for views.
void	setProjectStage(jakarta.faces.application.ProjectStage projectStage)	Set the project stage to "Development", "UnitTest", "SystemTest", or "Production".
void	setResourceExcludes(List<String> resourceExcludes)	A space separated list of resource extensions for types that shouldn't be served by the ResourceHandler implementation.
void	setSeparatorChar(String separatorChar)	The context-param that allows the separator char for clientId strings to be set on a per-web application basis.
void	setSerializeServerState(Boolean serializeServerState)	If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable.
void	setStateSavingMethod(String stateSavingMethod)	"server" or "client".
void	setValidateEmptyFields(String validateEmptyFields)	If "true", validate null and empty values.
void	setViewrootPhaseListenerQueuesExceptions(Boolean viewrootPhaseListenerQueuesExceptions)	If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, exceptions thrown by PhaseListeners installed on the UIViewRoot are queued to the ExceptionHandler instead of being logged and swallowed.
void	setWebappContractsDirectory(String webappContractsDirectory)	If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resource library contracts are to be located.
void	setWebappResourcesDirectory(String webappResourcesDirectory)	If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resources are to be located.
void	setWebsocketEndpointPort(Integer websocketEndpointPort)	The integer context parameter name to specify the websocket endpoint port when it's different from HTTP port.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

JakartaFaces3Properties

public JakartaFaces3Properties()

Method Details

getAlwaysPerformValidationWhenRequiredIsTrue

public Boolean getAlwaysPerformValidationWhenRequiredIsTrue()

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, validation must be performed, even when there is no corresponding value for this component in the incoming request.

Since:

2.3

See Also:

• UIInput.ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE
• BeanValidator.validate(FacesContext, UIComponent, Object)

getClientWindowMode

public String getClientWindowMode()

The context-param that controls the operation of the ClientWindow feature. The runtime must support the values "none" and "url", without the quotes, but other values are possible. If not specified, or the value is not understood by the implementation, "none" is assumed.

Since:

2.2

See Also:

• ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME

getConfigFiles

public List<String> getConfigFiles()

Comma-delimited list of context-relative resource paths under which the Jakarta Faces implementation will look for application configuration resources (see Application Configuration Resource Format), before loading a configuration resource named “/WEB-INF/faces-config.xml” (if such a resource exists). If “/WEB-INF/faces-config.xml” is present in the list, it must be ignored.

See Also:

• FacesServlet.CONFIG_FILES_ATTR

getDatetimeconverterDefaultTimezoneIsSystemTimezone

public Boolean getDatetimeconverterDefaultTimezoneIsSystemTimezone()

Controls if DateTimeConverter instances use the system timezone (if true) or GMT (if false). If this param is set, and true, Application.createConverter() must guarantee that the default for the timezone of all DateTimeConverter instances must be equal to TimeZone.getDefault() instead of “GMT”.

getDefaultSuffix

public String getDefaultSuffix()

Allow the web application to define an alternate suffix for Jakarta Server Pages pages containing Jakarta Faces content.

See Also:

• ViewHandler.DEFAULT_SUFFIX_PARAM_NAME

getDisableFaceletJsfViewhandler

public Boolean getDisableFaceletJsfViewhandler()

If this param is set, and true, the default ViewHandler must behave as specified in the latest 1.2 version of this specification. Any behavior specified in Default ViewDeclarationLanguage Implementation and implemented in the default ViewHandler that pertains to handling requests for pages authored in the Jakarta Server Faces View Declaration Language must not be executed by the runtime. For backward compatibility with previous versions of Facelets, the value DISABLE_FACELET_JSF_VIEWHANDLER must be supported.

getDisableFacesservletToXhtml

public Boolean getDisableFacesservletToXhtml()

The ServletContext init parameter consulted by the runtime to tell if the automatic mapping of the FacesServlet to the extension *.xhtml should be disabled. The implementation must disable this automatic mapping if and only if the value of this parameter is equal, ignoring case, to true.

If this parameter is not specified, this automatic mapping is enabled as specified above.

Since:

2.3

getFaceletsLibraries

public List<String> getFaceletsLibraries()

Semicolon-separated list of paths to Facelet tag libraries.

getFaceletsBufferSize

public Integer getFaceletsBufferSize()

The buffer size set on the response.

getFaceletsDecorators

public List<Class<? extends jakarta.faces.view.facelets.TagDecorator>> getFaceletsDecorators()

TagDecorator implementations. See javadoc for javax.faces.view.facelets.TagDecorator.

getFaceletsRefreshPeriod

public Integer getFaceletsRefreshPeriod()

Time in seconds that facelets should be checked for changes since last request. A value of -1 disables refresh checking.

getFaceletsResourceResolver

public Class<? extends jakarta.faces.view.facelets.ResourceResolver> getFaceletsResourceResolver()

An implementation of javax.faces.view.facelets.ResourceResolver. See javadoc for details.

getFaceletsSkipComments

public Boolean getFaceletsSkipComments()

If true, strip XML comments out of Facelets before delivering to the client.

getFaceletsSuffix

public String getFaceletsSuffix()

Set the suffix for Facelet xhtml files.

getFaceletsViewMappings

public List<String> getFaceletsViewMappings()

Semicolon-separated list of Facelet files that don't use the default facelets suffix.

getFullStateSavingViewIds

public List<String> getFullStateSavingViewIds()

Semicolon-separated list of view IDs that must save state using the JSF 1.2-style state saving.

getHonorCurrentComponentAttributes

public Boolean getHonorCurrentComponentAttributes()

The ServletContext init parameter consulted by the UIComponent to tell whether or not the UIComponent.CURRENT_COMPONENT and UIComponent.CURRENT_COMPOSITE_COMPONENT attribute keys should be honored as specified.

If this parameter is not specified, or is set to false, the contract specified by the UIComponent.CURRENT_COMPONENT and UIComponent.CURRENT_COMPOSITE_COMPONENT method is not honored. If this parameter is set to true, the contract is honored.

getInterpretEmptyStringSubmittedValuesAsNull

public Boolean getInterpretEmptyStringSubmittedValuesAsNull()

If true, consider empty UIInput values to be null instead of empty string.

getLifecycleId

public String getLifecycleId()

ID for alternate Lifecycle implementations.

getPartialStateSaving

public Boolean getPartialStateSaving()

If true, use the JSF2 partial state saving for views.

getProjectStage

public jakarta.faces.application.ProjectStage getProjectStage()

Set the project stage to "Development", "UnitTest", "SystemTest", or "Production".

getResourceExcludes

public List<String> getResourceExcludes()

A space separated list of resource extensions for types that shouldn't be served by the ResourceHandler implementation. See the specification for further details.

getSeparatorChar

public String getSeparatorChar()

The context-param that allows the separator char for clientId strings to be set on a per-web application basis.

Since:

2.0

getSerializeServerState

public Boolean getSerializeServerState()

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable. The intent of this parameter is to ensure that the act of writing out the state to an ObjectOutputStream would not throw a NotSerializableException, but the runtime is not required verify this before saving the state.

getStateSavingMethod

public String getStateSavingMethod()

"server" or "client".

getValidateEmptyFields

public String getValidateEmptyFields()

If "true", validate null and empty values. If "auto" validate when JSR-303 Bean Validation is enabled (in AS6 it is enabled by default).

getValidator

public JakartaFaces3Properties.ValidatorProperties getValidator()

getViewrootPhaseListenerQueuesExceptions

public Boolean getViewrootPhaseListenerQueuesExceptions()

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, exceptions thrown by PhaseListeners installed on the UIViewRoot are queued to the ExceptionHandler instead of being logged and swallowed.

Since:

2.3

getEnableWebsocketEndpoint

public Boolean getEnableWebsocketEndpoint()

The boolean context parameter name to explicitly enable web socket endpoint during startup.

getWebsocketEndpointPort

public Integer getWebsocketEndpointPort()

The integer context parameter name to specify the websocket endpoint port when it's different from HTTP port.

getWebappResourcesDirectory

public String getWebappResourcesDirectory()

If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resources are to be located. This param value must not start with a "/", though it may contain "/" characters. If no such <context-param> exists, or its value is invalid, the value "resources", without the quotes, must be used by the runtime as the value.

Since:

2.2

getWebappContractsDirectory

public String getWebappContractsDirectory()

If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resource library contracts are to be located. This param value must not start with a "/", though it may contain "/" characters. If no such <context-param> exists, or its value is invalid, the value "contracts", without the quotes, must be used by the runtime as the value.

Since:

2.2

setAlwaysPerformValidationWhenRequiredIsTrue

public void setAlwaysPerformValidationWhenRequiredIsTrue(Boolean alwaysPerformValidationWhenRequiredIsTrue)

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, validation must be performed, even when there is no corresponding value for this component in the incoming request.

Since:

2.3

See Also:

• UIInput.ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE
• BeanValidator.validate(FacesContext, UIComponent, Object)

setClientWindowMode

public void setClientWindowMode(String clientWindowMode)

The context-param that controls the operation of the ClientWindow feature. The runtime must support the values "none" and "url", without the quotes, but other values are possible. If not specified, or the value is not understood by the implementation, "none" is assumed.

Since:

2.2

See Also:

• ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME

setConfigFiles

public void setConfigFiles(List<String> configFiles)

Comma-delimited list of context-relative resource paths under which the Jakarta Faces implementation will look for application configuration resources (see Application Configuration Resource Format), before loading a configuration resource named “/WEB-INF/faces-config.xml” (if such a resource exists). If “/WEB-INF/faces-config.xml” is present in the list, it must be ignored.

See Also:

• FacesServlet.CONFIG_FILES_ATTR

setDatetimeconverterDefaultTimezoneIsSystemTimezone

public void setDatetimeconverterDefaultTimezoneIsSystemTimezone(Boolean datetimeconverterDefaultTimezoneIsSystemTimezone)

Controls if DateTimeConverter instances use the system timezone (if true) or GMT (if false). If this param is set, and true, Application.createConverter() must guarantee that the default for the timezone of all DateTimeConverter instances must be equal to TimeZone.getDefault() instead of “GMT”.

setDefaultSuffix

public void setDefaultSuffix(String defaultSuffix)

Allow the web application to define an alternate suffix for Jakarta Server Pages pages containing Jakarta Faces content.

See Also:

• ViewHandler.DEFAULT_SUFFIX_PARAM_NAME

setDisableFaceletJsfViewhandler

public void setDisableFaceletJsfViewhandler(Boolean disableFaceletJsfViewhandler)

If this param is set, and true, the default ViewHandler must behave as specified in the latest 1.2 version of this specification. Any behavior specified in Default ViewDeclarationLanguage Implementation and implemented in the default ViewHandler that pertains to handling requests for pages authored in the Jakarta Server Faces View Declaration Language must not be executed by the runtime. For backward compatibility with previous versions of Facelets, the value DISABLE_FACELET_JSF_VIEWHANDLER must be supported.

setDisableFacesservletToXhtml

public void setDisableFacesservletToXhtml(Boolean disableFacesservletToXhtml)

The ServletContext init parameter consulted by the runtime to tell if the automatic mapping of the FacesServlet to the extension *.xhtml should be disabled. The implementation must disable this automatic mapping if and only if the value of this parameter is equal, ignoring case, to true.

If this parameter is not specified, this automatic mapping is enabled as specified above.

Since:

2.3

setFaceletsLibraries

public void setFaceletsLibraries(List<String> faceletsLibraries)

Semicolon-separated list of paths to Facelet tag libraries.

setFaceletsBufferSize

public void setFaceletsBufferSize(Integer faceletsBufferSize)

The buffer size set on the response.

setFaceletsDecorators

public void setFaceletsDecorators(List<Class<? extends jakarta.faces.view.facelets.TagDecorator>> faceletsDecorators)

TagDecorator implementations. See javadoc for javax.faces.view.facelets.TagDecorator.

setFaceletsRefreshPeriod

public void setFaceletsRefreshPeriod(Integer faceletsRefreshPeriod)

Time in seconds that facelets should be checked for changes since last request. A value of -1 disables refresh checking.

setFaceletsResourceResolver

public void setFaceletsResourceResolver(Class<? extends jakarta.faces.view.facelets.ResourceResolver> faceletsResourceResolver)

An implementation of javax.faces.view.facelets.ResourceResolver. See javadoc for details.

setFaceletsSkipComments

public void setFaceletsSkipComments(Boolean faceletsSkipComments)

If true, strip XML comments out of Facelets before delivering to the client.

setFaceletsSuffix

public void setFaceletsSuffix(String faceletsSuffix)

Set the suffix for Facelet xhtml files.

setFaceletsViewMappings

public void setFaceletsViewMappings(List<String> faceletsViewMappings)

Semicolon-separated list of Facelet files that don't use the default facelets suffix.

setFullStateSavingViewIds

public void setFullStateSavingViewIds(List<String> fullStateSavingViewIds)

Semicolon-separated list of view IDs that must save state using the JSF 1.2-style state saving.

setHonorCurrentComponentAttributes

public void setHonorCurrentComponentAttributes(Boolean honorCurrentComponentAttributes)

The ServletContext init parameter consulted by the UIComponent to tell whether or not the UIComponent.CURRENT_COMPONENT and UIComponent.CURRENT_COMPOSITE_COMPONENT attribute keys should be honored as specified.

If this parameter is not specified, or is set to false, the contract specified by the UIComponent.CURRENT_COMPONENT and UIComponent.CURRENT_COMPOSITE_COMPONENT method is not honored. If this parameter is set to true, the contract is honored.

setInterpretEmptyStringSubmittedValuesAsNull

public void setInterpretEmptyStringSubmittedValuesAsNull(Boolean interpretEmptyStringSubmittedValuesAsNull)

If true, consider empty UIInput values to be null instead of empty string.

setLifecycleId

public void setLifecycleId(String lifecycleId)

ID for alternate Lifecycle implementations.

setPartialStateSaving

public void setPartialStateSaving(Boolean partialStateSaving)

If true, use the JSF2 partial state saving for views.

setProjectStage

public void setProjectStage(jakarta.faces.application.ProjectStage projectStage)

Set the project stage to "Development", "UnitTest", "SystemTest", or "Production".

setResourceExcludes

public void setResourceExcludes(List<String> resourceExcludes)

A space separated list of resource extensions for types that shouldn't be served by the ResourceHandler implementation. See the specification for further details.

setSeparatorChar

public void setSeparatorChar(String separatorChar)

The context-param that allows the separator char for clientId strings to be set on a per-web application basis.

Since:

2.0

setSerializeServerState

public void setSerializeServerState(Boolean serializeServerState)

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable. The intent of this parameter is to ensure that the act of writing out the state to an ObjectOutputStream would not throw a NotSerializableException, but the runtime is not required verify this before saving the state.

setStateSavingMethod

public void setStateSavingMethod(String stateSavingMethod)

"server" or "client".

setValidateEmptyFields

public void setValidateEmptyFields(String validateEmptyFields)

If "true", validate null and empty values. If "auto" validate when JSR-303 Bean Validation is enabled (in AS6 it is enabled by default).

setViewrootPhaseListenerQueuesExceptions

public void setViewrootPhaseListenerQueuesExceptions(Boolean viewrootPhaseListenerQueuesExceptions)

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, exceptions thrown by PhaseListeners installed on the UIViewRoot are queued to the ExceptionHandler instead of being logged and swallowed.

Since:

2.3

setEnableWebsocketEndpoint

public void setEnableWebsocketEndpoint(Boolean enableWebsocketEndpoint)

The boolean context parameter name to explicitly enable web socket endpoint during startup.

setWebsocketEndpointPort

public void setWebsocketEndpointPort(Integer websocketEndpointPort)

The integer context parameter name to specify the websocket endpoint port when it's different from HTTP port.

setWebappResourcesDirectory

public void setWebappResourcesDirectory(String webappResourcesDirectory)

If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resources are to be located. This param value must not start with a "/", though it may contain "/" characters. If no such <context-param> exists, or its value is invalid, the value "resources", without the quotes, must be used by the runtime as the value.

Since:

2.2

setWebappContractsDirectory

public void setWebappContractsDirectory(String webappContractsDirectory)

If a <context-param> with the param name equal to the value of ResourceHandler.WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME exists, the runtime must interpret its value as a path, relative to the web app root, where resource library contracts are to be located. This param value must not start with a "/", though it may contain "/" characters. If no such <context-param> exists, or its value is invalid, the value "contracts", without the quotes, must be used by the runtime as the value.

Since:

2.2

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object