GEODE-1914 Removed old dtds from geode source code(kept 7.0 and above) Deteted old tests and updated test xmls to point 7.0 dtd
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/952ab6fa Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/952ab6fa Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/952ab6fa Branch: refs/heads/feature/GEODE-1801 Commit: 952ab6fa2fa166225d7a7fbfeca9e24852402e38 Parents: 9b6c10b Author: Hitesh Khamesra <[email protected]> Authored: Fri Oct 7 09:43:43 2016 -0700 Committer: Udo Kohlmeyer <[email protected]> Committed: Tue Oct 11 14:06:53 2016 +1100 ---------------------------------------------------------------------- .../javadoc-images/example-client-cache.xml | 4 +- .../org/apache/geode/admin/doc-files/ds4_0.dtd | 176 - .../org/apache/geode/admin/doc-files/ds5_0.dtd | 168 - .../apache/geode/cache/doc-files/cache3_0.dtd | 296 -- .../apache/geode/cache/doc-files/cache4_0.dtd | 392 -- .../apache/geode/cache/doc-files/cache4_1.dtd | 485 -- .../apache/geode/cache/doc-files/cache5_0.dtd | 519 -- .../apache/geode/cache/doc-files/cache5_1.dtd | 534 -- .../apache/geode/cache/doc-files/cache5_5.dtd | 651 --- .../apache/geode/cache/doc-files/cache5_7.dtd | 776 --- .../apache/geode/cache/doc-files/cache5_8.dtd | 794 --- .../apache/geode/cache/doc-files/cache6_0.dtd | 862 --- .../apache/geode/cache/doc-files/cache6_1.dtd | 871 ---- .../apache/geode/cache/doc-files/cache6_5.dtd | 949 ---- .../apache/geode/cache/doc-files/cache6_6.dtd | 1006 ---- .../geode/cache/RegionFactoryJUnitTest.java | 8 +- .../geode/cache30/CacheXml30DUnitTest.java | 845 --- .../geode/cache30/CacheXml40DUnitTest.java | 152 - .../geode/cache30/CacheXml41DUnitTest.java | 664 --- .../geode/cache30/CacheXml45DUnitTest.java | 424 -- .../geode/cache30/CacheXml51DUnitTest.java | 375 -- .../geode/cache30/CacheXml55DUnitTest.java | 58 - .../geode/cache30/CacheXml57DUnitTest.java | 662 --- .../geode/cache30/CacheXml58DUnitTest.java | 518 -- .../geode/cache30/CacheXml60DUnitTest.java | 346 -- .../geode/cache30/CacheXml61DUnitTest.java | 98 - .../geode/cache30/CacheXml65DUnitTest.java | 1211 ----- .../geode/cache30/CacheXml66DUnitTest.java | 4935 +++++++++++++++++- .../geode/internal/JarClassLoaderJUnitTest.java | 4 +- .../geode/pdx/PdxSerializableJUnitTest.java | 8 +- geode-core/src/test/resources/jta/cachejta.xml | 4 +- .../ClientCacheFactoryJUnitTest_single_pool.xml | 4 +- .../functional/index-creation-with-eviction.xml | 4 +- .../index-creation-without-eviction.xml | 4 +- .../functional/index-recovery-overflow.xml | 4 +- .../query/internal/index/cachequeryindex.xml | 2 +- .../internal/index/cachequeryindexwitherror.xml | 2 +- .../cache/query/partitioned/PRIndexCreation.xml | 4 +- .../geode/cache30/attributesUnordered.xml | 4 +- .../org/apache/geode/cache30/badFloat.xml | 6 +- .../org/apache/geode/cache30/badInt.xml | 6 +- .../geode/cache30/badKeyConstraintClass.xml | 6 +- .../org/apache/geode/cache30/badScope.xml | 4 +- .../geode/cache30/callbackNotDeclarable.xml | 8 +- .../geode/cache30/callbackWithException.xml | 8 +- .../org/apache/geode/cache30/coLocation.xml | 2 +- .../org/apache/geode/cache30/ewtest.xml | 2 +- .../cache30/examples_3_0/example-cache.xml | 4 +- .../cache30/examples_4_0/example-cache.xml | 4 +- .../apache/geode/cache30/loaderNotLoader.xml | 8 +- .../org/apache/geode/cache30/malformed.xml | 4 +- .../apache/geode/cache30/namedAttributes.xml | 6 +- .../apache/geode/cache30/partitionedRegion.xml | 4 +- .../geode/cache30/partitionedRegion51.xml | 4 +- .../org/apache/geode/cache30/sameRootRegion.xml | 6 +- .../org/apache/geode/cache30/sameSubregion.xml | 6 +- .../geode/cache30/unknownNamedAttributes.xml | 6 +- .../internal/cache/BackupJUnitTest.cache.xml | 2 +- .../internal/cache/DiskRegCacheXmlJUnitTest.xml | 4 +- .../cache/PartitionRegionCacheExample1.xml | 2 +- .../cache/PartitionRegionCacheExample2.xml | 2 +- .../incorrect_bytes_threshold.xml | 2 +- .../faultyDiskXMLsForTesting/incorrect_dir.xml | 2 +- .../incorrect_dir_size.xml | 2 +- .../incorrect_max_oplog_size.xml | 2 +- .../incorrect_roll_oplogs_value.xml | 2 +- .../incorrect_sync_value.xml | 2 +- .../incorrect_time_interval.xml | 2 +- .../mixed_diskstore_diskdir.xml | 2 +- .../mixed_diskstore_diskwriteattrs.xml | 2 +- ...testDTDFallbackWithNonEnglishLocal.cache.xml | 4 +- .../org/apache/geode/internal/jta/cachejta.xml | 6 +- .../tier/sockets/durablecq-client-cache.xml | 4 +- .../tier/sockets/durablecq-server-cache.xml | 4 +- .../src/it/resources/test-regions.xml | 4 +- .../src/it/resources/test-retrieve-regions.xml | 4 +- 76 files changed, 4787 insertions(+), 14184 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/952ab6fa/geode-core/src/main/resources/javadoc-images/example-client-cache.xml ---------------------------------------------------------------------- diff --git a/geode-core/src/main/resources/javadoc-images/example-client-cache.xml b/geode-core/src/main/resources/javadoc-images/example-client-cache.xml index bddeb9f..af556f1 100644 --- a/geode-core/src/main/resources/javadoc-images/example-client-cache.xml +++ b/geode-core/src/main/resources/javadoc-images/example-client-cache.xml @@ -19,8 +19,8 @@ <!-- A sample client GemFire declarative caching XML File --> <!DOCTYPE client-cache PUBLIC - "-//GemStone Systems, Inc.//GemFire Declarative Cache 6.5//EN" - "http://www.gemstone.com/dtd/cache6_5.dtd";> + "-//GemStone Systems, Inc.//GemFire Declarative Cache 7.0//EN" + "http://www.gemstone.com/dtd/cache7_0.dtd";> <client-cache copy-on-read="false"> <pool name="myPool"> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/952ab6fa/geode-core/src/main/resources/org/apache/geode/admin/doc-files/ds4_0.dtd ---------------------------------------------------------------------- diff --git a/geode-core/src/main/resources/org/apache/geode/admin/doc-files/ds4_0.dtd b/geode-core/src/main/resources/org/apache/geode/admin/doc-files/ds4_0.dtd deleted file mode 100644 index 6566af6..0000000 --- a/geode-core/src/main/resources/org/apache/geode/admin/doc-files/ds4_0.dtd +++ /dev/null @@ -1,176 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- -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. ---> -<!-- - -This is the XML DTD for the GemFire distributed system administrative -configuration XML file. All configuration files must include a -DOCTYPE of the following form: - - <!DOCTYPE distributed-system PUBLIC - "-//GemStone Systems, Inc.//GemFire Distributed System 4.0//EN" - "http://www.gemstone.com/dtd/ds4_0.dtd";> - -The contents of a distributed system configuration XML file correspond -to APIs found in the - - com.gemstone.gemfire.admin - -package. A distributed system configuration XML file is used by tools -such as the GemFire JMX Agent to initialize information a distributed system. - ---> - -<!-- - -The following conventions apply to all GemFire distributed system -configuration XML file elements unless indicated otherwise. - -- In elements that contain PCDATA, leading and trailing whitespace in - the data may be ignored. - -- In elements whose value is an "enumerated type", the value is case - sensitive. - ---> - -<!-- -The "distributed-system" element is the root of a distributed system -configuration file. It describes the distributed system to be -configured. ---> - -<!ELEMENT distributed-system (remote-command?, discovery, ssl?, - cache-server*, gfx-server*)> -<!ATTLIST distributed-system - id CDATA #IMPLIED -> - -<!-- -The "discovery" element describes the mechanism used to discover -members of the distributed system, either multicast or using -locators. ---> - -<!ELEMENT discovery (multicast | locator+)> - -<!-- -The "multicast" element describes the multicast settings used for -discovery. ---> - -<!ELEMENT multicast EMPTY> -<!ATTLIST multicast - port CDATA #REQUIRED - address CDATA #IMPLIED -> - -<!-- -The "locator" element describes the locator processes that are used -for discovery. ---> - -<!ELEMENT locator (host?, remote-command?, working-directory?, - product-directory?)> -<!ATTLIST locator - port CDATA #REQUIRED -> - -<!-- -The "ssl" element describes how members of the distributed system uses -SSL to communicate. If the "ssl" element is not specified, then ssl -is not enabled. ---> - -<!ELEMENT ssl (protocols?, ciphers?, property*)> -<!ATTLIST ssl - authentication-required (true | false) #IMPLIED -> - -<!-- -The "protocols" element describes the SSL protocols used when members -of the distributed system communicate. ---> - -<!ELEMENT protocols (#PCDATA)> - -<!-- -The "ciphers" element describes the SSL ciphers used when members of -the distributed system communicate. ---> - -<!ELEMENT ciphers (#PCDATA)> - -<!-- -The "property" element describes a SSL-related system property that -should be set. ---> - -<!ELEMENT property (key, value)> -<!ELEMENT key (#PCDATA)> -<!ELEMENT value (#PCDATA)> - -<!-- -The "cache-server" element describes a GemFire distributed cache -server that is managed via the administration API. ---> - -<!ELEMENT cache-server (host?, remote-command?, working-directory?, - product-directory?, classpath?)> - -<!-- -The "classpath" element specifies the location of extra classes -required by a managed entity. ---> - -<!ELEMENT classpath (#PCDATA)> - -<!-- -The "gfx-server" element describes a GemFire/XML server that is -managed via the administration API. ---> - -<!ELEMENT gfx-server (host?, remote-command?, working-directory?, - product-directory?)> - -<!-- -The "host" element specifies a host machine on which a managed entity -runs. ---> - -<!ELEMENT host (#PCDATA)> - -<!-- -The "remote-command" element specifies a prefix to use when launching -managed entities on a remote machine. ---> - -<!ELEMENT remote-command (#PCDATA)> - -<!-- -The "working-directory" element specifies the working directory in -which a managed entity runs. ---> - -<!ELEMENT working-directory (#PCDATA)> - -<!-- -The "product-directory" element specifies the locator of the GemFire -product installation used by a managed entity. ---> - -<!ELEMENT product-directory (#PCDATA)> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/952ab6fa/geode-core/src/main/resources/org/apache/geode/admin/doc-files/ds5_0.dtd ---------------------------------------------------------------------- diff --git a/geode-core/src/main/resources/org/apache/geode/admin/doc-files/ds5_0.dtd b/geode-core/src/main/resources/org/apache/geode/admin/doc-files/ds5_0.dtd deleted file mode 100644 index d56fd4d..0000000 --- a/geode-core/src/main/resources/org/apache/geode/admin/doc-files/ds5_0.dtd +++ /dev/null @@ -1,168 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- -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. ---> -<!-- - -This is the XML DTD for the GemFire distributed system administrative -configuration XML file. All configuration files must include a -DOCTYPE of the following form: - - <!DOCTYPE distributed-system PUBLIC - "-//GemStone Systems, Inc.//GemFire Distributed System 5.0//EN" - "http://www.gemstone.com/dtd/ds5_0.dtd";> - -The contents of a distributed system configuration XML file correspond -to APIs found in the - - com.gemstone.gemfire.admin - -package. A distributed system configuration XML file is used by tools -such as the GemFire JMX Agent to initialize information a distributed system. - ---> - -<!-- - -The following conventions apply to all GemFire distributed system -configuration XML file elements unless indicated otherwise. - -- In elements that contain PCDATA, leading and trailing whitespace in - the data may be ignored. - -- In elements whose value is an "enumerated type", the value is case - sensitive. - ---> - -<!-- -The "distributed-system" element is the root of a distributed system -configuration file. It describes the distributed system to be -configured. ---> - -<!ELEMENT distributed-system (remote-command?, multicast?, locators?, ssl?, - cache-server*)> -<!ATTLIST distributed-system - id CDATA #IMPLIED - disable-tcp (true | false) #IMPLIED -> - -<!-- -The "locators" element must be given unless multicast is to be used -for discovery. ---> - -<!ELEMENT locators (locator+)> - -<!-- -The "multicast" element describes the multicast settings used for -communications and (if locators aren't specified) for discovery. ---> - -<!ELEMENT multicast EMPTY> -<!ATTLIST multicast - port CDATA #REQUIRED - address CDATA #IMPLIED -> - -<!-- -The "locator" element describes the locator processes that are used -for discovery. ---> - -<!ELEMENT locator (host?, remote-command?, working-directory?, - product-directory?)> -<!ATTLIST locator - port CDATA #REQUIRED -> - -<!-- -The "ssl" element describes how members of the distributed system uses -SSL to communicate. If the "ssl" element is not specified, then ssl -is not enabled. ---> - -<!ELEMENT ssl (protocols?, ciphers?, property*)> -<!ATTLIST ssl - authentication-required (true | false) #IMPLIED -> - -<!-- -The "protocols" element describes the SSL protocols used when members -of the distributed system communicate. ---> - -<!ELEMENT protocols (#PCDATA)> - -<!-- -The "ciphers" element describes the SSL ciphers used when members of -the distributed system communicate. ---> - -<!ELEMENT ciphers (#PCDATA)> - -<!-- -The "property" element describes a SSL-related system property that -should be set. ---> - -<!ELEMENT property (key, value)> -<!ELEMENT key (#PCDATA)> -<!ELEMENT value (#PCDATA)> - -<!-- -The "cache-server" element describes a GemFire distributed cache -server that is managed via the administration API. ---> - -<!ELEMENT cache-server (host?, remote-command?, working-directory?, - product-directory?, classpath?)> - -<!-- -The "classpath" element specifies the location of extra classes -required by a managed entity. ---> - -<!ELEMENT classpath (#PCDATA)> - -<!-- -The "host" element specifies a host machine on which a managed entity -runs. ---> - -<!ELEMENT host (#PCDATA)> - -<!-- -The "remote-command" element specifies a prefix to use when launching -managed entities on a remote machine. ---> - -<!ELEMENT remote-command (#PCDATA)> - -<!-- -The "working-directory" element specifies the working directory in -which a managed entity runs. ---> - -<!ELEMENT working-directory (#PCDATA)> - -<!-- -The "product-directory" element specifies the locator of the GemFire -product installation used by a managed entity. ---> - -<!ELEMENT product-directory (#PCDATA)> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/952ab6fa/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache3_0.dtd ---------------------------------------------------------------------- diff --git a/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache3_0.dtd b/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache3_0.dtd deleted file mode 100644 index 44d42c2..0000000 --- a/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache3_0.dtd +++ /dev/null @@ -1,296 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- -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. ---> -<!-- - -This is the XML DTD for the GemFire distributed cache declarative -caching XML file. All declarative cache files must include a DOCTYPE -of the following form: - - <!DOCTYPE cache PUBLIC - "-//GemStone Systems, Inc.//GemFire Declarative Caching 3.0//EN" - "http://www.gemstone.com/dtd/cache3_0.dtd";> - -The contents of a declarative XML file correspond to APIs found in the - - com.gemstone.gemfire.cache - -package. A declarative caching XML file is used to populate a Cache -when it is created. - ---> - -<!-- - -The following conventions apply to all GemFire distributed cache -declarative caching XML file elements unless indicated otherwise. - -- In elements that contain PCDATA, leading and trailing whitespace in - the data may be ignored. - -- In elements whose value is an "enumerated type", the value is case - sensitive. - ---> - -<!-- -The "cache" element is the root element of the declarative cache file. -This element configures a GemFire Cache and describes the root regions it -contains, if any. ---> - -<!ELEMENT cache (vm-root-region|shared-root-region)*> -<!ATTLIST cache - lock-timeout CDATA #IMPLIED - lock-lease CDATA #IMPLIED - search-timeout CDATA #IMPLIED -> - -<!-- -A "vm-root-region" element describes a root region whose entries and -subregions will be stored in VM local memory. -Note that the "name" attribute specifies the simple name of the region; -it cannot contain a "/". ---> - -<!ELEMENT vm-root-region (region-attributes, entry*, region*)> -<!ATTLIST vm-root-region - name CDATA #REQUIRED -> - -<!-- -A "shared-root-region" element describes a root region whose entries -and subregions will be stored in shared memory. -Note that the "name" attribute specifies the simple name of the region; -it cannot contain a "/". ---> - -<!ELEMENT shared-root-region (region-attributes, entry*, region*)> -<!ATTLIST shared-root-region - name CDATA #REQUIRED -> - -<!-- -A "region" element describes a region (and its entries) in GemFire -distributed cache. It may be used to create a new region or may be -used to add new entries to an existing region. Note that the "name" -attribute specifies the simple name of the region; it cannot contain a -"/". ---> - -<!ELEMENT region (region-attributes, entry*, region*)> -<!ATTLIST region - name CDATA #REQUIRED -> - -<!-- -A "region-attributes" element describes the attributes of a region to -be created. ---> - -<!ELEMENT region-attributes (key-constraint?, region-time-to-live?, - region-idle-time?, entry-time-to-live?, entry-idle-time?, - disk-write-attributes?, disk-dirs?, - cache-loader?, cache-writer?, cache-listener?, eviction-attributes?)> -<!ATTLIST region-attributes - scope (local | distributed-no-ack | distributed-ack | global) #IMPLIED - mirror-type (none | keys | keys-values) #IMPLIED - serialize-values (true | false) #IMPLIED - keep-alive-timeout CDATA #IMPLIED - initial-capacity CDATA #IMPLIED - load-factor CDATA #IMPLIED - concurrency-level CDATA #IMPLIED - persist-backup (true | false) #IMPLIED - statistics-enabled (true | false) #IMPLIED -> - -<!-- Create eviction attributes that monitors and controls the size of the Region ---> -<!ELEMENT eviction-attributes (lru-entry-count|lru-heap-percentage|lru-memory-size)?> - -<!-- Create an LRU eviction controller which performs the action if the - Region has more than the maximum number of Entries in the Region ---> -<!ELEMENT lru-entry-count EMPTY> -<!ATTLIST lru-entry-count - maximum CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- - Create an LRU that measures the JVM heap after each interval, - if the heap is over the maximum percentage, the action is performed. ---> -<!ELEMENT lru-heap-percentage EMPTY> -<!ATTLIST lru-heap-percentage - maximum CDATA #IMPLIED - time-interval CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- - Create an LRU that performs the action when the memory size of the Region is over the - maximum. The optional class-name and parameter allows for the declaration an ObjectSizer which - is used to measure the size of each Object in the Region. The class must implement the ObjectSizer interface. ---> -<!ELEMENT lru-memory-size (class-name, parameter*)?> -<!ATTLIST lru-memory-size - maximum CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - - -<!-- -A "key-constraint" element specifies the name of a class to which the -keys of a region are constrained. ---> - -<!ELEMENT key-constraint (#PCDATA)> - -<!-- -A "region-time-to-live" element specifies a Region's time to live ---> - -<!ELEMENT region-time-to-live (expiration-attributes)> - -<!-- -A "region-idle-time" element specifies a Region's idle time ---> - -<!ELEMENT region-idle-time (expiration-attributes)> - -<!-- -A "entry-time-to-live" element specifies a Region's entries' time to -live ---> - -<!ELEMENT entry-time-to-live (expiration-attributes)> - -<!-- -A "entry-idle-time" element specifies a Region's entries' idle time ---> - -<!ELEMENT entry-idle-time (expiration-attributes)> - -<!-- -An "expiration-attributes" element describes expiration ---> - -<!ELEMENT expiration-attributes EMPTY> -<!ATTLIST expiration-attributes - timeout CDATA #REQUIRED - action (invalidate | destroy | local-invalidate | local-destroy) #IMPLIED -> - -<!-- -An "entry" element desribes an entry to be added to a region. Note -that if an entry with the given key already exists in the region, it -will be replaced. ---> - -<!ELEMENT entry (key, value)> - -<!-- -A "class-name" element specifies the name of a Declarable class, an -instance of which is created when a declarative cache XML file is -read. ---> - -<!ELEMENT class-name (#PCDATA)> - -<!-- -A "parameter" element describes a parameter used to initialize a -Declarable object. ---> - -<!ELEMENT parameter (string | declarable)> -<!ATTLIST parameter - name CDATA #REQUIRED -> - -<!-- -A "cache-loader" element describes a region's CacheLoader ---> - -<!ELEMENT cache-loader (class-name, parameter*)> - -<!-- -A "disk-write-attributes" element describes how entry data is written -to disk. ---> - -<!ELEMENT disk-write-attributes (synchronous-writes | asynchronous-writes)> - -<!-- -A "synchronous-writes" element specifies that entry data should be -written to disk synchronously. ---> - -<!ELEMENT synchronous-writes EMPTY> - -<!-- -An "asynchronous-writes" element specifies how entry data should be -written to disk asynchronous. ---> - -<!ELEMENT asynchronous-writes EMPTY> -<!ATTLIST asynchronous-writes - time-interval CDATA #REQUIRED - bytes-threshold CDATA #REQUIRED -> - -<!-- -A "disk-dirs" element specifies the region's disk directories ---> -<!ELEMENT disk-dirs (disk-dir+)> - -<!-- -A "disk-dir" element specifies one of a region's disk directories ---> - -<!ELEMENT disk-dir (#PCDATA)> - -<!-- -A "cache-writer" element describes a region's CacheWriter ---> - -<!ELEMENT cache-writer (class-name, parameter*)> - - -<!-- -A "cache-listener" element describes a region's CacheListener ---> - -<!ELEMENT cache-listener (class-name, parameter*)> - -<!-- -A "key" element describes the key in a Region entry ---> -<!ELEMENT key (string | declarable)> - -<!-- -A "value" element describes the value in a Region entry ---> -<!ELEMENT value (string | declarable)> - -<!-- -A "string" element specifies a String to placed in a Region entry ---> -<!ELEMENT string (#PCDATA)> - -<!-- -A "declarable" element specifies a Declarable object to be placed in a -Region entry ---> -<!ELEMENT declarable (class-name, parameter*)> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/952ab6fa/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache4_0.dtd ---------------------------------------------------------------------- diff --git a/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache4_0.dtd b/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache4_0.dtd deleted file mode 100644 index d91d50e..0000000 --- a/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache4_0.dtd +++ /dev/null @@ -1,392 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- -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. ---> -<!-- - -This is the XML DTD for the GemFire distributed cache declarative -caching XML file. All declarative cache files must include a DOCTYPE -of the following form: - - <!DOCTYPE cache PUBLIC - "-//GemStone Systems, Inc.//GemFire Declarative Caching 4.0//EN" - "http://www.gemstone.com/dtd/cache4_0.dtd";> - -The contents of a declarative XML file correspond to APIs found in the - - com.gemstone.gemfire.cache - -package. A declarative caching XML file is used to populate a Cache -when it is created. - ---> - -<!-- - -The following conventions apply to all GemFire distributed cache -declarative caching XML file elements unless indicated otherwise. - -- In elements that contain PCDATA, leading and trailing whitespace in - the data may be ignored. - -- In elements whose value is an "enumerated type", the value is case - sensitive. - ---> - -<!-- -The "cache" element is the root element of the declarative cache file. -This element configures a GemFire Cache and describes the root regions it -contains, if any. ---> - -<!ELEMENT cache (cache-transaction-manager?, bridge-server*, (vm-root-region|shared-root-region|jndi-bindings)*)> -<!ATTLIST cache - lock-timeout CDATA #IMPLIED - lock-lease CDATA #IMPLIED - search-timeout CDATA #IMPLIED - is-server (true | false) #IMPLIED - cache-proxy-enabled (true | false) #IMPLIED - copy-on-read (true | false) #IMPLIED -> - -<!-- -A "cache-transaction-manager" describes a cache's transaction manager -which is used to control transactions. ---> -<!ELEMENT cache-transaction-manager (transaction-listener?)> - -<!-- -A "transaction-listener" describes a TransactionListener ---> -<!ELEMENT transaction-listener (class-name, parameter*)> - -<!-- -The "bridge-server" element specifies a Cache Bridge Server that is -started when the Cache is declaratively initialized. ---> -<!ELEMENT bridge-server EMPTY> -<!ATTLIST bridge-server - port CDATA #REQUIRED - deserialize-values (true | false) #IMPLIED -> - -<!-- -A "vm-root-region" element describes a root region whose entries and -subregions will be stored in VM local memory. -Note that the "name" attribute specifies the simple name of the region; -it cannot contain a "/". ---> - -<!ELEMENT vm-root-region (region-attributes, index*, entry*, region*)> -<!ATTLIST vm-root-region - name CDATA #REQUIRED -> - -<!-- -A "shared-root-region" element describes a root region whose entries -and subregions will be stored in shared memory. -Note that the "name" attribute specifies the simple name of the region; -it cannot contain a "/". ---> - -<!ELEMENT shared-root-region (region-attributes, index*, entry*, region*)> -<!ATTLIST shared-root-region - name CDATA #REQUIRED -> - - -<!-- -A "region" element describes a region (and its entries) in GemFire -distributed cache. It may be used to create a new region or may be -used to add new entries to an existing region. Note that the "name" -attribute specifies the simple name of the region; it cannot contain a -"/". ---> - -<!ELEMENT region ( region-attributes, index*, entry*, region* )> -<!ATTLIST region - name CDATA #REQUIRED -> - -<!-- -A "region-attributes" element describes the attributes of a region to -be created. ---> - -<!ELEMENT region-attributes (key-constraint?, value-constraint?, region-time-to-live?, - region-idle-time?, entry-time-to-live?, entry-idle-time?, - disk-write-attributes?, disk-dirs?, - cache-loader?, cache-writer?, cache-listener?, eviction-attributes?)> -<!ATTLIST region-attributes - scope (local | distributed-no-ack | distributed-ack | global) #IMPLIED - mirror-type (none | keys | keys-values) #IMPLIED - serialize-values (true | false) #IMPLIED - keep-alive-timeout CDATA #IMPLIED - initial-capacity CDATA #IMPLIED - load-factor CDATA #IMPLIED - concurrency-level CDATA #IMPLIED - persist-backup (true | false) #IMPLIED - statistics-enabled (true | false) #IMPLIED - index-update-type (synchronous|asynchronous) #IMPLIED - is-lock-grantor (true | false) #IMPLIED -> - -<!-- Create eviction attributes that monitors and controls the size of the Region ---> -<!ELEMENT eviction-attributes (lru-entry-count|lru-heap-percentage|lru-memory-size)?> - -<!-- Create an LRU eviction controller which performs the action if the - Region has more than the maximum number of Entries in the Region ---> -<!ELEMENT lru-entry-count EMPTY> -<!ATTLIST lru-entry-count - maximum CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- - Create an LRU that measures the JVM heap after each interval, - if the heap is over the maximum percentage, the action is performed. ---> -<!ELEMENT lru-heap-percentage EMPTY> -<!ATTLIST lru-heap-percentage - maximum CDATA #IMPLIED - time-interval CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- - Create an LRU that performs the action when the memory size of the Region is over the - maximum. The optional class-name and parameter allows for the declaration an ObjectSizer which - is used to measure the size of each Object in the Region. The class must implement the ObjectSizer interface. ---> -<!ELEMENT lru-memory-size (class-name, parameter*)?> -<!ATTLIST lru-memory-size - maximum CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - - -<!-- An "index" element describes an index to be created on a region in GemfireCache. The index node if any -should all come immediately after the "region-attributes" node. There can be any number of functional type -of index on a Region, but only at max one index of type "primary-key". The "name" attribute is a required -field which identifies the name of the index ---> -<!ELEMENT index (functional|primary-key)> -<!ATTLIST index - name CDATA #REQUIRED -> - -<!-- -A functional type of index needs a from-clause, expression which are mandatory. The import string used for specifying the type of -Object in the region or the type of Object which the indexed expression evaluates to ---> -<!ELEMENT functional EMPTY> - -<!ATTLIST functional - from-clause CDATA #REQUIRED - expression CDATA #REQUIRED - imports CDATA #IMPLIED -> - -<!-- -A primary-key type of index needs a field attribute which is mandatory. There should be only one -or zero primary-index defined for a region ---> -<!ELEMENT primary-key EMPTY> -<!ATTLIST primary-key - field CDATA #REQUIRED -> - -<!-- -A "key-constraint" element specifies the name of a class to which the -keys of a region are constrained. ---> - - -<!ELEMENT key-constraint (#PCDATA)> - -<!-- -A "value-constraint" element specifies the name of a class to which the -values of a region are constrained. ---> - -<!ELEMENT value-constraint (#PCDATA)> - - -<!-- -A "region-time-to-live" element specifies a Region's time to live ---> - -<!ELEMENT region-time-to-live (expiration-attributes)> - -<!-- -A "region-idle-time" element specifies a Region's idle time ---> - -<!ELEMENT region-idle-time (expiration-attributes)> - -<!-- -A "entry-time-to-live" element specifies a Region's entries' time to -live ---> - -<!ELEMENT entry-time-to-live (expiration-attributes)> - -<!-- -A "entry-idle-time" element specifies a Region's entries' idle time ---> - -<!ELEMENT entry-idle-time (expiration-attributes)> - -<!-- -An "expiration-attributes" element describes expiration ---> - -<!ELEMENT expiration-attributes EMPTY> -<!ATTLIST expiration-attributes - timeout CDATA #REQUIRED - action (invalidate | destroy | local-invalidate | local-destroy) #IMPLIED -> - -<!-- -An "entry" element desribes an entry to be added to a region. Note -that if an entry with the given key already exists in the region, it -will be replaced. ---> - -<!ELEMENT entry (key, value)> - -<!-- -A "class-name" element specifies the name of a Declarable class, an -instance of which is created when a declarative cache XML file is -read. ---> - -<!ELEMENT class-name (#PCDATA)> - -<!-- -A "parameter" element describes a parameter used to initialize a -Declarable object. ---> - -<!ELEMENT parameter (string | declarable)> -<!ATTLIST parameter - name CDATA #REQUIRED -> - -<!-- -A "cache-loader" element describes a region's CacheLoader ---> - -<!ELEMENT cache-loader (class-name, parameter*)> - -<!-- -A "disk-write-attributes" element describes how entry data is written -to disk. ---> - -<!ELEMENT disk-write-attributes (synchronous-writes | asynchronous-writes)> - -<!-- -A "synchronous-writes" element specifies that entry data should be -written to disk synchronously. ---> - -<!ELEMENT synchronous-writes EMPTY> - -<!-- -An "asynchronous-writes" element specifies how entry data should be -written to disk asynchronous. ---> - -<!ELEMENT asynchronous-writes EMPTY> -<!ATTLIST asynchronous-writes - time-interval CDATA #REQUIRED - bytes-threshold CDATA #REQUIRED -> - -<!-- -A "disk-dirs" element specifies the region's disk directories ---> -<!ELEMENT disk-dirs (disk-dir+)> - -<!-- -A "disk-dir" element specifies one of a region's disk directories ---> - -<!ELEMENT disk-dir (#PCDATA)> - -<!-- -A "cache-writer" element describes a region's CacheWriter ---> - -<!ELEMENT cache-writer (class-name, parameter*)> - -<!-- -A "cache-listener" element describes a region's CacheListener ---> - -<!ELEMENT cache-listener (class-name, parameter*)> - -<!-- -A "key" element describes the key in a Region entry ---> -<!ELEMENT key (string | declarable)> - -<!-- -A "value" element describes the value in a Region entry ---> -<!ELEMENT value (string | declarable)> - -<!-- -A "string" element specifies a String to placed in a Region entry ---> -<!ELEMENT string (#PCDATA)> - -<!-- -A "declarable" element specifies a Declarable object to be placed in a -Region entry ---> -<!ELEMENT declarable (class-name, parameter*)> -<!-- A jndi-bindings element will contain the jndi-binding for each of the datasources which are to be bound with the JNDI Context --> -<!ELEMENT jndi-bindings (jndi-binding*)> -<!-- For every datasource which is bound to the tree , there wil exist one jndi-binding tag. This tag will describe the - property & configuration of the datasource . The attributes of jndi-binding are used for configuration by Gemfire, while the property element is used to configure the custom property for the datasource. Of the attributes list the type & jndi-name are required. -impleDataSource.xa-datasource-class is needed when type is XAPooledDataSource, while conn-pooled-datasource-class is needed when type is PooledDataSource. jdbc-driver-class is needed when the type is SimpleDataSource.It is advisable to set the user-name & password as attributes rather than as property element. Or they may be set both as attributes of jndi-binding tag as well as attribute of property tag--> -<!ELEMENT jndi-binding (property*)> -<!ATTLIST jndi-binding - type (SimpleDataSource |PooledDataSource|XAPooledDataSource) #REQUIRED - jndi-name CDATA #REQUIRED - init-pool-size CDATA #IMPLIED - max-pool-size CDATA #IMPLIED - idle-timeout-seconds CDATA #IMPLIED - blocking-timeout-seconds CDATA #IMPLIED - login-timeout-seconds CDATA #IMPLIED - conn-pooled-datasource-class CDATA #IMPLIED - xa-datasource-class CDATA #IMPLIED - connection-url CDATA #IMPLIED - jdbc-driver-class CDATA #IMPLIED - user-name CDATA #IMPLIED - password CDATA #IMPLIED -> -<!ELEMENT property EMPTY> -<!ATTLIST property - key CDATA #REQUIRED - value CDATA #REQUIRED -> - - - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/952ab6fa/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache4_1.dtd ---------------------------------------------------------------------- diff --git a/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache4_1.dtd b/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache4_1.dtd deleted file mode 100644 index d64968a..0000000 --- a/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache4_1.dtd +++ /dev/null @@ -1,485 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- -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. ---> -<!-- - -This is the XML DTD for the GemFire distributed cache declarative -caching XML file. All declarative cache files must include a DOCTYPE -of the following form: - - <!DOCTYPE cache PUBLIC - "-//GemStone Systems, Inc.//GemFire Declarative Caching 4.1//EN" - "http://www.gemstone.com/dtd/cache4_1.dtd";> - -The contents of a declarative XML file correspond to APIs found in the - - com.gemstone.gemfire.cache - -package. A declarative caching XML file is used to populate a Cache -when it is created. - ---> - -<!-- - -The following conventions apply to all GemFire distributed cache -declarative caching XML file elements unless indicated otherwise. - -- In elements that contain PCDATA, leading and trailing whitespace in - the data may be ignored. - -- In elements whose value is an "enumerated type", the value is case - sensitive. - ---> - -<!-- -The "cache" element is the root element of the declarative cache file. -This element configures a GemFire Cache and describes the root regions it -contains, if any. It also describes any "named" region attributes -that may be referenved when creating regions. ---> - -<!ELEMENT cache (cache-transaction-manager?, - dynamic-region-factory?, - gateway-hub*, - bridge-server*, region-attributes*, - (vm-root-region|shared-root-region|jndi-bindings)*)> -<!ATTLIST cache - lock-timeout CDATA #IMPLIED - lock-lease CDATA #IMPLIED - search-timeout CDATA #IMPLIED - is-server (true | false) #IMPLIED - cache-proxy-enabled (true | false) #IMPLIED - copy-on-read (true | false) #IMPLIED -> - -<!-- -A "cache-transaction-manager" describes a cache's transaction manager -which is used to control transactions. ---> -<!ELEMENT cache-transaction-manager (transaction-listener?)> - -<!-- -A "transaction-listener" describes a TransactionListener ---> -<!ELEMENT transaction-listener (class-name, parameter*)> - -<!-- -A "dynamic-region-factory" element configures a dynamic region factory for this cache. -If this optional element is missing then the cache does not support dynamic regions. - -The attribute disable-persist-backup can be used to disable persistence of -the dynamic-region-factory. - -The attribute disable-register-interest is for use in clients using -BridgeWriters that are configured to establish a callback connection. -In that case a dynamic region will, by default, register interest in -all keys. This default behavior can be disabled using this attribute. - -The optional "disk-dir" sub-element can be used to specify the directory to store the -persistent files that are used for dynamic region bookkeeping. -It defaults to the current directory. - -The optional "cache-writer" sub-element must only be used for -client applications in a client/server cache configuration and must be -a bridge-writer with establishCallbackConnection set to true. -It must not be specified in servers or peers. ---> -<!ELEMENT dynamic-region-factory (disk-dir?, cache-writer?)> -<!ATTLIST dynamic-region-factory - disable-persist-backup (true | false) #IMPLIED - disable-register-interest (true | false) #IMPLIED -> - -<!-- -The "gateway-hub" element specifies a Gateway Hub that is -initialized when the Cache is declaratively initialized. ---> -<!ELEMENT gateway-hub (gateway*)> -<!ATTLIST gateway-hub - id CDATA #REQUIRED - port CDATA #REQUIRED - socket-buffer-size CDATA #IMPLIED -> - -<!-- -The "gateway" element specifies a Gateway that is -initialized when a GatewayHub is declaratively initialized. ---> -<!ELEMENT gateway (gateway-endpoint+, gateway-queue?)> -<!ATTLIST gateway - id CDATA #REQUIRED - early-ack (true | false) #IMPLIED - socket-buffer-size CDATA #IMPLIED - socket-read-timeout CDATA #IMPLIED -> - -<!-- -The "gateway-endpoint" element specifies an endpoint that is -initialized when a Gateway is declaratively initialized. ---> -<!ELEMENT gateway-endpoint EMPTY> -<!ATTLIST gateway-endpoint - id CDATA #REQUIRED - host CDATA #REQUIRED - port CDATA #REQUIRED -> - -<!-- -The "gateway-queue" element specifies a queue that is -initialized when a Gateway is declaratively initialized. ---> -<!ELEMENT gateway-queue EMPTY> -<!ATTLIST gateway-queue - overflow-directory CDATA #IMPLIED - maximum-queue-memory CDATA #IMPLIED - batch-size CDATA #IMPLIED - batch-time-interval CDATA #IMPLIED - enable-conflation (true | false) #IMPLIED - enable-persistence (true | false) #IMPLIED -> - -<!-- -The "bridge-server" element specifies a Cache Bridge Server that is -started when the Cache is declaratively initialized. ---> -<!ELEMENT bridge-server EMPTY> -<!ATTLIST bridge-server - port CDATA #REQUIRED - notify-by-subscription (true | false) #IMPLIED - socket-buffer-size CDATA #IMPLIED - maximum-time-between-pings CDATA #IMPLIED -> - -<!-- -A "vm-root-region" element describes a root region whose entries and -subregions will be stored in VM local memory. -Note that the "name" attribute specifies the simple name of the region; -it cannot contain a "/". ---> - -<!ELEMENT vm-root-region (region-attributes, index*, entry*, region*)> -<!ATTLIST vm-root-region - name CDATA #REQUIRED -> - -<!-- -A "shared-root-region" element describes a root region whose entries -and subregions will be stored in shared memory. -Note that the "name" attribute specifies the simple name of the region; -it cannot contain a "/". ---> - -<!ELEMENT shared-root-region (region-attributes, index*, entry*, region*)> -<!ATTLIST shared-root-region - name CDATA #REQUIRED -> - - -<!-- -A "region" element describes a region (and its entries) in GemFire -distributed cache. It may be used to create a new region or may be -used to add new entries to an existing region. Note that the "name" -attribute specifies the simple name of the region; it cannot contain a -"/". ---> - -<!ELEMENT region ( region-attributes, index*, entry*, region* )> -<!ATTLIST region - name CDATA #REQUIRED -> - -<!-- -A "region-attributes" element describes the attributes of a region to -be created. It may also be assigned an "id" that may be referenced -("refid") when declaring a region. Note that forward references are -not allowed. That is, if an XML file contains a reference to an id -that has not been declared, an exception will be thrown. ---> - -<!ELEMENT region-attributes (key-constraint?, value-constraint?, region-time-to-live?, - region-idle-time?, entry-time-to-live?, entry-idle-time?, - disk-write-attributes?, disk-dirs?, - cache-loader?, cache-writer?, cache-listener?, eviction-attributes?)> -<!ATTLIST region-attributes - id CDATA #IMPLIED - refid CDATA #IMPLIED - scope (local | distributed-no-ack | distributed-ack | global) #IMPLIED - mirror-type (none | keys | keys-values) #IMPLIED - serialize-values (true | false) #IMPLIED - keep-alive-timeout CDATA #IMPLIED - initial-capacity CDATA #IMPLIED - load-factor CDATA #IMPLIED - concurrency-level CDATA #IMPLIED - persist-backup (true | false) #IMPLIED - statistics-enabled (true | false) #IMPLIED - index-update-type (synchronous|asynchronous) #IMPLIED - is-lock-grantor (true | false) #IMPLIED - early-ack (true | false) #IMPLIED - enable-wan (true | false) #IMPLIED - enable-conflation (true | false) #IMPLIED - enable-async-conflation (true | false) #IMPLIED - publisher (true | false) #IMPLIED -> - -<!-- Create eviction attributes that monitors and controls the size of the Region ---> -<!ELEMENT eviction-attributes (lru-entry-count|lru-heap-percentage|lru-memory-size)?> - -<!-- Create an LRU eviction controller which performs the action if the - Region has more than the maximum number of Entries in the Region ---> -<!ELEMENT lru-entry-count EMPTY> -<!ATTLIST lru-entry-count - maximum CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- - Create an LRU that measures the JVM heap after each interval, - if the heap is over the maximum percentage, the action is performed. ---> -<!ELEMENT lru-heap-percentage EMPTY> -<!ATTLIST lru-heap-percentage - maximum CDATA #IMPLIED - time-interval CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- - Create an LRU that performs the action when the memory size of the Region is over the - maximum. The optional class-name and parameter allows for the declaration an ObjectSizer which - is used to measure the size of each Object in the Region. The class must implement the ObjectSizer interface. ---> -<!ELEMENT lru-memory-size (class-name, parameter*)?> -<!ATTLIST lru-memory-size - maximum CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- An "index" element describes an index to be created on a region in GemfireCache. The index node if any -should all come immediately after the "region-attributes" node. There can be any number of functional type -of index on a Region, but only at max one index of type "primary-key". The "name" attribute is a required -field which identifies the name of the index ---> -<!ELEMENT index (functional|primary-key)> -<!ATTLIST index - name CDATA #REQUIRED -> - -<!-- -A functional type of index needs a from-clause, expression which are mandatory. The import string used for specifying the type of -Object in the region or the type of Object which the indexed expression evaluates to ---> -<!ELEMENT functional EMPTY> - -<!ATTLIST functional - from-clause CDATA #REQUIRED - expression CDATA #REQUIRED - imports CDATA #IMPLIED -> - -<!-- -A primary-key type of index needs a field attribute which is mandatory. There should be only one -or zero primary-index defined for a region ---> -<!ELEMENT primary-key EMPTY> -<!ATTLIST primary-key - field CDATA #REQUIRED -> - -<!-- -A "key-constraint" element specifies the name of a class to which the -keys of a region are constrained. ---> - - -<!ELEMENT key-constraint (#PCDATA)> - -<!-- -A "value-constraint" element specifies the name of a class to which the -values of a region are constrained. ---> - -<!ELEMENT value-constraint (#PCDATA)> - - -<!-- -A "region-time-to-live" element specifies a Region's time to live ---> - -<!ELEMENT region-time-to-live (expiration-attributes)> - -<!-- -A "region-idle-time" element specifies a Region's idle time ---> - -<!ELEMENT region-idle-time (expiration-attributes)> - -<!-- -A "entry-time-to-live" element specifies a Region's entries' time to -live ---> - -<!ELEMENT entry-time-to-live (expiration-attributes)> - -<!-- -A "entry-idle-time" element specifies a Region's entries' idle time ---> - -<!ELEMENT entry-idle-time (expiration-attributes)> - -<!-- -An "expiration-attributes" element describes expiration ---> - -<!ELEMENT expiration-attributes EMPTY> -<!ATTLIST expiration-attributes - timeout CDATA #REQUIRED - action (invalidate | destroy | local-invalidate | local-destroy) #IMPLIED -> - -<!-- -An "entry" element desribes an entry to be added to a region. Note -that if an entry with the given key already exists in the region, it -will be replaced. ---> - -<!ELEMENT entry (key, value)> - -<!-- -A "class-name" element specifies the name of a Declarable class, an -instance of which is created when a declarative cache XML file is -read. ---> - -<!ELEMENT class-name (#PCDATA)> - -<!-- -A "parameter" element describes a parameter used to initialize a -Declarable object. ---> - -<!ELEMENT parameter (string | declarable)> -<!ATTLIST parameter - name CDATA #REQUIRED -> - -<!-- -A "cache-loader" element describes a region's CacheLoader ---> - -<!ELEMENT cache-loader (class-name, parameter*)> - -<!-- -A "disk-write-attributes" element describes how entry data is written -to disk. ---> - -<!ELEMENT disk-write-attributes (synchronous-writes | asynchronous-writes)> - -<!-- -A "synchronous-writes" element specifies that entry data should be -written to disk synchronously. ---> - -<!ELEMENT synchronous-writes EMPTY> - -<!-- -An "asynchronous-writes" element specifies how entry data should be -written to disk asynchronous. ---> - -<!ELEMENT asynchronous-writes EMPTY> -<!ATTLIST asynchronous-writes - time-interval CDATA #REQUIRED - bytes-threshold CDATA #REQUIRED -> - -<!-- -A "disk-dirs" element specifies the region's disk directories ---> -<!ELEMENT disk-dirs (disk-dir+)> - -<!-- -A "disk-dir" element specifies one of a region's disk directories ---> - -<!ELEMENT disk-dir (#PCDATA)> - -<!-- -A "cache-writer" element describes a region's CacheWriter ---> - -<!ELEMENT cache-writer (class-name, parameter*)> - -<!-- -A "cache-listener" element describes a region's CacheListener ---> - -<!ELEMENT cache-listener (class-name, parameter*)> - -<!-- -A "key" element describes the key in a Region entry ---> -<!ELEMENT key (string | declarable)> - -<!-- -A "value" element describes the value in a Region entry ---> -<!ELEMENT value (string | declarable)> - -<!-- -A "string" element specifies a String to placed in a Region entry ---> -<!ELEMENT string (#PCDATA)> - -<!-- -A "declarable" element specifies a Declarable object to be placed in a -Region entry ---> -<!ELEMENT declarable (class-name, parameter*)> -<!-- A jndi-bindings element will contain the jndi-binding for each of the datasources which are to be bound with the JNDI Context --> -<!ELEMENT jndi-bindings (jndi-binding*)> -<!-- For every datasource which is bound to the tree , there wil exist one jndi-binding tag. This tag will describe the - property & configuration of the datasource . The attributes of jndi-binding are used for configuration by Gemfire, while the property element is used to configure the custom property for the datasource. Of the attributes list the type & jndi-name are required. -impleDataSource.xa-datasource-class is needed when type is XAPooledDataSource, while conn-pooled-datasource-class is needed when type is PooledDataSource. jdbc-driver-class is needed when the type is SimpleDataSource.It is advisable to set the user-name & password as attributes rather than as property element. Or they may be set both as attributes of jndi-binding tag as well as attribute of property tag--> -<!ELEMENT jndi-binding (config-property)*> -<!ATTLIST jndi-binding - type (SimpleDataSource |PooledDataSource|XAPooledDataSource|ManagedDataSource) #REQUIRED - jndi-name CDATA #REQUIRED - init-pool-size CDATA #IMPLIED - max-pool-size CDATA #IMPLIED - idle-timeout-seconds CDATA #IMPLIED - blocking-timeout-seconds CDATA #IMPLIED - login-timeout-seconds CDATA #IMPLIED - conn-pooled-datasource-class CDATA #IMPLIED - xa-datasource-class CDATA #IMPLIED - connection-url CDATA #IMPLIED - jdbc-driver-class CDATA #IMPLIED - user-name CDATA #IMPLIED - password CDATA #IMPLIED - managed-conn-factory-class CDATA #IMPLIED - transaction-type CDATA #IMPLIED -> -<!ELEMENT config-property (config-property-name, config-property-type, config-property-value)> -<!ELEMENT config-property-name (#PCDATA)> -<!ELEMENT config-property-type (#PCDATA)> -<!ELEMENT config-property-value (#PCDATA)> - - - - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/952ab6fa/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache5_0.dtd ---------------------------------------------------------------------- diff --git a/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache5_0.dtd b/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache5_0.dtd deleted file mode 100644 index 34ca2a9..0000000 --- a/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache5_0.dtd +++ /dev/null @@ -1,519 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- -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. ---> -<!-- - -This is the XML DTD for the GemFire distributed cache declarative -caching XML file. All declarative cache files must include a DOCTYPE -of the following form: - - <!DOCTYPE cache PUBLIC - "-//GemStone Systems, Inc.//GemFire Declarative Caching 5.0//EN" - "http://www.gemstone.com/dtd/cache5_0.dtd";> - -The contents of a declarative XML file correspond to APIs found in the - - com.gemstone.gemfire.cache - -package. A declarative caching XML file is used to populate a Cache -when it is created. - ---> - -<!-- - -The following conventions apply to all GemFire distributed cache -declarative caching XML file elements unless indicated otherwise. - -- In elements that contain PCDATA, leading and trailing whitespace in - the data may be ignored. - -- In elements whose value is an "enumerated type", the value is case - sensitive. - ---> - -<!-- -The "cache" element is the root element of the declarative cache file. -This element configures a GemFire Cache and describes the root regions it -contains, if any. ---> - -<!ELEMENT cache (cache-transaction-manager?, - dynamic-region-factory?, - gateway-hub*, - bridge-server*, - region-attributes*, - (region|vm-root-region|jndi-bindings)*)> -<!ATTLIST cache - lock-timeout CDATA #IMPLIED - lock-lease CDATA #IMPLIED - search-timeout CDATA #IMPLIED - is-server (true | false) #IMPLIED - copy-on-read (true | false) #IMPLIED -> - -<!-- -A "cache-transaction-manager" describes a cache's transaction manager -which is used to control transactions. ---> -<!ELEMENT cache-transaction-manager (transaction-listener*)> - -<!-- -A "transaction-listener" describes a TransactionListener ---> -<!ELEMENT transaction-listener (class-name, parameter*)> - - -<!-- -A "dynamic-region-factory" element configures a dynamic region factory for this cache. -If this optional element is missing then the cache does not support dynamic regions. - -The optional "disk-dir" sub-element can be used to specify the directory to store the -persistent files that are used for dynamic region bookkeeping. -It defaults to the current directory. - -The optional "cache-loader" and "cache-writer" sub-elements should only be used for -client applications in a client/server cache configuration and then must be a bridge-loader -and a bridge-writer. They should not be specified in servers or peers. ---> -<!ELEMENT dynamic-region-factory (disk-dir?, cache-loader?, cache-writer?)> -<!ATTLIST dynamic-region-factory - disable-persist-backup (true | false) #IMPLIED - disable-register-interest (true | false) #IMPLIED -> - -<!-- -The "gateway-hub" element specifies a Gateway Hub that is -initialized when the Cache is declaratively initialized. ---> -<!ELEMENT gateway-hub (gateway*)> -<!ATTLIST gateway-hub - id CDATA #REQUIRED - port CDATA #REQUIRED - socket-buffer-size CDATA #IMPLIED - maximum-time-between-pings CDATA #IMPLIED -> - -<!-- -The "gateway" element specifies a Gateway that is -initialized when a GatewayHub is declaratively initialized. ---> -<!ELEMENT gateway (gateway-endpoint+, gateway-queue?)> -<!ATTLIST gateway - id CDATA #REQUIRED - early-ack (true | false) #IMPLIED - socket-buffer-size CDATA #IMPLIED - socket-read-timeout CDATA #IMPLIED -> - -<!-- -The "gateway-endpoint" element specifies an endpoint that is -initialized when a Gateway is declaratively initialized. ---> -<!ELEMENT gateway-endpoint EMPTY> -<!ATTLIST gateway-endpoint - id CDATA #REQUIRED - host CDATA #REQUIRED - port CDATA #REQUIRED -> - -<!-- -The "gateway-queue" element specifies a queue that is -initialized when a Gateway is declaratively initialized. ---> -<!ELEMENT gateway-queue EMPTY> -<!ATTLIST gateway-queue - overflow-directory CDATA #IMPLIED - maximum-queue-memory CDATA #IMPLIED - batch-size CDATA #IMPLIED - batch-time-interval CDATA #IMPLIED - batch-conflation (true | false) #IMPLIED - enable-persistence (true | false) #IMPLIED -> - -<!-- -The "bridge-server" element specifies a Cache Bridge Server that is -started when the Cache is declaratively initialized. ---> -<!ELEMENT bridge-server EMPTY> -<!ATTLIST bridge-server - port CDATA #REQUIRED - max-connections CDATA #IMPLIED - notify-by-subscription (true | false) #IMPLIED - socket-buffer-size CDATA #IMPLIED - maximum-time-between-pings CDATA #IMPLIED -> - -<!-- -A "vm-root-region" element is the same as "region". -This element exists for backwards compatiblity and should not be used -in new xml files. ---> - -<!ELEMENT vm-root-region (region-attributes, index*, entry*, region*)> -<!ATTLIST vm-root-region - name CDATA #REQUIRED -> - -<!-- -A "region" element describes a region (and its entries) in GemFire -distributed cache. It may be used to create a new region or may be -used to add new entries to an existing region. Note that the "name" -attribute specifies the simple name of the region; it cannot contain a -"/". ---> - -<!ELEMENT region ( region-attributes, index*, entry*, region* )> -<!ATTLIST region - name CDATA #REQUIRED -> - -<!-- -A "region-attributes" element describes the attributes of a region to -be created. ---> - -<!ELEMENT region-attributes (key-constraint?, value-constraint?, region-time-to-live?, - region-idle-time?, entry-time-to-live?, entry-idle-time?, - disk-write-attributes?, disk-dirs?, partition-attributes?, - membership-attributes?, subscription-attributes?, - cache-loader?, cache-writer?, cache-listener*, eviction-attributes?)> -<!ATTLIST region-attributes - id CDATA #IMPLIED - refid CDATA #IMPLIED - scope (local | distributed-no-ack | distributed-ack | global) #IMPLIED - mirror-type (none | keys | keys-values) #IMPLIED - data-policy (normal - | empty - | replicate - | persistent-replicate - ) #IMPLIED - initial-capacity CDATA #IMPLIED - load-factor CDATA #IMPLIED - concurrency-level CDATA #IMPLIED - persist-backup (true | false) #IMPLIED - statistics-enabled (true | false) #IMPLIED - ignore-jta (true | false) #IMPLIED - index-update-type (synchronous|asynchronous) #IMPLIED - is-lock-grantor (true | false) #IMPLIED - early-ack (true | false) #IMPLIED - multicast-enabled (true | false) #IMPLIED - enable-gateway (true | false) #IMPLIED - enable-bridge-conflation (true | false) #IMPLIED - enable-async-conflation (true | false) #IMPLIED - publisher (true | false) #IMPLIED -> - -<!-- Create eviction attributes that monitors and controls the size of the Region ---> -<!ELEMENT eviction-attributes (lru-entry-count|lru-heap-percentage|lru-memory-size)?> - -<!-- Create an LRU eviction controller which performs the action if the - Region has more than the maximum number of Entries in the Region ---> -<!ELEMENT lru-entry-count EMPTY> -<!ATTLIST lru-entry-count - maximum CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- - Create an LRU that measures the JVM heap after each interval, - if the heap is over the maximum percentage, the action is performed. ---> -<!ELEMENT lru-heap-percentage EMPTY> -<!ATTLIST lru-heap-percentage - maximum CDATA #IMPLIED - time-interval CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- - Create an LRU that performs the action when the memory size of the Region is over the - maximum. The optional class-name and parameter allows for the declaration an ObjectSizer which - is used to measure the size of each Object in the Region. The class must implement the ObjectSizer interface. ---> -<!ELEMENT lru-memory-size (class-name, parameter*)?> -<!ATTLIST lru-memory-size - maximum CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - - -<!-- An "index" element describes an index to be created on a region in GemfireCache. The index node if any -should all come immediately after the "region-attributes" node. There can be any number of functional type -of index on a Region, but only at max one index of type "primary-key". The "name" attribute is a required -field which identifies the name of the index ---> -<!ELEMENT index (functional|primary-key)> -<!ATTLIST index - name CDATA #REQUIRED -> - -<!-- -A functional type of index needs a from-clause, expression which are mandatory. The import string used for specifying the type of -Object in the region or the type of Object which the indexed expression evaluates to ---> -<!ELEMENT functional EMPTY> - -<!ATTLIST functional - from-clause CDATA #REQUIRED - expression CDATA #REQUIRED - imports CDATA #IMPLIED -> - -<!-- -A primary-key type of index needs a field attribute which is mandatory. There should be only one -or zero primary-index defined for a region ---> -<!ELEMENT primary-key EMPTY> -<!ATTLIST primary-key - field CDATA #REQUIRED -> - -<!-- -A "key-constraint" element specifies the name of a class to which the -keys of a region are constrained. ---> - - -<!ELEMENT key-constraint (#PCDATA)> - -<!-- -A "value-constraint" element specifies the name of a class to which the -values of a region are constrained. ---> - -<!ELEMENT value-constraint (#PCDATA)> - - -<!-- -A "region-time-to-live" element specifies a Region's time to live ---> - -<!ELEMENT region-time-to-live (expiration-attributes)> - -<!-- -A "region-idle-time" element specifies a Region's idle time ---> - -<!ELEMENT region-idle-time (expiration-attributes)> - -<!-- -A "entry-time-to-live" element specifies a Region's entries' time to -live ---> - -<!ELEMENT entry-time-to-live (expiration-attributes)> - -<!-- -A "entry-idle-time" element specifies a Region's entries' idle time ---> - -<!ELEMENT entry-idle-time (expiration-attributes)> - -<!-- -An "expiration-attributes" element describes expiration ---> - -<!ELEMENT expiration-attributes EMPTY> -<!ATTLIST expiration-attributes - timeout CDATA #REQUIRED - action (invalidate | destroy | local-invalidate | local-destroy) #IMPLIED -> - -<!-- -An "entry" element desribes an entry to be added to a region. Note -that if an entry with the given key already exists in the region, it -will be replaced. ---> - -<!ELEMENT entry (key, value)> - -<!-- -A "class-name" element specifies the name of a Declarable class, an -instance of which is created when a declarative cache XML file is -read. ---> - -<!ELEMENT class-name (#PCDATA)> - -<!-- -A "parameter" element describes a parameter used to initialize a -Declarable object. ---> - -<!ELEMENT parameter (string | declarable)> -<!ATTLIST parameter - name CDATA #REQUIRED -> - -<!-- -A "cache-loader" element describes a region's CacheLoader ---> - -<!ELEMENT cache-loader (class-name, parameter*)> - -<!-- -A "disk-write-attributes" element describes how entry data is written -to disk. ---> - -<!ELEMENT disk-write-attributes (synchronous-writes | asynchronous-writes)> - -<!-- -A "synchronous-writes" element specifies that entry data should be -written to disk synchronously. ---> - -<!ELEMENT synchronous-writes EMPTY> - -<!-- -An "asynchronous-writes" element specifies how entry data should be -written to disk asynchronous. ---> - -<!ELEMENT asynchronous-writes EMPTY> -<!ATTLIST asynchronous-writes - time-interval CDATA #REQUIRED - bytes-threshold CDATA #REQUIRED -> - -<!-- -A "disk-dirs" element specifies the region's disk directories ---> -<!ELEMENT disk-dirs (disk-dir+)> - -<!-- -A "disk-dir" element specifies one of a region's disk directories ---> - -<!ELEMENT disk-dir (#PCDATA)> - -<!-- -A "partition-attributes" element configures a region for partitioned -data storage ---> - -<!ELEMENT partition-attributes (cache-loader?, local-properties?, global-properties?)> -<!ATTLIST partition-attributes - redundant-copies CDATA #IMPLIED -> - -<!-- - Partitioned Region properties that affect Caches that store data for the partitioned region - --> -<!ELEMENT global-properties (parameter*)> - -<!-- - Partitioned Region properties that affect the storage that the local Cache contributes to the Partitioned Region - --> -<!ELEMENT local-properties (parameter*)> - -<!-- -A "membership-attributes" element configures a region for membership -constraints based on required roles ---> - -<!ELEMENT membership-attributes (required-role*)> -<!ATTLIST membership-attributes - loss-action (no-access | limited-access | full-access | reconnect) #IMPLIED - resumption-action (none | reinitialize) #IMPLIED -> - -<!-- -A "required-role" element specifies a role that is required for reliable -access to the region ---> - -<!ELEMENT required-role EMPTY> -<!ATTLIST required-role - name CDATA #REQUIRED -> - -<!-- -A "subscription-attributes" element configures how a region subscribes -to remote distributed regions ---> - -<!ELEMENT subscription-attributes EMPTY> -<!ATTLIST subscription-attributes - interest-policy (all | cache-content) #IMPLIED -> - -<!-- -A "cache-writer" element describes a region's CacheWriter ---> - -<!ELEMENT cache-writer (class-name, parameter*)> - -<!-- -A "cache-listener" element describes a region's CacheListener ---> - -<!ELEMENT cache-listener (class-name, parameter*)> - -<!-- -A "key" element describes the key in a Region entry ---> -<!ELEMENT key (string | declarable)> - -<!-- -A "value" element describes the value in a Region entry ---> -<!ELEMENT value (string | declarable)> - -<!-- -A "string" element specifies a String to placed in a Region entry ---> -<!ELEMENT string (#PCDATA)> - -<!-- -A "declarable" element specifies a Declarable object to be placed in a -Region entry ---> -<!ELEMENT declarable (class-name, parameter*)> -<!-- A jndi-bindings element will contain the jndi-binding for each of the datasources which are to be bound with the JNDI Context --> -<!ELEMENT jndi-bindings (jndi-binding*)> -<!-- For every datasource which is bound to the tree , there wil exist one jndi-binding tag. This tag will describe the - property & configuration of the datasource . The attributes of jndi-binding are used for configuration by Gemfire, while the property element is used to configure the custom property for the datasource. Of the attributes list the type & jndi-name are required. -impleDataSource.xa-datasource-class is needed when type is XAPooledDataSource, while conn-pooled-datasource-class is needed when type is PooledDataSource. jdbc-driver-class is needed when the type is SimpleDataSource.It is advisable to set the user-name & password as attributes rather than as property element. Or they may be set both as attributes of jndi-binding tag as well as attribute of property tag--> -<!ELEMENT jndi-binding (config-property*)> -<!ATTLIST jndi-binding - type (SimpleDataSource|PooledDataSource|XAPooledDataSource|ManagedDataSource) #REQUIRED - jndi-name CDATA #REQUIRED - init-pool-size CDATA #IMPLIED - max-pool-size CDATA #IMPLIED - idle-timeout-seconds CDATA #IMPLIED - blocking-timeout-seconds CDATA #IMPLIED - login-timeout-seconds CDATA #IMPLIED - conn-pooled-datasource-class CDATA #IMPLIED - xa-datasource-class CDATA #IMPLIED - connection-url CDATA #IMPLIED - jdbc-driver-class CDATA #IMPLIED - user-name CDATA #IMPLIED - password CDATA #IMPLIED - managed-conn-factory-class CDATA #IMPLIED - transaction-type CDATA #IMPLIED -> -<!ELEMENT config-property (config-property-name, config-property-type, config-property-value)> -<!ELEMENT config-property-name (#PCDATA)> -<!ELEMENT config-property-type (#PCDATA)> -<!ELEMENT config-property-value (#PCDATA)> - - - - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/952ab6fa/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache5_1.dtd ---------------------------------------------------------------------- diff --git a/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache5_1.dtd b/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache5_1.dtd deleted file mode 100755 index 4a93047..0000000 --- a/geode-core/src/main/resources/org/apache/geode/cache/doc-files/cache5_1.dtd +++ /dev/null @@ -1,534 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- -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. ---> -<!-- - -This is the XML DTD for the GemFire distributed cache declarative -caching XML file. All declarative cache files must include a DOCTYPE -of the following form: - - <!DOCTYPE cache PUBLIC - "-//GemStone Systems, Inc.//GemFire Declarative Caching 5.1//EN" - "http://www.gemstone.com/dtd/cache5_1.dtd";> - -The contents of a declarative XML file correspond to APIs found in the - - com.gemstone.gemfire.cache - -package. A declarative caching XML file is used to populate a Cache -when it is created. - ---> - -<!-- - -The following conventions apply to all GemFire distributed cache -declarative caching XML file elements unless indicated otherwise. - -- In elements that contain PCDATA, leading and trailing whitespace in - the data may be ignored. - -- In elements whose value is an "enumerated type", the value is case - sensitive. - ---> - -<!-- -The "cache" element is the root element of the declarative cache file. -This element configures a GemFire Cache and describes the root regions it -contains, if any. ---> - -<!ELEMENT cache (cache-transaction-manager?, - dynamic-region-factory?, - gateway-hub*, - bridge-server*, - region-attributes*, - (region|vm-root-region|jndi-bindings)*)> -<!ATTLIST cache - lock-timeout CDATA #IMPLIED - lock-lease CDATA #IMPLIED - search-timeout CDATA #IMPLIED - message-sync-interval CDATA #IMPLIED - is-server (true | false) #IMPLIED - copy-on-read (true | false) #IMPLIED -> - - -<!-- -A "cache-transaction-manager" element allows insertion of cache-level transaction -listeners. ---> -<!ELEMENT cache-transaction-manager (transaction-listener*)> - -<!-- -A "transaction-listener" describes a TransactionListener ---> -<!ELEMENT transaction-listener (class-name, parameter*)> - -<!-- -A "dynamic-region-factory" element configures a dynamic region factory for this cache. -If this optional element is missing then the cache does not support dynamic regions. - -The optional "disk-dir" sub-element can be used to specify the directory to store the -persistent files that are used for dynamic region bookkeeping. -It defaults to the current directory. - -The optional "cache-loader" and "cache-writer" sub-elements should only be used for -client applications in a client/server cache configuration and then must be a bridge-loader -and a bridge-writer. They should not be specified in servers or peers. ---> -<!ELEMENT dynamic-region-factory (disk-dir?, cache-loader?, cache-writer?)> -<!ATTLIST dynamic-region-factory - disable-persist-backup (true | false) #IMPLIED - disable-register-interest (true | false) #IMPLIED -> - -<!-- -The "gateway-hub" element specifies a Gateway Hub that is -initialized when the Cache is declaratively initialized. ---> -<!ELEMENT gateway-hub (gateway*)> -<!ATTLIST gateway-hub - id CDATA #REQUIRED - port CDATA #REQUIRED - socket-buffer-size CDATA #IMPLIED - maximum-time-between-pings CDATA #IMPLIED - startup-policy (primary | secondary | none) #IMPLIED -> - -<!-- -The "gateway" element specifies a Gateway that is -initialized when a GatewayHub is declaratively initialized. ---> -<!ELEMENT gateway ((gateway-endpoint+ | gateway-listener+), gateway-queue?)> -<!ATTLIST gateway - id CDATA #REQUIRED - early-ack (true | false) #IMPLIED - socket-buffer-size CDATA #IMPLIED - socket-read-timeout CDATA #IMPLIED -> - -<!-- -The "gateway-endpoint" element specifies an endpoint that is -initialized when a Gateway is declaratively initialized. ---> -<!ELEMENT gateway-endpoint EMPTY> -<!ATTLIST gateway-endpoint - id CDATA #REQUIRED - host CDATA #REQUIRED - port CDATA #REQUIRED -> - -<!-- -The "gateway-listener" element specifies a listener that is -initialized when a Gateway is declaratively initialized. ---> -<!ELEMENT gateway-listener (class-name, parameter*)> -<!ATTLIST gateway-listener -> - -<!-- -The "gateway-queue" element specifies a queue that is -initialized when a Gateway is declaratively initialized. ---> -<!ELEMENT gateway-queue EMPTY> -<!ATTLIST gateway-queue - overflow-directory CDATA #IMPLIED - maximum-queue-memory CDATA #IMPLIED - batch-size CDATA #IMPLIED - batch-time-interval CDATA #IMPLIED - batch-conflation (true | false) #IMPLIED - enable-persistence (true | false) #IMPLIED -> - -<!-- -The "bridge-server" element specifies a Cache Bridge Server that is -started when the Cache is declaratively initialized. ---> -<!ELEMENT bridge-server EMPTY> -<!ATTLIST bridge-server - port CDATA #REQUIRED - max-connections CDATA #IMPLIED - max-threads CDATA #IMPLIED - notify-by-subscription (true | false) #IMPLIED - socket-buffer-size CDATA #IMPLIED - maximum-time-between-pings CDATA #IMPLIED - maximum-message-count CDATA #IMPLIED - message-time-to-live CDATA #IMPLIED -> - -<!-- -A "vm-root-region" element is the same as "region". -This element exists for backwards compatiblity and should not be used -in new xml files. ---> - -<!ELEMENT vm-root-region (region-attributes, index*, entry*, region*)> -<!ATTLIST vm-root-region - name CDATA #REQUIRED -> - -<!-- -A "region" element describes a region (and its entries) in GemFire -distributed cache. It may be used to create a new region or may be -used to add new entries to an existing region. Note that the "name" -attribute specifies the simple name of the region; it cannot contain a -"/". ---> - -<!ELEMENT region ( region-attributes, index*, entry*, region* )> -<!ATTLIST region - name CDATA #REQUIRED -> - -<!-- -A "region-attributes" element describes the attributes of a region to -be created. ---> - -<!ELEMENT region-attributes (key-constraint?, value-constraint?, region-time-to-live?, - region-idle-time?, entry-time-to-live?, entry-idle-time?, - disk-write-attributes?, disk-dirs?, partition-attributes?, - membership-attributes?, subscription-attributes?, - cache-loader?, cache-writer?, cache-listener*, eviction-attributes?)> -<!ATTLIST region-attributes - id CDATA #IMPLIED - refid CDATA #IMPLIED - scope (local | distributed-no-ack | distributed-ack | global) #IMPLIED - mirror-type (none | keys | keys-values) #IMPLIED - data-policy (normal - | empty - | replicate - | persistent-replicate - | partition - ) #IMPLIED - initial-capacity CDATA #IMPLIED - load-factor CDATA #IMPLIED - concurrency-level CDATA #IMPLIED - persist-backup (true | false) #IMPLIED - statistics-enabled (true | false) #IMPLIED - ignore-jta (true | false) #IMPLIED - index-update-type (synchronous|asynchronous) #IMPLIED - is-lock-grantor (true | false) #IMPLIED - early-ack (true | false) #IMPLIED - multicast-enabled (true | false) #IMPLIED - enable-gateway (true | false) #IMPLIED - enable-bridge-conflation (true | false) #IMPLIED - enable-async-conflation (true | false) #IMPLIED - publisher (true | false) #IMPLIED - hub-id CDATA #IMPLIED -> - -<!-- Create eviction attributes that monitors and controls the size of the Region ---> -<!ELEMENT eviction-attributes (lru-entry-count|lru-heap-percentage|lru-memory-size)?> - -<!-- Create an LRU eviction controller which performs the action if the - Region has more than the maximum number of Entries in the Region ---> -<!ELEMENT lru-entry-count EMPTY> -<!ATTLIST lru-entry-count - maximum CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- - Create an LRU that measures the JVM heap after each interval, - if the heap is over the maximum percentage, the action is performed. ---> -<!ELEMENT lru-heap-percentage EMPTY> -<!ATTLIST lru-heap-percentage - maximum CDATA #IMPLIED - time-interval CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - -<!-- - Create an LRU that performs the action when the memory size of the Region is over the - maximum. The optional class-name and parameter allows for the declaration an ObjectSizer which - is used to measure the size of each Object in the Region. The class must implement the ObjectSizer interface. ---> -<!ELEMENT lru-memory-size (class-name, parameter*)?> -<!ATTLIST lru-memory-size - maximum CDATA #IMPLIED - action (local-destroy|overflow-to-disk) #IMPLIED> - - -<!-- An "index" element describes an index to be created on a region in GemfireCache. The index node if any -should all come immediately after the "region-attributes" node. There can be any number of functional type -of index on a Region, but only at max one index of type "primary-key". The "name" attribute is a required -field which identifies the name of the index ---> -<!ELEMENT index (functional|primary-key)> -<!ATTLIST index - name CDATA #REQUIRED -> - -<!-- -A functional type of index needs a from-clause, expression which are mandatory. The import string used for specifying the type of -Object in the region or the type of Object which the indexed expression evaluates to ---> -<!ELEMENT functional EMPTY> - -<!ATTLIST functional - from-clause CDATA #REQUIRED - expression CDATA #REQUIRED - imports CDATA #IMPLIED -> - -<!-- -A primary-key type of index needs a field attribute which is mandatory. There should be only one -or zero primary-index defined for a region ---> -<!ELEMENT primary-key EMPTY> -<!ATTLIST primary-key - field CDATA #REQUIRED -> - -<!-- -A "key-constraint" element specifies the name of a class to which the -keys of a region are constrained. ---> - - -<!ELEMENT key-constraint (#PCDATA)> - -<!-- -A "value-constraint" element specifies the name of a class to which the -values of a region are constrained. ---> - -<!ELEMENT value-constraint (#PCDATA)> - - -<!-- -A "region-time-to-live" element specifies a Region's time to live ---> - -<!ELEMENT region-time-to-live (expiration-attributes)> - -<!-- -A "region-idle-time" element specifies a Region's idle time ---> - -<!ELEMENT region-idle-time (expiration-attributes)> - -<!-- -A "entry-time-to-live" element specifies a Region's entries' time to -live ---> - -<!ELEMENT entry-time-to-live (expiration-attributes)> - -<!-- -A "entry-idle-time" element specifies a Region's entries' idle time ---> - -<!ELEMENT entry-idle-time (expiration-attributes)> - -<!-- -An "expiration-attributes" element describes expiration ---> - -<!ELEMENT expiration-attributes EMPTY> -<!ATTLIST expiration-attributes - timeout CDATA #REQUIRED - action (invalidate | destroy | local-invalidate | local-destroy) #IMPLIED -> - -<!-- -An "entry" element desribes an entry to be added to a region. Note -that if an entry with the given key already exists in the region, it -will be replaced. ---> - -<!ELEMENT entry (key, value)> - -<!-- -A "class-name" element specifies the name of a Declarable class, an -instance of which is created when a declarative cache XML file is -read. ---> - -<!ELEMENT class-name (#PCDATA)> - -<!-- -A "parameter" element describes a parameter used to initialize a -Declarable object. ---> - -<!ELEMENT parameter (string | declarable)> -<!ATTLIST parameter - name CDATA #REQUIRED -> - -<!-- -A "cache-loader" element describes a region's CacheLoader ---> - -<!ELEMENT cache-loader (class-name, parameter*)> - -<!-- -A "disk-write-attributes" element describes how entry data is written -to disk. ---> - -<!ELEMENT disk-write-attributes (synchronous-writes | asynchronous-writes)> -<!ATTLIST disk-write-attributes - roll-oplogs CDATA #IMPLIED - max-oplog-size CDATA #IMPLIED -> - -<!-- -A "synchronous-writes" element specifies that entry data should be -written to disk synchronously. ---> - -<!ELEMENT synchronous-writes EMPTY> - -<!-- -An "asynchronous-writes" element specifies how entry data should be -written to disk asynchronous. ---> - -<!ELEMENT asynchronous-writes EMPTY> -<!ATTLIST asynchronous-writes - time-interval CDATA #REQUIRED - bytes-threshold CDATA #REQUIRED -> - -<!-- -A "disk-dirs" element specifies the region's disk directories ---> -<!ELEMENT disk-dirs (disk-dir+)> - -<!-- -A "disk-dir" element specifies one of a region's disk directories ---> - -<!ELEMENT disk-dir (#PCDATA)> -<!ATTLIST disk-dir - dir-size CDATA #IMPLIED -> - -<!-- -A "partition-attributes" element configures a region for partitioned -data storage - cache-loader element removed from partition-attributes in release 5.1 - local-max-memory attribute added to partition-attributes in release 5.1 - total-max-memory attribute added to partition-attributes in release 5.1 - total-num-buckets attribute added to partition-attributes in release 5.1 - local-properties and global-properties attributes removed in release 5.1 ---> -<!ELEMENT partition-attributes EMPTY> -<!ATTLIST partition-attributes - local-max-memory CDATA #IMPLIED - redundant-copies CDATA #IMPLIED - total-max-memory CDATA #IMPLIED - total-num-buckets CDATA #IMPLIED -> - -<!-- -A "membership-attributes" element configures a region for membership -constraints based on required roles ---> - -<!ELEMENT membership-attributes (required-role*)> -<!ATTLIST membership-attributes - loss-action (no-access | limited-access | full-access | reconnect) #IMPLIED - resumption-action (none | reinitialize) #IMPLIED -> - -<!-- -A "required-role" element specifies a role that is required for reliable -access to the region ---> - -<!ELEMENT required-role EMPTY> -<!ATTLIST required-role - name CDATA #REQUIRED -> - -<!-- -A "subscription-attributes" element configures how a region subscribes -to remote distributed regions ---> - -<!ELEMENT subscription-attributes EMPTY> -<!ATTLIST subscription-attributes - interest-policy (all | cache-content) #IMPLIED -> - -<!-- -A "cache-writer" element describes a region's CacheWriter ---> - -<!ELEMENT cache-writer (class-name, parameter*)> - -<!-- -A "cache-listener" element describes a region's CacheListener ---> - -<!ELEMENT cache-listener (class-name, parameter*)> - -<!-- -A "key" element describes the key in a Region entry ---> -<!ELEMENT key (string | declarable)> - -<!-- -A "value" element describes the value in a Region entry ---> -<!ELEMENT value (string | declarable)> - -<!-- -A "string" element specifies a String to placed in a Region entry ---> -<!ELEMENT string (#PCDATA)> - -<!-- -A "declarable" element specifies a Declarable object to be placed in a -Region entry ---> -<!ELEMENT declarable (class-name, parameter*)> -<!-- A jndi-bindings element will contain the jndi-binding for each of the datasources which are to be bound with the JNDI Context --> -<!ELEMENT jndi-bindings (jndi-binding*)> -<!-- For every datasource which is bound to the tree , there wil exist one jndi-binding tag. This tag will describe the - property & configuration of the datasource . The attributes of jndi-binding are used for configuration by Gemfire, while the property element is used to configure the custom property for the datasource. Of the attributes list the type & jndi-name are required. -impleDataSource.xa-datasource-class is needed when type is XAPooledDataSource, while conn-pooled-datasource-class is needed when type is PooledDataSource. jdbc-driver-class is needed when the type is SimpleDataSource.It is advisable to set the user-name & password as attributes rather than as property element. Or they may be set both as attributes of jndi-binding tag as well as attribute of property tag--> -<!ELEMENT jndi-binding (config-property*)> -<!ATTLIST jndi-binding - type (SimpleDataSource|PooledDataSource|XAPooledDataSource|ManagedDataSource) #REQUIRED - jndi-name CDATA #REQUIRED - init-pool-size CDATA #IMPLIED - max-pool-size CDATA #IMPLIED - idle-timeout-seconds CDATA #IMPLIED - blocking-timeout-seconds CDATA #IMPLIED - login-timeout-seconds CDATA #IMPLIED - conn-pooled-datasource-class CDATA #IMPLIED - xa-datasource-class CDATA #IMPLIED - connection-url CDATA #IMPLIED - jdbc-driver-class CDATA #IMPLIED - user-name CDATA #IMPLIED - password CDATA #IMPLIED - managed-conn-factory-class CDATA #IMPLIED - transaction-type CDATA #IMPLIED -> -<!ELEMENT config-property (config-property-name, config-property-type, config-property-value)> -<!ELEMENT config-property-name (#PCDATA)> -<!ELEMENT config-property-type (#PCDATA)> -<!ELEMENT config-property-value (#PCDATA)> -
