[feature] Make grammar cache configurable from conf.xml

Author: dizzzz

exist-core/src/main/java/org/exist/util/Configuration.java

@@ -372,6 +372,8 @@ public Configuration(@Nullable String configFilename, Optional<Path> existHomeDi
             configureElement(doc, XQUERY_CONFIGURATION_ELEMENT_NAME, this::configureXQuery);
             // Validation
             configureElement(doc, XMLReaderObjectFactory.CONFIGURATION_ELEMENT_NAME, element -> configureValidation(existHomePath, element));
+            // Grammar cache
+            configureElement(doc, GrammarPool.GRAMMAR_POOL, element -> configureGrammarCache(existHomePath, element));
             // RPC server
             configureElement(doc, "rpc-server", this::configureRpcServer);
         } catch (final SAXException | IOException | ParserConfigurationException e) {
@@ -1192,13 +1194,17 @@ private void configureIndexer(final Document doc, final Element indexer) throws
         setProperty(IndexManager.PROPERTY_INDEXER_MODULES, modConfig);
     }
 
+    private void configureGrammarCache(final Optional<Path> dbHome, final Element validation) {
+        configureProperty(validation, GrammarPool.ATTRIBUTE_MAXIMUM_SIZE, GrammarPool.PROPERTY_MAXIMUM_SIZE, Configuration::asInteger, null);
+        configureProperty(validation, GrammarPool.ATTRIBUTE_EXPIRE_AFTER_ACCESS, GrammarPool.PROPERTY_EXPIRE_AFTER_ACCESS, Configuration::asInteger, null);
+
+        setProperty(GrammarPool.GRAMMAR_POOL, new GrammarPool(getInteger(GrammarPool.PROPERTY_MAXIMUM_SIZE), getInteger(GrammarPool.PROPERTY_EXPIRE_AFTER_ACCESS)));
+    }
+
     private void configureValidation(final Optional<Path> dbHome, final Element validation) {
         // Determine validation mode
         configureProperty(validation, XMLReaderObjectFactory.VALIDATION_MODE_ATTRIBUTE, PROPERTY_VALIDATION_MODE);
 
-        // cache
-        setProperty(XMLReaderObjectFactory.GRAMMAR_POOL, new GrammarPool());
-
         // Configure the Entity Resolver
         final NodeList entityResolver = validation.getElementsByTagName(XMLReaderObjectFactory.CONFIGURATION_ENTITY_RESOLVER_ELEMENT_NAME);
         if (entityResolver.getLength() == 0) {

exist-core/src/main/java/org/exist/util/XMLReaderObjectFactory.java

@@ -60,7 +60,6 @@ public class XMLReaderObjectFactory extends BasePooledObjectFactory<XMLReader> i
     public static final String PROPERTY_VALIDATION_MODE = "validation.mode";
     public static final String CATALOG_RESOLVER = "validation.resolver";
     public static final String CATALOG_URIS = "validation.catalog_uris";
-    public static final String GRAMMAR_POOL = "validation.grammar_pool";
 
     // Xerces feature and property names
     public static final String APACHE_FEATURES_VALIDATION_SCHEMA
@@ -83,7 +82,7 @@ public class XMLReaderObjectFactory extends BasePooledObjectFactory<XMLReader> i
 
     @Override
     public void configure(final Configuration configuration) {
-        this.grammarPool = (GrammarPool) configuration.getProperty(XMLReaderObjectFactory.GRAMMAR_POOL);
+        this.grammarPool = (GrammarPool) configuration.getProperty(GrammarPool.GRAMMAR_POOL);
         this.resolver = (Resolver) configuration.getProperty(CATALOG_RESOLVER);
         final String option = (String) configuration.getProperty(PROPERTY_VALIDATION_MODE);
         this.validation = VALIDATION_SETTING.fromOption(option);

exist-core/src/main/java/org/exist/validation/GrammarPool.java

@@ -38,6 +38,14 @@
  */
 public class GrammarPool implements XMLGrammarPool {
 
+    public static final String GRAMMAR_POOL = "grammar-pool";
+
+    public static final String ATTRIBUTE_MAXIMUM_SIZE = "maximum-size";
+    public static final String PROPERTY_MAXIMUM_SIZE = "grammar-cache.maximum-size";
+
+    public static final String ATTRIBUTE_EXPIRE_AFTER_ACCESS = "expire-after-access";
+    public static final String PROPERTY_EXPIRE_AFTER_ACCESS = "grammar-cache.expire-after-access";
+
     private final Cache<GrammarKey, Grammar> grammarCache;
     private boolean isLocked = false;
 
@@ -52,13 +60,21 @@ public GrammarPool() {
      * Constructor.
      *
      * @param maxSize Maximum nr of cached elements.
-     * @param minutes Maximum expiration time in minutes after last access.
+     * @param seconds Maximum expiration time in seconds after last access.
      */
-    public GrammarPool(final long maxSize, final long minutes) {
-        grammarCache = Caffeine.newBuilder()
-                .maximumSize(maxSize)
-                .expireAfterAccess(minutes, TimeUnit.MINUTES)
-                .build();
+    public GrammarPool(final long maxSize, final long seconds) {
+
+        Caffeine<Object, Object> cafeineBuilder = Caffeine.newBuilder();
+
+        if(maxSize>0){
+            cafeineBuilder = cafeineBuilder.maximumSize(maxSize);
+        }
+
+        if(seconds>0){
+            cafeineBuilder.expireAfterAccess(seconds, TimeUnit.SECONDS);
+        }
+
+        grammarCache = cafeineBuilder.build();
     }
 
     @Override

exist-core/src/main/java/org/exist/validation/Validator.java

@@ -90,7 +90,7 @@ public Validator(final BrokerPool brokerPool, final Subject subject) {
         final Configuration config = brokerPool.getConfiguration();
 
         // setup grammar brokerPool
-        this.grammarPool = (GrammarPool) config.getProperty(XMLReaderObjectFactory.GRAMMAR_POOL);
+        this.grammarPool = (GrammarPool) config.getProperty(GrammarPool.GRAMMAR_POOL);
 
         // setup system wide catalog resolver
         this.systemCatalogResolver = (Resolver) config.getProperty(XMLReaderObjectFactory.CATALOG_RESOLVER);

exist-core/src/main/java/org/exist/xquery/functions/validation/GrammarTooling.java

@@ -139,7 +139,7 @@ public Sequence eval(Sequence[] args, Sequence contextSequence)
     throws XPathException {
 
         final GrammarPool grammarpool
-            = (GrammarPool) config.getProperty(XMLReaderObjectFactory.GRAMMAR_POOL);
+            = (GrammarPool) config.getProperty(GrammarPool.GRAMMAR_POOL);
 
         if (isCalledAs("clear-grammar-cache")){
 

exist-core/src/main/java/org/exist/xquery/functions/validation/Jaxp.java

@@ -283,7 +283,7 @@ public Sequence eval(final Sequence[] args, final Sequence contextSequence) thro
             if (useCache) {
                 LOG.debug("Grammar caching enabled.");
                 final Configuration config = brokerPool.getConfiguration();
-                final GrammarPool grammarPool = (GrammarPool) config.getProperty(XMLReaderObjectFactory.GRAMMAR_POOL);
+                final GrammarPool grammarPool = (GrammarPool) config.getProperty(GrammarPool.GRAMMAR_POOL);
                 xmlReader.setProperty(XMLReaderObjectFactory.APACHE_PROPERTIES_INTERNAL_GRAMMARPOOL, grammarPool);
             }