Orbeon Forms
Search
⌃K

Caches

Caches used by Orbeon Forms

Orbeon Forms uses caches for the following purposes:
  • Form state
    • This includes form data and other form state as the user interacts with a form.
    • This cache acts as a store.
    • This must be replicated when replication is enabled.
  • Mapping of some web resources
  • Caching of form definition metadata in the persistence layer
    • [SINCE Orbeon Forms 2023.1]
    • This is a true cache, which doesn't need to be replicated.

Supported cache implementations

Orbeon Forms has traditionally used Ehcache 2.x. In recent versions, JCache API (JSR-107) support has been added.
Orbeon Forms Version
Ehcache 2.x Support
JCache Support
Default
2023.1 and newer
Yes
Yes
Ehcache 2.x
2022.1.5 and newer
Yes
Yes
Ehcache 2.x
2021.1.9 and newer
Yes
Yes
Ehcache 2.x
2022.1.4 and earlier
Yes
No
Ehcache 2.x
2021.1.8 and earlier
Yes
No
Ehcache 2.x
2020.1.x and earlier
Yes
No
Ehcache 2.x

Using the default Ehcache 2.x configuration

By default, the following property is set and enables Ehcache 2.x:
<property
as="xs:string"
name="oxf.xforms.cache.provider"
value="ehcache2"/>
An internal ehcache.xml configuration file is used. Here is the file as of Orbeon Forms 2022.1.4.
You can update that configuration by placing your own ehcache.xml file in the WEB-INF/resources/config directory of your web app. This is rarely needed, except for enabling replication.

Enabling JCache providers

With the Orbeon Forms versions that support it, you can enable JCache support with the following:
<property
as="xs:string"
name="oxf.xforms.cache.provider"
value="jcache"/>
When this is set to jcache, Orbeon Forms uses the default caching provider as provided by the JCache API. This means that you must provide, in the Orbeon Forms web app, your own JCache-compatible implementation. Orbeon Forms comes by default with Ehcache 3.x as implementation, but you do not have to use Ehcache 3.x.
You can further specify the configuration to use with the following properties:
<property as="xs:string" name="oxf.xforms.cache.jcache.classname" value=""/>
<property as="xs:string" name="oxf.xforms.cache.jcache.resource" value=""/>
<property as="xs:string" name="oxf.xforms.cache.jcache.uri" value=""/>
  • oxf.xforms.cache.jcache.classname specifies a regular expression that must match the provider fully-qualified class name. This is useful in case there is more than one cache provider in the classpath and you need to select a specific one.
  • oxf.xforms.cache.jcache.resource specifies the path to a webapp resource. The configuration can be stored under the web app's WEB-INF or a JAR file included in the webapp.
  • oxf.xforms.cache.jcache.uri specifies the URI to a configuration.
Example:
<property
as="xs:string"
name="oxf.xforms.cache.jcache.classname"
value=".*EhcacheCachingProvider"/>
The resource property is checked first, then the uri property. A blank property is ignored.
For example, to point to the built-in Ehcache 3.x configuration, set:
<property
as="xs:string"
name="oxf.xforms.cache.resource"
value="/ehcache3.xml"/>
If you are using a different JCache-compatible implementation, different values for the oxf.xforms.cache.resource and/or oxf.xforms.cache.uri properties might be needed.

See also

Previous
GlassFish
Next
Replication
Last modified 1mo ago