| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"/> |
| <meta name="Date-Revision-yyyymmdd" content="20140918"/> |
| <meta http-equiv="Content-Language" content="en"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| |
| <title>OGNL Cache Configuration</title> |
| |
| <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> |
| <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> |
| <link href="/css/main.css" rel="stylesheet"> |
| <link href="/css/custom.css" rel="stylesheet"> |
| <link href="/highlighter/github-theme.css" rel="stylesheet"> |
| |
| <script src="//code.jquery.com/jquery-1.11.0.min.js"></script> |
| <script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script> |
| <script type="text/javascript" src="/js/community.js"></script> |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="//analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '41']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| </head> |
| <body> |
| |
| <a href="https://github.com/apache/struts" class="github-ribbon"> |
| <img decoding="async" loading="lazy" style="position: absolute; right: 0; border: 0;" width="149" height="149" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_red_aa0000.png?resize=149%2C149" class="attachment-full size-full" alt="Fork me on GitHub" data-recalc-dims="1"> |
| </a> |
| |
| <header> |
| <nav> |
| <div role="navigation" class="navbar navbar-default navbar-fixed-top"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle"> |
| Menu |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a> |
| </div> |
| <div id="struts-menu" class="navbar-collapse collapse"> |
| <ul class="nav navbar-nav"> |
| <li class="dropdown"> |
| <a data-toggle="dropdown" href="#" class="dropdown-toggle"> |
| Home<b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <li><a href="/index.html">Welcome</a></li> |
| <li><a href="/download.cgi">Download</a></li> |
| <li><a href="/releases.html">Releases</a></li> |
| <li><a href="/announce-2024.html">Announcements</a></li> |
| <li><a href="http://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a data-toggle="dropdown" href="#" class="dropdown-toggle"> |
| Support<b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <li><a href="/mail.html">User Mailing List</a></li> |
| <li><a href="https://issues.apache.org/jira/browse/WW">Issue Tracker</a></li> |
| <li><a href="/security.html">Reporting Security Issues</a></li> |
| <li><a href="/commercial-support.html">Commercial Support</a></li> |
| <li class="divider"></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/WW/Migration+Guide">Version Notes</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/WW/Security+Bulletins">Security Bulletins</a></li> |
| <li class="divider"></li> |
| <li><a href="/maven/project-info.html">Maven Project Info</a></li> |
| <li><a href="/maven/struts2-core/dependencies.html">Struts Core Dependencies</a></li> |
| <li><a href="/maven/struts2-plugins/modules.html">Plugin Dependencies</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a data-toggle="dropdown" href="#" class="dropdown-toggle"> |
| Documentation<b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <li><a href="/birdseye.html">Birds Eye</a></li> |
| <li><a href="/primer.html">Key Technologies</a></li> |
| <li><a href="/kickstart.html">Kickstart FAQ</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/WW/Home">Wiki</a></li> |
| <li class="divider"></li> |
| <li><a href="/getting-started/">Getting Started</a></li> |
| <li><a href="/security/">Security Guide</a></li> |
| <li><a href="/core-developers/">Core Developers Guide</a></li> |
| <li><a href="/tag-developers/">Tag Developers Guide</a></li> |
| <li><a href="/maven-archetypes/">Maven Archetypes</a></li> |
| <li><a href="/plugins/">Plugins</a></li> |
| <li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li> |
| <li><a href="/tag-developers/tag-reference.html">Tag reference</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/WW/FAQs">FAQs</a></li> |
| <li><a href="http://cwiki.apache.org/S2PLUGINS/home.html">Plugin registry</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a data-toggle="dropdown" href="#" class="dropdown-toggle"> |
| Contributing<b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <li><a href="/youatstruts.html">You at Struts</a></li> |
| <li><a href="/helping.html">How to Help FAQ</a></li> |
| <li><a href="/dev-mail.html">Development Lists</a></li> |
| <li class="divider"></li> |
| <li><a href="/submitting-patches.html">Submitting patches</a></li> |
| <li><a href="/builds.html">Source Code and Builds</a></li> |
| <li><a href="/coding-standards.html">Coding standards</a></li> |
| <li><a href="/contributors/">Contributors Guide</a></li> |
| <li class="divider"></li> |
| <li><a href="/release-guidelines.html">Release Guidelines</a></li> |
| <li><a href="/bylaws.html">PMC Charter</a></li> |
| <li><a href="/volunteers.html">Volunteers</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf?p=struts.git">Source Repository</a></li> |
| <li><a href="/updating-website.html">Updating the website</a></li> |
| </ul> |
| </li> |
| <li class="apache"><a href="http://www.apache.org/"><img src="/img/apache.png"></a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </header> |
| |
| |
| <article class="container"> |
| <section class="col-md-12"> |
| <a href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</a> |
| <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/ognl-cache-configuration.md" title="Edit this page on GitHub">Edit on GitHub</a> |
| <h1 id="ognl-cache-configuration">OGNL Cache Configuration</h1> |
| |
| <p>The Struts framework provides two different OGNL caches, an expression cache and a BeanInfo cache. |
| Developers may set properties in <a href="struts-xml">struts.xml</a> and/or <a href="default-properties">default.properties</a> to |
| configure certain behaviours for the OGNL caches. The properties that can be set vary between Struts |
| versions, referring to the configuration files in a given version should provide guidance in that respect.</p> |
| |
| <p>The OGNL expression cache is enabled by default. Developers can toggle that state via default.properties:</p> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>struts.ognl.enableExpressionCache=true |
| </code></pre></div></div> |
| <p>or</p> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>struts.ognl.enableExpressionCache=false |
| </code></pre></div></div> |
| <p>The same toggle is also available via struts.xml:</p> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code><constant name="struts.ognl.enableExpressionCache" value="true"/> |
| </code></pre></div></div> |
| <p>or</p> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code><constant name="struts.ognl.enableExpressionCache" value="false"/> |
| </code></pre></div></div> |
| |
| <p>Disabling the OGNL expression cache can have a negative impact on performance, but |
| disabling the cache can limit memory overhead for the application (a trade-off).</p> |
| |
| <p>As of Struts 6.0.0, additional configuration properties have been made available to control the |
| OGNL cache configuration. These include a configureable cache size limit, and activating |
| an LRU (Least Recently Used) cache mode. The expression cache and BeanInfo cache can have |
| their properties set independently. Both caches are standard caches with a high maximum |
| capacity by default. The developer may override the default behaviour using the |
| appropriate configuration properties.</p> |
| |
| <p>Below are some examples of setting the cache configuration via default.properties:</p> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>### Set expression and BeanInfo caches to size 1250 with standard cache mode |
| struts.ognl.enableExpressionCache=true |
| struts.ognl.expressionCacheMaxSize=1250 |
| struts.ognl.expressionCacheLRUMode=false |
| struts.ognl.beanInfoCacheMaxSize=1250 |
| struts.ognl.beanInfoCacheLRUMode=false |
| </code></pre></div></div> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>### Set expression and BeanInfo caches to size 1000 with LRU cache mode |
| struts.ognl.enableExpressionCache=true |
| struts.ognl.expressionCacheMaxSize=1000 |
| struts.ognl.expressionCacheLRUMode=true |
| struts.ognl.beanInfoCacheMaxSize=1000 |
| struts.ognl.beanInfoCacheLRUMode=true |
| </code></pre></div></div> |
| |
| <p>Below are some examples of setting the cache configuration via struts.xml:</p> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code><!-- Set expression and BeanInfo caches to size 1250 with standard cache mode --> |
| <constant name="struts.ognl.enableExpressionCache" value="true"/> |
| <constant name="struts.ognl.expressionCacheMaxSize" value="1250"/> |
| <constant name="struts.ognl.expressionCacheLRUMode" value="false"/> |
| <constant name="struts.ognl.beanInfoCacheMaxSize" value="1250"/> |
| <constant name="struts.ognl.beanInfoCacheLRUMode" value="false"/> |
| </code></pre></div></div> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code><!-- Set expression and BeanInfo caches to size 1000 with LRU cache mode --> |
| <constant name="struts.ognl.enableExpressionCache" value="true"/> |
| <constant name="struts.ognl.expressionCacheMaxSize" value="1000"/> |
| <constant name="struts.ognl.expressionCacheLRUMode" value="true"/> |
| <constant name="struts.ognl.beanInfoCacheMaxSize" value="1000"/> |
| <constant name="struts.ognl.beanInfoCacheLRUMode" value="true"/> |
| </code></pre></div></div> |
| |
| <p>As of Struts 6.0.0, developers may choose to implement their own OGNL cache factories, |
| instead of using the default implementations, should they desire to. The default |
| implementations can be referenced to give an idea of how to implement a custom implementation. |
| For example, if a developer implements a CustomExpressionCacheFactory and CustomBeanInfoCacheFactory |
| that both implement the OgnlCacheFactory interface, they could be installed via |
| a configuration in struts.xml:</p> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code><constant name="struts.ognl.expressionCacheFactory" value="some.package.CustomExpressionCacheFactory"/> |
| <constant name="struts.ognl.beanInfoCacheFactory" value="some.package.CustomBeanInfoCacheFactory"/> |
| </code></pre></div></div> |
| <p>If the developer wants the standard configuration properties for the caches to function, they will need |
| to implement equivalent methods to the ones the default implementation uses to populate those properties.</p> |
| |
| <p>Beyond the configuration properties, in certain circumstances, developers may choose to utilize certain methods to |
| interact with the OGNL caches. Refer to the API documentation for <a href="https://struts.apache.org/maven/struts2-core/apidocs/com/opensymphony/xwork2/ognl/OgnlUtil.html">OgnlUtil</a>.</p> |
| |
| </section> |
| </article> |
| |
| |
| <footer class="container"> |
| <div class="col-md-12"> |
| Copyright © 2000-2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are |
| trademarks of The Apache Software Foundation. All Rights Reserved. |
| </div> |
| <div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/">SoftwareMill</a>.</div> |
| </footer> |
| |
| <script>!function (d, s, id) { |
| var js, fjs = d.getElementsByTagName(s)[0]; |
| if (!d.getElementById(id)) { |
| js = d.createElement(s); |
| js.id = id; |
| js.src = "//platform.twitter.com/widgets.js"; |
| fjs.parentNode.insertBefore(js, fjs); |
| } |
| }(document, "script", "twitter-wjs");</script> |
| <script src="https://apis.google.com/js/platform.js" async="async" defer="defer"></script> |
| |
| <div id="fb-root"></div> |
| |
| <script>(function (d, s, id) { |
| var js, fjs = d.getElementsByTagName(s)[0]; |
| if (d.getElementById(id)) return; |
| js = d.createElement(s); |
| js.id = id; |
| js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1"; |
| fjs.parentNode.insertBefore(js, fjs); |
| }(document, 'script', 'facebook-jssdk'));</script> |
| |
| |
| </body> |
| </html> |