Orbeon Forms supports a boolean extension attribute,
xxf:cache, on the
<xf:submission>elements. This attribute can be used with instances that are read-only or read-write. When set to true:
- The instance can be shared at the application level. It is identified by its source URL and, in the case of a submission with
PUTmethod, by the body of the request sent.
- The instance is not stored into the XForms document's state, but in a global cache, therefore potentially saving memory. If, upon loading an XForms instance or running a submission, the instance is found in the cache, it is directly retrieved from the cache. This can save time especially if the URL can take significant time to load.
- The instance stored in cache is read-only. If the
xxf:readonlyattribute is set to true (on
<xf:submission>), a single copy of the instance is used in memory. Otherwise, a read-write copy is made.
- In general, the URL should refer to a constant or rarely-changing XML document, and authorization credentials such as username and password should not cause different data to be loaded.
NOTE: This attribute deprecates the
xxf:cache="true"is equivalent to using
xxf:cache="false"is equivalent to using
Here is how you use the attribute on
When used on
<xf:submission>, the submission has to use
PUTare not meant to be idempotent methods, you should use
xxf:cache="true"with these methods carefully, typically for calls to services you know are idempotent. Otherwise, incorrect or stale data might be returned by the submission.
You set the size of the shared instances cache using a property in
You can force the XForms engine to remove a shared instance from the cache by dispatching the
xxforms-instance-invalidateevent to it. The next time an XForms document requires this instance, it will not be found in the cache and therefore reloaded. Example:
xxf:invalidate-instanceaction allows invalidating a shared instance by resource URI, for example:
This action also supports the
xincludeattribute, which if present will only invalidate the instance with the given resource if it was loaded with a matching
Submission loading a shared instance and enabling XInclude processing:
Action invalidating only the instance which was loaded with
xincludeattribute is not specified, any shared instance matching the resource URI is invalidated.
It is also possible to remove all shared instances from the cache by using the
xxf:invalidate-instancesaction, for example:
xxf:ttl attributecan be used to set a time to live for the instance in cache. This duration is expressed in milliseconds and has to be greater than zero. When a shared instance if found in cache but has an associated time to live, if it was put in the cache more than time to live milliseconds in the past, then the instance is discarded from the cache and retrieved again by URI as if it had not been found in cache at all. The following example expires the shared instance after one hour:
SECURITY NOTE: When using
xxf:cache="true", be sure that the data contained in the instance does not contain information that could be inadvertently shared with other XForms documents. It is recommended to use it to load localized resources or similar types of data.