Module org.omnifaces
Package org.omnifaces.config

Class OmniFaces

java.lang.Object
org.omnifaces.config.OmniFaces
public final class OmniFaces extends Object
Collection of constants and utility methods for OmniFaces internals.
Since:
2.5
Author:
Bauke Scholtz

  • Field Details

    • OMNIFACES_LIBRARY_NAME

      public static final String OMNIFACES_LIBRARY_NAME
      Returns the "omnifaces" resource library name.
      See Also:

    • OMNIFACES_SCRIPT_NAME

      public static final String OMNIFACES_SCRIPT_NAME
      Returns the "omnifaces.js" main script name.
      See Also:

    • OMNIFACES_EVENT_PARAM_NAME

      public static final String OMNIFACES_EVENT_PARAM_NAME
      Returns the "omnifaces.event" request parameter name.
      See Also:

    • OMNIFACES_DYNAMIC_FORM_ID

      public static final String OMNIFACES_DYNAMIC_FORM_ID
      Returns the "omnifaces_form" ID of dynamic form.
      See Also:

    • PARAM_NAME_SKIP_DEPLOYMENT_EXCEPTION

      public static final String PARAM_NAME_SKIP_DEPLOYMENT_EXCEPTION
      The boolean context parameter name to skip any OmniFaces deployment exception. If this is set to true, then any exception thrown by ApplicationInitializer, ApplicationListener and ApplicationProcessor will be suppressed and won't anymore block the deployment of the web application.
      Since:
      3.14
      See Also:

  • Method Details

    • getVersion

      public static String getVersion()
      Returns OmniFaces version. This is extracted from Implementation-Version field of /META-INF/MANIFEST.MF file of omnifaces.jar file. Release versions will return version in format 3.4.2. Snapshot versions will return version in format 3.4.2-SNAPSHOT. Local development versions (because MANIFEST.MF entry is missing) will return version in format DEV-SNAPSHOT.
      Returns:
      OmniFaces version.

    • isSnapshot

      public static boolean isSnapshot()
      Returns whether current OmniFaces version is a SNAPSHOT or RC version.
      Returns:
      Whether current OmniFaces version is a SNAPSHOT or RC version.

    • getStartupTime

      public static long getStartupTime()
      Returns startup time in Epoch milli.
      Returns:
      Startup time in Epoch milli.

    • getMessage

      public static String getMessage(String key)
      Returns resource bundle message associated with given key from application message bundle as identified by <message-bundle> in faces-config.xml, or if it is absent, then return it from OmniFaces internal org.omnifaces.messages bundle.
      Parameters:
      key - The message bundle key.
      Returns:
      Resource bundle message associated with given key.

    • skipDeploymentException

      public static boolean skipDeploymentException(ServletContext servletContext)
      Returns whether the context parameter "org.omnifaces.SKIP_DEPLOYMENT_EXCEPTION" is set to true. If this is set to true, then any exception thrown by ApplicationInitializer, ApplicationListener and ApplicationProcessor will be suppressed and won't anymore block the deployment of the web application.
      Parameters:
      servletContext - The involved servlet context.
      Returns:
      whether the context parameter "org.omnifaces.SKIP_DEPLOYMENT_EXCEPTION" is set to true.
      Since:
      3.14