| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| <html> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="author" content="dev@gora.apache.org" /> |
| |
| <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" /> |
| <meta name="Description" content="Apache Gora -- Gora JCache Module" /> |
| <meta name="Keywords" content="Apache Gora NoSQL Framework" /> |
| <meta name="Owner" content="dev@gora.apache.org" /> |
| <meta name="Robots" content="index, follow" /> |
| <meta name="Security" content="Public" /> |
| <meta name="Source" content="wiki template" /> |
| <meta |
| name="DC.Rights" |
| content="Copyright 2010-2024, The Apache Software Foundation" |
| /> |
| <link href="/resources/css/bootstrap.min.css" rel="stylesheet" /> |
| <!-- Fav and touch icons --> |
| <link |
| rel="apple-touch-icon-precomposed" |
| sizes="144x144" |
| href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-144-precomposed.png" |
| /> |
| <link |
| rel="apple-touch-icon-precomposed" |
| sizes="114x114" |
| href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-114-precomposed.png" |
| /> |
| <link |
| rel="apple-touch-icon-precomposed" |
| sizes="72x72" |
| href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-72-precomposed.png" |
| /> |
| <link |
| rel="apple-touch-icon-precomposed" |
| href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-57-precomposed.png" |
| /> |
| <link rel="shortcut icon" href="/resources/img/feather-small.png" /> |
| |
| <title>Apache Gora™ - Gora JCache Module</title> |
| </head> |
| |
| <body style="padding-top: 100px"> |
| <nav class="navbar navbar-expand-lg navbar-dark bg-dark fixed-top shadow-lg"> |
| <div class="container-fluid"> |
| <a class="navbar-brand" href="/index.html" |
| ><img |
| src="/resources/img/gora-logo.png" |
| alt="Apache Gora" |
| title="Apache Gora" |
| height="50px" |
| /></a> |
| <button |
| class="navbar-toggler" |
| type="button" |
| data-bs-toggle="collapse" |
| data-bs-target="#navbarNav" |
| aria-controls="navbarNav" |
| aria-expanded="false" |
| aria-label="Toggle navigation" |
| > |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| <div class="collapse navbar-collapse" id="navbarNav"> |
| <ul class="navbar-nav me-auto"> |
| <li class="nav-item"> |
| <a class="nav-link" href="/downloads.html">Downloads</a> |
| </li> |
| <li class="nav-item dropdown"> |
| <a |
| class="nav-link dropdown-toggle" |
| href="#" |
| id="navbarDropdown1" |
| role="button" |
| data-bs-toggle="dropdown" |
| aria-expanded="false" |
| >Community</a |
| > |
| <ul class="dropdown-menu" aria-labelledby="navbarDropdown1"> |
| <li> |
| <a |
| class="dropdown-item" |
| href="https://whimsy.apache.org/board/minutes/Gora.html" |
| >Board Reporting</a |
| > |
| </li> |
| <li> |
| <a class="dropdown-item" href="/contribute.html" |
| >Contribute</a |
| > |
| </li> |
| <li> |
| <a class="dropdown-item" href="/mailing_lists.html" |
| >Mailing Lists</a |
| > |
| </li> |
| <li> |
| <a class="dropdown-item" href="/credits.html">People</a> |
| </li> |
| <li> |
| <a class="dropdown-item" href="/related.html" |
| >Related Projects</a |
| > |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item dropdown"> |
| <a |
| class="nav-link dropdown-toggle" |
| href="#" |
| id="navbarDropdown2" |
| role="button" |
| data-bs-toggle="dropdown" |
| aria-expanded="false" |
| >Documentation</a |
| > |
| <ul class="dropdown-menu" aria-labelledby="navbarDropdown2"> |
| <li><a class="dropdown-item" href="/about.html">About</a></li> |
| <li> |
| <a class="dropdown-item" href="/current/index.html" |
| >Current Documentation</a |
| > |
| </li> |
| <li> |
| <a class="dropdown-item" href="/current/api/javadoc.html" |
| >JavaDoc Documentation</a |
| > |
| </li> |
| <li> |
| <a class="dropdown-item" href="/current/tutorial.html" |
| >Gora Tutorial</a |
| > |
| </li> |
| <li> |
| <a |
| class="dropdown-item" |
| href="https://cwiki.apache.org/confluence/display/GORA/" |
| >Gora Wiki</a |
| > |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item dropdown"> |
| <a |
| class="nav-link dropdown-toggle" |
| href="#" |
| id="navbarDropdown3" |
| role="button" |
| data-bs-toggle="dropdown" |
| aria-expanded="false" |
| >Development</a |
| > |
| <ul class="dropdown-menu" aria-labelledby="navbarDropdown3"> |
| <li> |
| <a |
| class="dropdown-item" |
| href="https://issues.apache.org/jira/browse/GORA" |
| >Issue Tracking</a |
| > |
| </li> |
| <li> |
| <a class="dropdown-item" href="/mailing_lists.html" |
| >Mailing Lists</a |
| > |
| </li> |
| <li> |
| <a class="dropdown-item" href="/version_control.html" |
| >Version Control</a |
| > |
| </li> |
| <li> |
| <a class="dropdown-item" href="/roadmap.html">Roadmap</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item dropdown"> |
| <a |
| class="nav-link dropdown-toggle" |
| href="#" |
| id="navbarDropdown4" |
| role="button" |
| data-bs-toggle="dropdown" |
| aria-expanded="false" |
| > |
| <img |
| src="/resources/img/feather-small.png" |
| alt="Apache" |
| title="Apache" |
| /> |
| </a> |
| <ul class="dropdown-menu" aria-labelledby="navbarDropdown4"> |
| <li> |
| <a class="dropdown-item" href="http://www.apache.org" |
| >Apache Home</a |
| > |
| </li> |
| <li> |
| <a |
| class="dropdown-item" |
| href="http://www.apache.org/licenses/" |
| >Apache License</a |
| > |
| </li> |
| <li> |
| <a |
| class="dropdown-item" |
| href="http://www.apache.org/security/" |
| >Security</a |
| > |
| </li> |
| <li> |
| <a |
| class="dropdown-item" |
| href="http://www.apache.org/foundation/sponsorship.html" |
| >Support</a |
| > |
| </li> |
| <li> |
| <a |
| class="dropdown-item" |
| href="http://www.apache.org/foundation/thanks.html" |
| >Thanks</a |
| > |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="container top-buffer" id="Gora_Gora JCache Module"> |
| <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permalink">¶</a></h2> |
| <p>This is the main documentation for the gora-jcache module. gora-jcache |
| module enables <a href="https://hazelcast.com/use-cases/caching/jcache-provider">Hazelcast JCache</a> caching support for Gora. |
| This implementation is based on Hazelcast JCache provider. This dataStore can act as wrapped caching layer for any other |
| persistent Apache Gora persistent dataStore.</p> |
| <div id="toc"><ul><li><a class="toc-href" href="#goraproperties" title="gora.properties">gora.properties</a></li></ul></div> |
| <h2 id="goraproperties">gora.properties<a class="headerlink" href="#goraproperties" title="Permalink">¶</a></h2> |
| <ul> |
| <li> |
| <p><code>gora.cache.datastore.default</code> <code>( Mandatory )</code> - Caching dataStore to be used with persistent dataStore. If JCache dataStore is used as caching store |
| assigned value should be <b>org.apache.gora.jcache.store.JCacheStore</b></p> |
| </li> |
| <li> |
| <p><code>gora.datastore.default</code> <code>( Mandatory )</code> - Persistent back-end dataStore to be used with JCache caching dataStore.</p> |
| </li> |
| <li> |
| <p><code>gora.datastore.jcache.provider</code> <code>( Mandatory )</code> - Two possible values, whether to start JCache dataStore in Server mode or Client mode,</p> |
| <ul> |
| <li>Server Mode |
| <b>com.hazelcast.cache.impl.HazelcastServerCachingProvider</b></li> |
| <li>Client Mode |
| <b>com.hazelcast.client.cache.impl.HazelcastClientCachingProvider</b></li> |
| </ul> |
| </li> |
| <li> |
| <p><code>gora.datastore.jcache.hazelcast.config</code> - If JCache datastore is started in,</p> |
| <ul> |
| <li>Server Mode |
| This property to should point to Hazelcast Cluster member network configuration file related to |
| forming Hazelcast cluster using members. Please see <a href="http://docs.hazelcast.org/docs/3.5/manual/html/networkconfiguration.html">Network configuration</a>.</li> |
| <li>Client Mode |
| This property to should point s to Hazelcast client configuration file related to connecting related to already formed Hazelcast cluster. |
| Please see <a href="http://docs.hazelcast.org/docs/3.5/manual/html/javaclientconfiguration.html#java-client-configuration">Client configuration</a> <code>( Mandatory )</code></li> |
| </ul> |
| </li> |
| <li> |
| <p><code>jcache.auto.create.cache</code> - Whether force creating the cache at time JCache dataStore creation. Default is set to <b>false</b>.</p> |
| </li> |
| <li> |
| <p><code>jcache.cache.inmemory.format</code> - In memory for format for persistent bean resides in cache. Possible values, |
| <b>BINARY, OBJECT, NATIVE</b> Please see <a href="http://docs.hazelcast.org/docs/3.5/manual/html/map-inmemoryformat.html">In memory format</a>.</p> |
| </li> |
| <li> |
| <p><code>jcache.read.through.enable</code> - Whether to fetch a missing cache entry from backend persistent dataStore. Default value is <b>true</b>.</p> |
| </li> |
| <li> |
| <p><code>jcache.write.through.enable</code> - Whether to push change of a cache entry to backend persistent dataStore. Default value is <b>true</b>.</p> |
| </li> |
| <li> |
| <p><code>jcache.statistics.enable</code> - Statistics like cache hits and misses are collected. Default value is <b>false</b>.</p> |
| </li> |
| <li> |
| <p><code>jcache.management.enable</code> - JMX beans are enabled and collected statistics are exposed over the beans.It doesn't automatically enables statistics collection. |
| Default is set to false. Default JMX port opens on <b>9999</b>.</p> |
| </li> |
| <li> |
| <p><code>jcache.store.by.value.enable</code> - Whether to store key and values of data beans in means of store by value or store by reference. Default is <b>true</b> that means store by <b>value</b>.</p> |
| </li> |
| <li> |
| <p><code>jcache.cache.namespace</code> - Cache manager scope URI. This will allow different cache manager instances to share data among them if they are aligned with same scope. |
| On opposite having two different scopes means such that each cache manager can isolate each other’s owned caches without any conflict. |
| Please see <a href="http://docs.hazelcast.org/docs/3.5/manual/html/jcache-icache.html">Scopes and Namespaces</a></p> |
| </li> |
| <li> |
| <p><code>jcache.expire.policy</code> - Cache entry expiry policy. Possible values <b> ACCESSED, CREATED, MODIFIED, TOUCHED </b> |
| Please see <a href="http://docs.hazelcast.org/docs/3.5/manual/html/jcache-expirepolicy.html">JCache expiry policy</a></p> |
| </li> |
| <li> |
| <p><code>jcache.expire.policy.duration</code> - Cache entry expiry timeout in seconds.</p> |
| </li> |
| <li> |
| <p><code>jcache.eviction.policy</code> - Cache entry eviction policy. Possible values <b> LRU, LFU, NONE, RANDOM </b> |
| Please see <a href="http://docs.hazelcast.org/docs/3.5/manual/html/jcache-eviction.html">Hazelcast eviction policy</a></p> |
| </li> |
| <li> |
| <p><code>jcache.eviction.max.size.policy</code> - Measure of maximum cache size to apply eviction policy. |
| <b> ENTRY_COUNT, USED_NATIVE_MEMORY_SIZE, USED_NATIVE_MEMORY_PERCENTAGE, FREE_NATIVE_MEMORY_SIZE, FREE_NATIVE_MEMORY_PERCENTAGE </b></p> |
| </li> |
| <li> |
| <p><code>jcache.eviction.size</code> - Maximum size as integer as a measure of max size policy criteria.</p> |
| </li> |
| </ul> |
| |
| </div> |
| <!-- /container (main block) --> |
| |
| <hr /> |
| |
| <div class="container"> |
| <footer> |
| <p> |
| Copyright © 2010-2024 The Apache Software Foundation. |
| Licensed under |
| <a href="http://www.apache.org/licenses/LICENSE-2.0" |
| >Apache License 2.0</a |
| >. |
| </p> |
| <p> |
| Apache Gora, Gora, Apache, the Apache feather logo, and the Apache |
| Gora project logo are trademarks of The Apache Software Foundation. |
| </p> |
| </footer> |
| </div> |
| <!-- /container --> |
| |
| <script src="/resources/js/bootstrap.bundle.min.js"></script> |
| <script type="text/javascript"> |
| stLight.options({ |
| publisher: "4059fafd-3891-49f9-8c96-e4100290d8e6", |
| doNotHash: false, |
| doNotCopy: false, |
| hashAddressBar: false, |
| }); |
| </script> |
| <script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.0.1/build/highlight.min.js"></script> |
| <script> |
| hljs.highlightAll(); |
| </script> |
| </body> |
| </html> |
