Google Git
Sign in
apache / geode-site / asf-site / . / releases / latest / javadoc / org / apache / geode / cache / DynamicRegionFactory.html
blob: eae0e30ad885958339a0911679169e04b7e24cfa [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>DynamicRegionFactory (Apache Geode 1.15.1)</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="DynamicRegionFactory (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":42,"i5":41,"i6":42,"i7":42,"i8":42,"i9":42,"i10":42,"i11":42,"i12":42,"i13":41,"i14":42,"i15":42};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/DuplicatePrimaryPartitionException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.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/DynamicRegionFactory.html" target="_top">Frames</a></li>
<li><a href="DynamicRegionFactory.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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="Class DynamicRegionFactory" class="title">Class DynamicRegionFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.geode.cache.DynamicRegionFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This class is deprecated. Use <a href="../../../../org/apache/geode/cache/execute/FunctionService.html" title="class in org.apache.geode.cache.execute"><code>FunctionService</code></a> to create regions on other
members instead.</span></div>
</div>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public abstract class <span class="typeNameLabel">DynamicRegionFactory</span>
extends <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></pre>
<div class="block">DynamicRegionFactory provides a distributed region creation service. Any other member of the
GemFire DistributedSystem that has created an instance of this class will automatically
instantiate regions created through the factory from anywhere else in the DistributedSystem.
<p>
Instructions for Use:<br>
<ul>
<li>If your application is a client in a client/server installation, either specify the pool name
in the <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache"><code>DynamicRegionFactory.Config</code></a> you'll use to create a DynamicRegionFactory <i>or</i>
specify it in a dynamic-region-factory element in your cache.xml.
<li>Before you've created a GemFire Cache in your application, add a line of code as follows:<br>
<pre>
{
DynamicRegionFactory factory = DynamicRegionFactory.get();
factory.open(config);
}
</pre>
<pre>
{
DynamicRegionFactory myFactoryHandle = DynamicRegionFactory.get().open(config);
}
</pre>
or just use a dynamic-region-factory element in the cache.xml.
<li>Create the GemFire Cache. During cache creation, the list of dynamic Regions will either be
discovered by recovering their names from disk (see
<a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html#persistBackup"><code>DynamicRegionFactory.Config.persistBackup</code></a>) or from other members of the distributed
system. These dynamic Regions will be created before Cache creation completes.
<li>Thereafter, when you want to create dynamic distributed Regions, create them using the
<a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#createDynamicRegion-java.lang.String-java.lang.String-"><code>createDynamicRegion(java.lang.String, java.lang.String)</code></a>. Regions created with the factory will inherit their
RegionAttributes from their parent Region, though you can override callbacks when you configure
the factory.
<p>
All other instances of GemFire across the distributed system that instantiate and open a
DynamicRegionFactory will also get the dynamic distributed Regions.
<li>Non-dynamic parent Regions should be declared in cache.xml so that they can be created before
the dynamic Region factory goes active and starts creating Regions. You will have cache creation
problems if this isn't done.
<li>A DynamicRegionListener can be registered before open is called and before cache creation so
that the listener will be called if dynamic Regions are created during cache creation.
</ul>
<p>
Saving the factory on disk: If <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html#persistBackup"><code>DynamicRegionFactory.Config.persistBackup</code></a> is configured
for the factory, dynamic Region information is written to disk for recovery. By default the
current directory is used for this information. The <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html#diskDir"><code>DynamicRegionFactory.Config.diskDir</code></a>
can be used to change this default.
<p>
Registering interest in cache server information: The
<a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html#registerInterest"><code>DynamicRegionFactory.Config.registerInterest</code></a> setting determines whether clients will
register interest in server keys or not. You will generally want this to be turned on so that
clients will see updates made to servers. In server processes, DynamicRegionFactory forces use of
NotifyBySubscription.
<p>
Notes:
<ul>
<li>DynamicRegionFactories in non-client VMs must not be configured with a pool.
<li>If <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#open--"><code>open()</code></a> is called before cache creation and the cache.xml has a
dynamic-region-factory element then the cache.xml will override the open call's configuration.
<li>Since the RegionAttributes of a dynamically created Region are copied from the parent Region,
any callbacks, (<a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache"><code>CacheListener</code></a>, <a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache"><code>CacheWriter</code></a>, and <a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache"><code>CacheLoader</code></a> are shared by
the parent and all its dynamic children so make sure the callback is thread-safe and that its
<a href="../../../../org/apache/geode/cache/CacheCallback.html#close--"><code>CacheCallback.close()</code></a> implementation does not stop it from functioning. However the
products EvictionAlgorithm instances will be cloned so that each dynamic Region has its own
callback.
<li>The root Region name "DynamicRegions" is reserved. The factory creates a root Region of that
name and uses it to keep track of what dynamic Regions exist. Applications should not directly
access this Region; instead use the methods on this factory.
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.3</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache">DynamicRegionFactory.Config</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Configuration for dynamic region factory.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/DynamicRegionFactory.html#DYNAMIC_REGION_LIST_NAME">DYNAMIC_REGION_LIST_NAME</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#DynamicRegionFactory--">DynamicRegionFactory</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#buildDynamicRegion-org.apache.geode.cache.EntryEvent-">buildDynamicRegion</a></span>(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a>&nbsp;event)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#createDynamicRegion-java.lang.String-java.lang.String-">createDynamicRegion</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;parentRegionName,
<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;regionName)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Creates the dynamic Region in the local cache and distributes the creation to other caches.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#destroyDynamicRegion-java.lang.String-">destroyDynamicRegion</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;fullRegionName)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Destroys the dynamic Region in the local cache and distributes the destruction to other caches.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#doClose--">doClose</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Closes the dynamic region factory, disabling any further creation or destruction of dynamic
regions in this cache.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#doInternalInit-org.apache.geode.internal.cache.InternalCache-">doInternalInit</a></span>(org.apache.geode.internal.cache.InternalCache&nbsp;theCache)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">The method is for internal use only.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html" title="class in org.apache.geode.cache">DynamicRegionFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#get--">get</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>DynamicRegionFactory</code> singleton instance.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache">DynamicRegionFactory.Config</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#getConfig--">getConfig</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the configuration for this factory.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#isActive--">isActive</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns true if this factory is open and can produce dynamic regions.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#isClosed--">isClosed</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns true if dynamic region factory is closed.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#isOpen--">isOpen</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns true if dynamic region factory is open; false if closed.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#open--">open</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Opens the DynamicRegionFactory with default settings.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#open-org.apache.geode.cache.DynamicRegionFactory.Config-">open</a></span>(<a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache">DynamicRegionFactory.Config</a>&nbsp;conf)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Opens the factory with the given settings.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#razeDynamicRegion-org.apache.geode.cache.EntryEvent-">razeDynamicRegion</a></span>(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a>&nbsp;event)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#regionIsDynamicRegionList-java.lang.String-">regionIsDynamicRegionList</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;regionPath)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#registerDynamicRegionListener-org.apache.geode.cache.DynamicRegionListener-">registerDynamicRegionListener</a></span>(<a href="../../../../org/apache/geode/cache/DynamicRegionListener.html" title="interface in org.apache.geode.cache">DynamicRegionListener</a>&nbsp;listener)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Registers a <code>DynamicRegionListener</code> for callbacks.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#unregisterDynamicRegionListener-org.apache.geode.cache.DynamicRegionListener-">unregisterDynamicRegionListener</a></span>(<a href="../../../../org/apache/geode/cache/DynamicRegionListener.html" title="interface in org.apache.geode.cache">DynamicRegionListener</a>&nbsp;listener)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Unregisters a <code>DynamicRegionListener</code> for callbacks.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<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></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DYNAMIC_REGION_LIST_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DYNAMIC_REGION_LIST_NAME</h4>
<pre>public static final&nbsp;<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> DYNAMIC_REGION_LIST_NAME</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DynamicRegionFactory.DYNAMIC_REGION_LIST_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DynamicRegionFactory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DynamicRegionFactory</h4>
<pre>public&nbsp;DynamicRegionFactory()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="open--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public&nbsp;void&nbsp;open()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Opens the DynamicRegionFactory with default settings.</div>
</li>
</ul>
<a name="open-org.apache.geode.cache.DynamicRegionFactory.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public&nbsp;void&nbsp;open(<a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache">DynamicRegionFactory.Config</a>&nbsp;conf)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Opens the factory with the given settings. This should be sent to the factory before creating a
cache. The cache will otherwise open a factory with default settings. This does not need to be
sent if the cache.xml declares the use of dynamic regions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - the configuration for this factory.</dd>
</dl>
</li>
</ul>
<a name="doClose--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doClose</h4>
<pre>protected&nbsp;void&nbsp;doClose()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Closes the dynamic region factory, disabling any further creation or destruction of dynamic
regions in this cache.</div>
</li>
</ul>
<a name="isOpen--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOpen</h4>
<pre>public&nbsp;boolean&nbsp;isOpen()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns true if dynamic region factory is open; false if closed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this dynamic region factory is open</dd>
</dl>
</li>
</ul>
<a name="isActive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isActive</h4>
<pre>public&nbsp;boolean&nbsp;isActive()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns true if this factory is open and can produce dynamic regions. Factories are only active
after their cache has been created.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this factory is open and can produce dynamic regions</dd>
</dl>
</li>
</ul>
<a name="isClosed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClosed</h4>
<pre>public&nbsp;boolean&nbsp;isClosed()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns true if dynamic region factory is closed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the dynamic region factory is closed</dd>
</dl>
</li>
</ul>
<a name="getConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre>public&nbsp;<a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache">DynamicRegionFactory.Config</a>&nbsp;getConfig()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the configuration for this factory. Returns null if the factory is closed;</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configuration for this factory</dd>
</dl>
</li>
</ul>
<a name="regionIsDynamicRegionList-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>regionIsDynamicRegionList</h4>
<pre>public static&nbsp;boolean&nbsp;regionIsDynamicRegionList(<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;regionPath)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="doInternalInit-org.apache.geode.internal.cache.InternalCache-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doInternalInit</h4>
<pre>protected&nbsp;void&nbsp;doInternalInit(org.apache.geode.internal.cache.InternalCache&nbsp;theCache)
throws <a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">The method is for internal use only. It is called implicitly during cache creation.
<p>
This method is called internally during cache initialization at the correct time. Initialize
the factory with a GemFire Cache. We create the metadata Region which holds all our dynamically
created regions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theCache</code> - The GemFire <code>Cache</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code></dd>
</dl>
</li>
</ul>
<a name="get--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html" title="class in org.apache.geode.cache">DynamicRegionFactory</a>&nbsp;get()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>DynamicRegionFactory</code> singleton instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>DynamicRegionFactory</code> singleton instance</dd>
</dl>
</li>
</ul>
<a name="registerDynamicRegionListener-org.apache.geode.cache.DynamicRegionListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerDynamicRegionListener</h4>
<pre>public&nbsp;void&nbsp;registerDynamicRegionListener(<a href="../../../../org/apache/geode/cache/DynamicRegionListener.html" title="interface in org.apache.geode.cache">DynamicRegionListener</a>&nbsp;listener)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Registers a <code>DynamicRegionListener</code> for callbacks.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - The <code>DynamicRegionListener</code> to be registered</dd>
</dl>
</li>
</ul>
<a name="unregisterDynamicRegionListener-org.apache.geode.cache.DynamicRegionListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unregisterDynamicRegionListener</h4>
<pre>public&nbsp;void&nbsp;unregisterDynamicRegionListener(<a href="../../../../org/apache/geode/cache/DynamicRegionListener.html" title="interface in org.apache.geode.cache">DynamicRegionListener</a>&nbsp;listener)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Unregisters a <code>DynamicRegionListener</code> for callbacks.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - The <code>DynamicRegionListener</code> to be unregistered</dd>
</dl>
</li>
</ul>
<a name="createDynamicRegion-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDynamicRegion</h4>
<pre>public&nbsp;<a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a>&nbsp;createDynamicRegion(<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;parentRegionName,
<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;regionName)
throws <a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Creates the dynamic Region in the local cache and distributes the creation to other caches.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parentRegionName</code> - the new region is created as a subregion of the region having this path</dd>
<dd><code>regionName</code> - the name of the new subregion</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>Region</code> created</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code></dd>
</dl>
</li>
</ul>
<a name="destroyDynamicRegion-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroyDynamicRegion</h4>
<pre>public&nbsp;void&nbsp;destroyDynamicRegion(<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;fullRegionName)
throws <a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Destroys the dynamic Region in the local cache and distributes the destruction to other caches.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fullRegionName</code> - The full path of the <code>Region</code> to be dynamically destroyed</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/geode/cache/RegionDestroyedException.html" title="class in org.apache.geode.cache">RegionDestroyedException</a></code> - if the dynamic region was never created or has already been
destroyed</dd>
<dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code></dd>
</dl>
</li>
</ul>
<a name="buildDynamicRegion-org.apache.geode.cache.EntryEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildDynamicRegion</h4>
<pre>protected&nbsp;void&nbsp;buildDynamicRegion(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a>&nbsp;event)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="razeDynamicRegion-org.apache.geode.cache.EntryEvent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>razeDynamicRegion</h4>
<pre>protected&nbsp;void&nbsp;razeDynamicRegion(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a>&nbsp;event)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</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/DuplicatePrimaryPartitionException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.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/DynamicRegionFactory.html" target="_top">Frames</a></li>
<li><a href="DynamicRegionFactory.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>