| <!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>org.apache.geode.cache.client (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="org.apache.geode.cache.client (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/asyncqueue/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/geode/cache/client/proxy/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/client/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.geode.cache.client</h1> |
| <div class="docSummary"> |
| <div class="block">The <code>org.apache.geode.cache.client</code> package provides APIs used |
| for client connectivity and caching.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/ClientCache.html" title="interface in org.apache.geode.cache.client">ClientCache</a></td> |
| <td class="colLast"> |
| <div class="block">A ClientCache instance controls the life cycle of the local singleton cache in a client.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/ClientRegionFactory.html" title="interface in org.apache.geode.cache.client">ClientRegionFactory</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">A factory for constructing <a href="../../../../../org/apache/geode/cache/client/ClientCache.html" title="interface in org.apache.geode.cache.client"><code>client cache</code></a> <a href="../../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>regions</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/Pool.html" title="interface in org.apache.geode.cache.client">Pool</a></td> |
| <td class="colLast"> |
| <div class="block">A pool for connections from a client to a set of GemFire Cache Servers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/PoolFactory.html" title="interface in org.apache.geode.cache.client">PoolFactory</a></td> |
| <td class="colLast"> |
| <div class="block">This interface provides for the configuration and creation of instances of <a href="../../../../../org/apache/geode/cache/client/Pool.html" title="interface in org.apache.geode.cache.client"><code>Pool</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/SocketFactory.html" title="interface in org.apache.geode.cache.client">SocketFactory</a></td> |
| <td class="colLast"> |
| <div class="block">A socket factory used to create sockets from a client to locators or servers.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/ClientCacheFactory.html" title="class in org.apache.geode.cache.client">ClientCacheFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory class used to create the singleton <a href="../../../../../org/apache/geode/cache/client/ClientCache.html" title="interface in org.apache.geode.cache.client"><code>client cache</code></a> and connect to one or |
| more GemFire Cache Servers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/PoolManager.html" title="class in org.apache.geode.cache.client">PoolManager</a></td> |
| <td class="colLast"> |
| <div class="block">Manages creation and access to <a href="../../../../../org/apache/geode/cache/client/Pool.html" title="interface in org.apache.geode.cache.client"><code>connection pools</code></a> for clients.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a></td> |
| <td class="colLast"> |
| <div class="block">Each enum represents a predefined <a href="../../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache"><code>RegionAttributes</code></a> in a <a href="../../../../../org/apache/geode/cache/client/ClientCache.html" title="interface in org.apache.geode.cache.client"><code>ClientCache</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/AllConnectionsInUseException.html" title="class in org.apache.geode.cache.client">AllConnectionsInUseException</a></td> |
| <td class="colLast"> |
| <div class="block">Indicates that the connection pool is at its maximum size and all connections are in use.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/ClientNotReadyException.html" title="class in org.apache.geode.cache.client">ClientNotReadyException</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 6.5 this exception is no longer thrown by GemFire so any code that catches it |
| should be removed.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/NoAvailableLocatorsException.html" title="class in org.apache.geode.cache.client">NoAvailableLocatorsException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception indicating that there are no active locators available to connect to.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/NoAvailableServersException.html" title="class in org.apache.geode.cache.client">NoAvailableServersException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception indicating that there are no active servers available to connect to.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/ServerConnectivityException.html" title="class in org.apache.geode.cache.client">ServerConnectivityException</a></td> |
| <td class="colLast"> |
| <div class="block">A generic exception indicating that a failure has happened while communicating with a gemfire |
| server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/ServerOperationException.html" title="class in org.apache.geode.cache.client">ServerOperationException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception indicating that a failure has happened on the server while processing an operation |
| that was sent to it by a client.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/ServerRefusedConnectionException.html" title="class in org.apache.geode.cache.client">ServerRefusedConnectionException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>ServerRefusedConnectionException</code> indicates a client attempted to connect to a |
| server, but the handshake was rejected.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/client/SubscriptionNotEnabledException.html" title="class in org.apache.geode.cache.client">SubscriptionNotEnabledException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception indicating that client subscriptions are not enabled on this client, but the client |
| is trying to perform an operation that requires a client subscription, such as |
| <a href="../../../../../org/apache/geode/cache/Region.html#registerInterest-K-"><code>Region.registerInterest(Object)</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.geode.cache.client Description">Package org.apache.geode.cache.client Description</h2> |
| <div class="block">The <code>org.apache.geode.cache.client</code> package provides APIs used |
| for client connectivity and caching. |
| <p> |
| Most clients will only need to create a |
| <a href="../../../../../org/apache/geode/cache/client/ClientCache.html" title="interface in org.apache.geode.cache.client"><code>ClientCache</code></a> |
| using a |
| <a href="../../../../../org/apache/geode/cache/client/ClientCacheFactory.html" title="class in org.apache.geode.cache.client"><code>ClientCacheFactory</code></a>. |
| <p> |
| A client configures the servers it will connect to by creating one or more |
| <a href="../../../../../org/apache/geode/cache/client/Pool.html" title="interface in org.apache.geode.cache.client"><code>pools</code></a>. |
| For most use cases one pool per client is all you need and the easiest |
| way to get a single pool is to use |
| <a href="../../../../../org/apache/geode/cache/client/ClientCacheFactory.html" title="class in org.apache.geode.cache.client"><code>ClientCacheFactory</code></a>. |
| If you do need more than one pool use a |
| <a href="../../../../../org/apache/geode/cache/client/PoolFactory.html" title="interface in org.apache.geode.cache.client"><code>pool factory</code></a> obtained from the |
| <a href="../../../../../org/apache/geode/cache/client/PoolManager.html" title="class in org.apache.geode.cache.client"><code>pool manager</code></a> before you |
| create the cache using |
| <a href="../../../../../org/apache/geode/cache/client/ClientCacheFactory.html" title="class in org.apache.geode.cache.client"><code>ClientCacheFactory</code></a>. |
| <p> |
| An alternative to these APIs is to use the <code>pool</code> XML element |
| as described in the <code>cache6_5.dtd</code>. |
| <p> |
| If you create more than one pool then for regions that will use a pool you |
| need to configure the pool name on the regions. |
| This can be done by setting the |
| pool name on the region using the |
| <a href="../../../../../org/apache/geode/cache/client/ClientRegionFactory.html#setPoolName-java.lang.String-"><code>API</code></a> |
| or using the <code>pool-name</code> attribute on the <code>region-attributes</code> |
| as described in the <code>cache6_5.dtd</code>. |
| |
| <a name="declarative"><h2>Client Declarative Caching</h2> |
| |
| <p>A "caching XML file" declares regions, entries, and attributes. When |
| a <code>ClientCache</code> is created its contents can be initialized |
| according to a caching XML file. |
| The top level element must be a client-cache element. |
| </p> |
| |
| <p>The Document Type Definition for a declarative cache XML file can |
| be found in <code>"doc-files/cache6_5.dtd"</code>. |
| For examples of declarative cache XML files see <A |
| href="../../../../../javadoc-images/example-client-cache.xml">example1</A>.</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/asyncqueue/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/geode/cache/client/proxy/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/client/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
