blob: e94a6d0e42fd68c8e25984bd539f9913aea2e062 [file] [log] [blame]
---
title: Managing a Client Cache
---
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
You have several options for client cache configuration. Start your client cache using a combination of XML declarations and API calls. Close the client cache when you are done.
<a id="managing_a_client_cache__section_566044C44C434926A7A9FBAB2BF463BF"></a>
<%=vars.product_name%> clients are processes that send most or all of their data requests and updates to a <%=vars.product_name%> server system. Clients run as standalone processes, without peers of their own.
**Note:**
<%=vars.product_name%> automatically configures the cluster for your `ClientCache` as standalone, which means the client has no peers. Do not try to set the `gemfire.properties` `mcast-port` or `locators` for a client application or the system will throw an exception.
1. Create your client cache:
1. In your `cache.xml`, use the `client-cache` DOCTYPE and configure your cache inside a `<client-cache>` element. Configure your server connection pool and your regions as needed. Example:
``` pre
<?xml version="1.0" encoding="UTF-8"?>
<client-cache
xmlns="http://geode.apache.org/schema/cache"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://geode.apache.org/schema/cache http://geode.apache.org/schema/cache/cache-1.0.xsd"
version="1.0">
<pool name="serverPool">
<locator host="host1" port="44444"/>
</pool>
<region name="exampleRegion" refid="PROXY"/>
</client-cache>
```
**Note:**
Applications that use a `client-cache` may want to set `concurrency-checks-enabled` to false for a region in order to see all events for that region. <%=vars.product_name%> server members can continue using concurrency checks, but they will pass all events to the client cache. This configuration ensures that the client sees all region events, but it does not prevent the client cache region from becoming out-of-sync with the server cache. See [Consistency for Region Updates](../../developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045).
2. If you use multiple server pools, configure the pool name explicitly for each client region. Example:
``` pre
<pool name="svrPool1">
<locator host="host1" port="40404"/>
</pool>
<pool name="svrPool2">
<locator host="host2" port="40404"/>
</pool>
<region name="clientR1" refid="PROXY" pool-name="svrPool1"/>
<region name="clientR2" refid="PROXY" pool-name="svrPool2"/>
<region name="clientsPrivateR" refid="LOCAL"/>
```
3. In your Java client application, create the cache using the `ClientCacheFactory` `create` method. Example:
``` pre
ClientCache clientCache = new ClientCacheFactory().create();
```
This creates the server connections and initializes the clients cache according to your `gemfire.properties` and `cache.xml` specifications.
2. Close your cache when you are done using the `close` method of your `Cache` instance:
``` pre
cache.close();
```
If your client is durable and you want to maintain your durable queues while the client cache is closed, use:
``` pre
clientCache.close(true);
```