[VELOCITY-868] The resource manager cache size configuration is not correctly documented

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.7, 2.0
• Fix Version/s: 2.0
• Component/s: Documentation
• Environment: Any
• Assignee: Claude Brisson
• Reporter: Yann Nicolas
• Created: 09/Oct/15 08:55
• Updated: 07/Jan/18 15:46
• Resolved: 12/Sep/16 13:24

Description

The documentation of the usage of the resource cache is not correct and incomplete. The user needs to see the source code to find the correct cache configuration.

The cache size property name

In the developer guide (http://velocity.apache.org/engine/devel/developer-guide.html#resourcemanagerandcache) and in the JavaDoc (src/main/java/org/apache/velocity/runtime/RuntimeConstants.java), it is written that the property to set the size of the cache is "resource.manager.cache.size", however this property is not used and the correct one is "resource.manager.defaultcache.size":

RuntimeConstants.java

//...
/** The <code>resource.manager.cache.size</code> property specifies the cache upper bound (if relevant). */
125	    String RESOURCE_MANAGER_DEFAULTCACHE_SIZE = "resource.manager.defaultcache.size";

Velocity to set the size for your cache, use the configuration key:
resource.manager.cache.size

The cache size unit

Also, it is not documented what is the unit of the cache size. It is the number of elements in the cache but it could be understood as size in Bytes.

The default size of the cache

The default cache size is 89, but this is not documented. The documentation seems to indicate that the cache is by default unbounded:

A resource cache implementation may want to limit the cache size (rather than providing an unbounded cache which could consume all available memory).