Package org.joinfaces.autoconfigure.javaxfaces

Class JavaxFaces2_3Properties

java.lang.Object

org.joinfaces.autoconfigure.javaxfaces.JavaxFaces2_3Properties

All Implemented Interfaces:

ServletContextInitParameterProperties

@ConfigurationProperties(prefix="joinfaces.jsf")
public class JavaxFaces2_3Properties
extends Object
implements ServletContextInitParameterProperties

Configuration properties for JSF 2.3. JavaxFaces standard properties. Taken from https://javaee.github.io/javaee-spec/javadocs/constant-values.html#javax.faces and WebConfiguration class

See Also:

• JSR-344

Constructor Summary

Constructors

Constructor	Description
JavaxFaces2_3Properties()

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.
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	getEnableValidateWholeBean()	If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true take the additional actions relating to <validateWholeBean /> specified in BeanValidator.validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object).
Boolean	getEnableWebsocketEndpoint()	The boolean context parameter name to explicitly enable web socket endpoint during startup.
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.
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	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	setEnableValidateWholeBean(Boolean enableValidateWholeBean)	If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true take the additional actions relating to <validateWholeBean /> specified in BeanValidator.validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object).
void	setEnableWebsocketEndpoint(Boolean enableWebsocketEndpoint)	The boolean context parameter name to explicitly enable web socket endpoint during startup.
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	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

JavaxFaces2_3Properties

public JavaxFaces2_3Properties()

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. See BeanValidator.validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object).

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.

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.

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

getEnableValidateWholeBean

public Boolean getEnableValidateWholeBean()

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true take the additional actions relating to <validateWholeBean /> specified in BeanValidator.validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object).

Since:

2.3

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. See BeanValidator.validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object).

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.

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.

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

setEnableValidateWholeBean

public void setEnableValidateWholeBean(Boolean enableValidateWholeBean)

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true take the additional actions relating to <validateWholeBean /> specified in BeanValidator.validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object).

Since:

2.3

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