Google Git
Sign in
apache / geode-site / fc25d29c7053eb6dc81bcd70f2b22d855a2be473 / . / releases / latest / javadoc / org / apache / geode / cache / GemFireCache.html
blob: c2f684b9ecc59fa0c7c1e67191ec5876bb180400 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>GemFireCache (Apache Geode 1.15.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GemFireCache (Apache Geode 1.15.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/geode/cache/GatewayException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/cache/IncompatibleVersionException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/cache/GemFireCache.html" target="_top">Frames</a></li>
<li><a href="GemFireCache.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.geode.cache</div>
<h2 title="Interface GemFireCache" class="title">Interface GemFireCache</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../org/apache/geode/cache/RegionService.html" title="interface in org.apache.geode.cache">RegionService</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a>, <a href="../../../../org/apache/geode/cache/client/ClientCache.html" title="interface in org.apache.geode.cache.client">ClientCache</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">GemFireCache</span>
extends <a href="../../../../org/apache/geode/cache/RegionService.html" title="interface in org.apache.geode.cache">RegionService</a></pre>
<div class="block">GemFireCache represents the singleton cache that must be created in order to use GemFire in a
Java virtual machine. Users must create either a <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> for a peer/server JVM or a
<a href="../../../../org/apache/geode/cache/client/ClientCache.html" title="interface in org.apache.geode.cache.client"><code>ClientCache</code></a> for a client JVM. Instances of this interface are created using one of the
following methods:
<ul>
<li><a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>CacheFactory.create()</code></a> creates a peer/server instance of <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a>.
<li><a href="../../../../org/apache/geode/cache/client/ClientCacheFactory.html#create--"><code>ClientCacheFactory.create()</code></a> creates a client instance of <a href="../../../../org/apache/geode/cache/client/ClientCache.html" title="interface in org.apache.geode.cache.client"><code>ClientCache</code></a>.
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.5</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#createDiskStoreFactory--">createDiskStoreFactory</a></span>()</code>
<div class="block">create diskstore factory</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#createGatewaySenderFactory--">createGatewaySenderFactory</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache">DiskStore</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#findDiskStore-java.lang.String-">findDiskStore</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns the DiskStore by name or <code>null</code> if no disk store is found.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheTransactionManager.html" title="interface in org.apache.geode.cache">CacheTransactionManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getCacheTransactionManager--">getCacheTransactionManager</a></span>()</code>
<div class="block">Get the CacheTransactionManager instance for this Cache.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getCopyOnRead--">getCopyOnRead</a></span>()</code>
<div class="block">Indicates whether the "copy on read" is enabled for this cache.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getDistributedSystem--">getDistributedSystem</a></span>()</code>
<div class="block">Returns the distributed system used by this cache.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/Declarable.html" title="interface in org.apache.geode.cache">Declarable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getInitializer--">getInitializer</a></span>()</code>
<div class="block">Returns the Declarable used to initialize this cache or <code>null</code> if it does not have an
initializer.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getInitializerProps--">getInitializerProps</a></span>()</code>
<div class="block">Returns the Properties used to initialize the cache initializer or <code>null</code> if no
initializer properties exist.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/Context.html?is-external=true" title="class or interface in javax.naming">Context</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getJNDIContext--">getJNDIContext</a></span>()</code>
<div class="block">Returns the JNDI context associated with the Cache.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/LogWriter.html" title="interface in org.apache.geode">LogWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getLogger--">getLogger</a></span>()</code>
<div class="block">Gets the logging object for GemFire.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of this cache.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getPdxDiskStore--">getPdxDiskStore</a></span>()</code>
<div class="block">Returns the disk store used for PDX meta data</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getPdxIgnoreUnreadFields--">getPdxIgnoreUnreadFields</a></span>()</code>
<div class="block">Returns true if fields that are not read during PDX deserialization should be ignored during
the PDX serialization.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getPdxPersistent--">getPdxPersistent</a></span>()</code>
<div class="block">Returns true if the PDX metadata for this cache is persistent</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getPdxReadSerialized--">getPdxReadSerialized</a></span>()</code>
<div class="block">Returns whether <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a> is preferred for PDX types instead of Java object.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxSerializer.html" title="interface in org.apache.geode.pdx">PdxSerializer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getPdxSerializer--">getPdxSerializer</a></span>()</code>
<div class="block">Returns the PdxSerializer used by this cache, or null if no PDX serializer is defined.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>&lt;K,V&gt;&nbsp;<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a>&lt;K,V&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getRegionAttributes-java.lang.String-">getRegionAttributes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</code>
<div class="block">Returns the <code>RegionAttributes</code> with the given <code>id</code> or <code>null</code> if no
<code>RegionAttributes</code> with that id exists.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/control/ResourceManager.html" title="interface in org.apache.geode.cache.control">ResourceManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getResourceManager--">getResourceManager</a></span>()</code>
<div class="block">Returns the <code>ResourceManager</code> for managing this cache's resources.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/LogWriter.html" title="interface in org.apache.geode">LogWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#getSecurityLogger--">getSecurityLogger</a></span>()</code>
<div class="block">Gets the security logging object for GemFire.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>&lt;K,V&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a>&lt;K,V&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#listRegionAttributes--">listRegionAttributes</a></span>()</code>
<div class="block">Returns an unmodifiable mapping of ids to region attributes.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#loadCacheXml-java.io.InputStream-">loadCacheXml</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is)</code>
<div class="block">Loads the cache configuration described in a
<a href="package-summary.html#declarative">declarative caching XML file</a> into this cache.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#registerPdxMetaData-java.lang.Object-">registerPdxMetaData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;instance)</code>
<div class="block">Registers PDX meta-data given an instance of a domain class that will be serialized
with PDX.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#setCopyOnRead-boolean-">setCopyOnRead</a></span>(boolean&nbsp;copyOnRead)</code>
<div class="block">Sets the "copy on read" feature for cache read operations.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>&lt;K,V&gt;&nbsp;void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/GemFireCache.html#setRegionAttributes-java.lang.String-org.apache.geode.cache.RegionAttributes-">setRegionAttributes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id,
<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a>&lt;K,V&gt;&nbsp;attrs)</code>
<div class="block">Sets the <code>id</code> of the given <code>RegionAttributes</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.RegionService">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.geode.cache.<a href="../../../../org/apache/geode/cache/RegionService.html" title="interface in org.apache.geode.cache">RegionService</a></h3>
<code><a href="../../../../org/apache/geode/cache/RegionService.html#close--">close</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#createPdxEnum-java.lang.String-java.lang.String-int-">createPdxEnum</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#createPdxInstanceFactory-java.lang.String-">createPdxInstanceFactory</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#getCancelCriterion--">getCancelCriterion</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#getJsonFormatter--">getJsonFormatter</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#getQueryService--">getQueryService</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#getRegion-java.lang.String-">getRegion</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#isClosed--">isClosed</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#rootRegions--">rootRegions</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Returns the name of this cache. This method does not throw <code>CacheClosedException</code> if the
cache is closed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the String name of this cache</dd>
</dl>
</li>
</ul>
<a name="getDistributedSystem--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistributedSystem</h4>
<pre><a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a>&nbsp;getDistributedSystem()</pre>
<div class="block">Returns the distributed system used by this cache. This method does not throw
<code>CacheClosedException</code> if the cache is closed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the distributed system used by this cache</dd>
</dl>
</li>
</ul>
<a name="getResourceManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceManager</h4>
<pre><a href="../../../../org/apache/geode/cache/control/ResourceManager.html" title="interface in org.apache.geode.cache.control">ResourceManager</a>&nbsp;getResourceManager()</pre>
<div class="block">Returns the <code>ResourceManager</code> for managing this cache's resources.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>ResourceManager</code> for managing this cache's resources</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.0</dd>
</dl>
</li>
</ul>
<a name="setCopyOnRead-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCopyOnRead</h4>
<pre>void&nbsp;setCopyOnRead(boolean&nbsp;copyOnRead)</pre>
<div class="block">Sets the "copy on read" feature for cache read operations.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>copyOnRead</code> - whether the "copy on read" feature should be enabled</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.0</dd>
</dl>
</li>
</ul>
<a name="getCopyOnRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCopyOnRead</h4>
<pre>boolean&nbsp;getCopyOnRead()</pre>
<div class="block">Indicates whether the "copy on read" is enabled for this cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if "copy on read" is enabled, false otherwise.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.0</dd>
</dl>
</li>
</ul>
<a name="getRegionAttributes-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRegionAttributes</h4>
<pre>&lt;K,V&gt;&nbsp;<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a>&lt;K,V&gt;&nbsp;getRegionAttributes(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</pre>
<div class="block">Returns the <code>RegionAttributes</code> with the given <code>id</code> or <code>null</code> if no
<code>RegionAttributes</code> with that id exists.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - the type of keys in the region</dd>
<dd><code>V</code> - the type of values in the region</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the <code>id</code> of the <code>RegionAttributes</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>RegionAttributes</code> with the given <code>id</code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/GemFireCache.html#setRegionAttributes-java.lang.String-org.apache.geode.cache.RegionAttributes-"><code>setRegionAttributes(java.lang.String, org.apache.geode.cache.RegionAttributes&lt;K, V&gt;)</code></a></dd>
</dl>
</li>
</ul>
<a name="setRegionAttributes-java.lang.String-org.apache.geode.cache.RegionAttributes-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRegionAttributes</h4>
<pre>&lt;K,V&gt;&nbsp;void&nbsp;setRegionAttributes(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id,
<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a>&lt;K,V&gt;&nbsp;attrs)</pre>
<div class="block">Sets the <code>id</code> of the given <code>RegionAttributes</code>. If a region attributes named
<code>name</code> already exists, the mapping will be overwritten with <code>attrs</code>. However,
changing the mapping will not effect existing regions.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - the type of keys in the region</dd>
<dd><code>V</code> - the type of values in the region</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - The id of the region attributes</dd>
<dd><code>attrs</code> - The attributes to associate with <code>id</code>. If <code>attrs</code> is <code>null</code>, any
existing <code>RegionAttributes</code> associated with <code>id</code> will be removed.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/GemFireCache.html#getRegionAttributes-java.lang.String-"><code>getRegionAttributes(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="listRegionAttributes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listRegionAttributes</h4>
<pre>&lt;K,V&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a>&lt;K,V&gt;&gt;&nbsp;listRegionAttributes()</pre>
<div class="block">Returns an unmodifiable mapping of ids to region attributes. The keys of the map are
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>s and the values of the map are <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache"><code>RegionAttributes</code></a>.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - the type of keys in the region</dd>
<dd><code>V</code> - the type of values in the region</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an unmodifiable mapping of ids to region attributes</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.1</dd>
</dl>
</li>
</ul>
<a name="loadCacheXml-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadCacheXml</h4>
<pre>void&nbsp;loadCacheXml(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is)
throws <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a>,
<a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a>,
<a href="../../../../org/apache/geode/cache/GatewayException.html" title="class in org.apache.geode.cache">GatewayException</a>,
<a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></pre>
<div class="block">Loads the cache configuration described in a
<a href="package-summary.html#declarative">declarative caching XML file</a> into this cache. If
the XML describes a region that already exists, any mutable region attributes, indexes, and
region entries that are defined in the XML are updated/added.
<P>
Because this method may perform a <a href="../../../../org/apache/geode/cache/Region.html#put-K-V-"><code>put</code></a> on a <code>Region</code>,
it declares that it throws a <code>TimeoutException</code>, <code>CacheWriterException</code>,
<code>GatewayException</code>, or <code>RegionExistsException</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>is</code> - the InputStream from which to read the XML</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/geode/cache/CacheXmlException.html" title="class in org.apache.geode.cache">CacheXmlException</a></code> - If the XML read from <code>is</code> does not conform to the dtd or if an
<code>IOException</code> occurs while reading the XML.</dd>
<dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code></dd>
<dd><code><a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code></dd>
<dd><code><a href="../../../../org/apache/geode/cache/GatewayException.html" title="class in org.apache.geode.cache">GatewayException</a></code></dd>
<dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.1</dd>
</dl>
</li>
</ul>
<a name="getLogger--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogger</h4>
<pre><a href="../../../../org/apache/geode/LogWriter.html" title="interface in org.apache.geode">LogWriter</a>&nbsp;getLogger()</pre>
<div class="block">Gets the logging object for GemFire. This method does not throw <code>CacheClosedException</code> if
the cache is closed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the logging object</dd>
</dl>
</li>
</ul>
<a name="getSecurityLogger--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecurityLogger</h4>
<pre><a href="../../../../org/apache/geode/LogWriter.html" title="interface in org.apache.geode">LogWriter</a>&nbsp;getSecurityLogger()</pre>
<div class="block">Gets the security logging object for GemFire. This method does not throw
<code>CacheClosedException</code> if the cache is closed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the security logging object</dd>
</dl>
</li>
</ul>
<a name="findDiskStore-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findDiskStore</h4>
<pre><a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache">DiskStore</a>&nbsp;findDiskStore(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Returns the DiskStore by name or <code>null</code> if no disk store is found.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the disk store to find. If <code>null</code> then the default disk store, if
it exists, is returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the DiskStore by name or <code>null</code> if no disk store is found</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.5</dd>
</dl>
</li>
</ul>
<a name="createDiskStoreFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDiskStoreFactory</h4>
<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a>&nbsp;createDiskStoreFactory()</pre>
<div class="block">create diskstore factory</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache"><code>DiskStoreFactory</code></a></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.5</dd>
</dl>
</li>
</ul>
<a name="createGatewaySenderFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createGatewaySenderFactory</h4>
<pre><a href="../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a>&nbsp;createGatewaySenderFactory()</pre>
</li>
</ul>
<a name="getPdxReadSerialized--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPdxReadSerialized</h4>
<pre>boolean&nbsp;getPdxReadSerialized()</pre>
<div class="block">Returns whether <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a> is preferred for PDX types instead of Java object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a> is preferred for PDX types instead of Java object</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxReadSerialized-boolean-"><code>CacheFactory.setPdxReadSerialized(boolean)</code></a>,
<a href="../../../../org/apache/geode/cache/client/ClientCacheFactory.html#setPdxReadSerialized-boolean-"><code>ClientCacheFactory.setPdxReadSerialized(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="getPdxSerializer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPdxSerializer</h4>
<pre><a href="../../../../org/apache/geode/pdx/PdxSerializer.html" title="interface in org.apache.geode.pdx">PdxSerializer</a>&nbsp;getPdxSerializer()</pre>
<div class="block">Returns the PdxSerializer used by this cache, or null if no PDX serializer is defined.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the PdxSerializer used by this cache, or null if no PDX serializer is defined</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxSerializer-org.apache.geode.pdx.PdxSerializer-"><code>CacheFactory.setPdxSerializer(PdxSerializer)</code></a>,
<a href="../../../../org/apache/geode/cache/client/ClientCacheFactory.html#setPdxSerializer-org.apache.geode.pdx.PdxSerializer-"><code>ClientCacheFactory.setPdxSerializer(PdxSerializer)</code></a></dd>
</dl>
</li>
</ul>
<a name="getPdxDiskStore--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPdxDiskStore</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPdxDiskStore()</pre>
<div class="block">Returns the disk store used for PDX meta data</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the disk store used for PDX meta data</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxDiskStore-java.lang.String-"><code>CacheFactory.setPdxDiskStore(String)</code></a>,
<a href="../../../../org/apache/geode/cache/client/ClientCacheFactory.html#setPdxDiskStore-java.lang.String-"><code>ClientCacheFactory.setPdxDiskStore(String)</code></a></dd>
</dl>
</li>
</ul>
<a name="getPdxPersistent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPdxPersistent</h4>
<pre>boolean&nbsp;getPdxPersistent()</pre>
<div class="block">Returns true if the PDX metadata for this cache is persistent</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the PDX metadata for this cache is persistent</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxPersistent-boolean-"><code>CacheFactory.setPdxPersistent(boolean)</code></a>,
<a href="../../../../org/apache/geode/cache/client/ClientCacheFactory.html#setPdxPersistent-boolean-"><code>ClientCacheFactory.setPdxPersistent(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="getPdxIgnoreUnreadFields--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPdxIgnoreUnreadFields</h4>
<pre>boolean&nbsp;getPdxIgnoreUnreadFields()</pre>
<div class="block">Returns true if fields that are not read during PDX deserialization should be ignored during
the PDX serialization.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether fields that are not read during PDX deserialization should be ignored during
the PDX serialization</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxIgnoreUnreadFields-boolean-"><code>CacheFactory.setPdxIgnoreUnreadFields(boolean)</code></a>,
<a href="../../../../org/apache/geode/cache/client/ClientCacheFactory.html#setPdxIgnoreUnreadFields-boolean-"><code>ClientCacheFactory.setPdxIgnoreUnreadFields(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="registerPdxMetaData-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerPdxMetaData</h4>
<pre>void&nbsp;registerPdxMetaData(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;instance)</pre>
<div class="block">Registers PDX meta-data given an instance of a domain class that will be serialized
with PDX.
<p>
Note that this method serializes the given instance so PDX must already be configured
to do the serialization.
<p>
Note that if the instance is not of a class that will be serialized with PDX
then no meta-data is registered.
<p>
Note that in most cases this method never needs to be called. Currently it is only
needed by the JdbcLoader when gets are done for JDBC data that was not written to the
table using geode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>instance</code> - the instance of the domain class for which meta-data is to be registered</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/geode/SerializationException.html" title="class in org.apache.geode">SerializationException</a></code> - if the instance can not be serialized or is not serialized with
PDX</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Geode 1.6</dd>
</dl>
</li>
</ul>
<a name="getCacheTransactionManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheTransactionManager</h4>
<pre><a href="../../../../org/apache/geode/cache/CacheTransactionManager.html" title="interface in org.apache.geode.cache">CacheTransactionManager</a>&nbsp;getCacheTransactionManager()</pre>
<div class="block">Get the CacheTransactionManager instance for this Cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CacheTransactionManager instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/geode/cache/CacheClosedException.html" title="class in org.apache.geode.cache">CacheClosedException</a></code> - if the cache is closed.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.0</dd>
</dl>
</li>
</ul>
<a name="getJNDIContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJNDIContext</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/Context.html?is-external=true" title="class or interface in javax.naming">Context</a>&nbsp;getJNDIContext()</pre>
<div class="block">Returns the JNDI context associated with the Cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>javax.naming.Context Added as part of providing JTA implementation in Gemfire.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.0</dd>
</dl>
</li>
</ul>
<a name="getInitializer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitializer</h4>
<pre><a href="../../../../org/apache/geode/cache/Declarable.html" title="interface in org.apache.geode.cache">Declarable</a>&nbsp;getInitializer()</pre>
<div class="block">Returns the Declarable used to initialize this cache or <code>null</code> if it does not have an
initializer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Declarable used to initialize this cache</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.6</dd>
</dl>
</li>
</ul>
<a name="getInitializerProps--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInitializerProps</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;getInitializerProps()</pre>
<div class="block">Returns the Properties used to initialize the cache initializer or <code>null</code> if no
initializer properties exist.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Properties used to initialize the cache initializer</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.6</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/geode/cache/GatewayException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/cache/IncompatibleVersionException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/cache/GemFireCache.html" target="_top">Frames</a></li>
<li><a href="GemFireCache.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>