Package org.joinfaces.autoconfigure.javaxfaces

Class JavaxFaces2_3Properties

  • All Implemented Interfaces:
    ServletContextInitParameterProperties
    @ConfigurationProperties(prefix="joinfaces.jsf")
public class JavaxFaces2_3Properties
extends java.lang.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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      java.lang.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.
      java.lang.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.
      java.lang.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(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object).
      java.lang.Boolean getEnableWebsocketEndpoint()
      The boolean context parameter name to explicitly enable web socket endpoint during startup.
      java.lang.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.
      java.lang.Integer getWebsocketEndpointPort()
      The integer context parameter name to specify the websocket endpoint port when it's different from HTTP port.
      int hashCode()  
      void setAlwaysPerformValidationWhenRequiredIsTrue​(java.lang.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​(java.lang.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​(java.lang.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(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object).
      void setEnableWebsocketEndpoint​(java.lang.Boolean enableWebsocketEndpoint)
      The boolean context parameter name to explicitly enable web socket endpoint during startup.
      void setViewrootPhaseListenerQueuesExceptions​(java.lang.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​(java.lang.Integer websocketEndpointPort)
      The integer context parameter name to specify the websocket endpoint port when it's different from HTTP port.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • JavaxFaces2_3Properties

        public JavaxFaces2_3Properties()

    • Method Detail

      • getAlwaysPerformValidationWhenRequiredIsTrue

        public java.lang.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(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object).

      • getEnableWebsocketEndpoint

        public java.lang.Boolean getEnableWebsocketEndpoint()
        The boolean context parameter name to explicitly enable web socket endpoint during startup.

      • getWebsocketEndpointPort

        public java.lang.Integer getWebsocketEndpointPort()
        The integer context parameter name to specify the websocket endpoint port when it's different from HTTP port.

      • getDisableFacesservletToXhtml

        public java.lang.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 java.lang.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 java.lang.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(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object).
        Since:
        2.3

      • setAlwaysPerformValidationWhenRequiredIsTrue

        public void setAlwaysPerformValidationWhenRequiredIsTrue​(java.lang.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(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object).

      • setEnableWebsocketEndpoint

        public void setEnableWebsocketEndpoint​(java.lang.Boolean enableWebsocketEndpoint)
        The boolean context parameter name to explicitly enable web socket endpoint during startup.

      • setWebsocketEndpointPort

        public void setWebsocketEndpointPort​(java.lang.Integer websocketEndpointPort)
        The integer context parameter name to specify the websocket endpoint port when it's different from HTTP port.

      • setDisableFacesservletToXhtml

        public void setDisableFacesservletToXhtml​(java.lang.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​(java.lang.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​(java.lang.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(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object).
        Since:
        2.3

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object