blob: eeb68f270c08822f2ef0c2b8ca717693097ca38f [file] [log] [blame]
---
title: Region Attributes
---
<!--
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.
-->
Region attributes govern the automated management of a region and its entries.
Region attribute settings determine where the data resides, how the region is managed in memory, and the automatic loading, distribution, and expiration of region entries.
## <a id="specifying-region-attributes" class="no-quick-link"></a>Specifying Region Attributes
Specify region attributes before creating the region. You can do this either through the API or
through the declarative XML file. The API includes classes for defining a region's attributes before
creation and for modifying some attributes after creation. For details, see the API for
`RegionShortcut`, `RegionAttributes`, `RegionAttributesFactory`, and `AttributesMutator`.
## <a id="region-shortcuts" class="no-quick-link"></a>Region Shortcuts
<%=vars.product_name%> provides predefined, shortcut region attributes settings for your use in `RegionShortcut`.
The shortcuts are:
`PROXY`
> does not store data in the client cache, but connects the region to the servers.
`CACHING_PROXY`
> stores data in the client cache and connects the region to the servers.
`CACHING_PROXY_ENTRY_LRU`
> stores data in the client cache and connects the region to the servers.
Limits the amount of data stored locally in the client to a default limit of 100,000 entries by ejecting the least recently used (LRU) entries.
`LOCAL`
> stores data in the client cache and does not connect the region to the servers. This is a client-side-only region.
`LOCAL_ENTRY_LRU`
> stores data in the client cache and does not connect the region to the servers. This is a client-side-only region.
Limits the amount of data stored locally in the client to a default limit of 100,000 entries by ejecting the least recently used (LRU) entries.