http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/fd8927cb/geode-docs/tools_modules/hibernate_cache/installing_gemfire_and_module.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/hibernate_cache/installing_gemfire_and_module.html.md.erb b/geode-docs/tools_modules/hibernate_cache/installing_gemfire_and_module.html.md.erb deleted file mode 100644 index a3bc6b9..0000000 --- a/geode-docs/tools_modules/hibernate_cache/installing_gemfire_and_module.html.md.erb +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Installing the Hibernate Cache Module ---- - -<!-- -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. ---> - -The Hibernate module is included in the Apache Geode installation package. - -1. If you have not done so, download and install [Hibernate](http://www.hibernate.org/). Apache Geode supports Hibernate 3.3 and later (up to version 3.6.10) for use with the Hibernate Cache module. Apache Geode does not currently support Hibernate 4.x for use with the Hibernate Cache module. -2. The Hibernate module is included in the Apache Geode installation package. You can find the module in the `<product_dir>/tools/Modules` directory, in a zip file that includes the version and the string `Hibernate`. `<product_dir>` is the location where you installed Geode. -3. Make sure that `<product_dir>/lib/geode-dependencies.jar` is part of the CLASSPATH when you run Hibernate. Alternatively, you can place the `geode-dependencies.jar` in a location that is accessible to your Hibernate application. - -
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/fd8927cb/geode-docs/tools_modules/hibernate_cache/setting_up_the_module.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/hibernate_cache/setting_up_the_module.html.md.erb b/geode-docs/tools_modules/hibernate_cache/setting_up_the_module.html.md.erb deleted file mode 100644 index 8d00c34..0000000 --- a/geode-docs/tools_modules/hibernate_cache/setting_up_the_module.html.md.erb +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: Setting Up the Geode Hibernate Cache Module ---- - -<!-- -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. ---> - -Edit the `hibernate.cfg.xml` file to use the Hibernate Cache module. - -1. **Turn on L2 Cache** - - In the `hibernate.cfg.xml` file, turn on the L2 cache and identify the Geode locator(s): - - ``` pre - <property name="hibernate.cache.use_second_level_cache">true</property> - <property name="gemfire.locators">host1[port1],host2[port2]</property> - ``` - - Change `host1` and `host2 ` to the hostnames (or IP addresses) for each of the locators; `port1` and `port2 `are the ports for each of the locators. - -2. **Set Region Factory or Cache Provider** - - Associate the region factory class with GemFireRegionFactory: - - ``` pre - <property name="hibernate.cache.region.factory_class"> - org.apache.geode.modules.hibernate.GemFireRegionFactory - </property> - ``` - -3. **Determine Cache Usage Mode** - - Determine the cache usage mode for the entities in each region. There are four types of usage modes: - - | Mode | Description | - |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `read-only` | This mode is used when you do not plan on modifying the data already stored in your persistent storage. | - | `read-write` | This mode is used when you plan to both read from and write to your data. | - | `nonstrict-read-write` | This mode is a special read/write mode that has faster write performance; however, only use this mode if no more than one client will update content at a time. | - | `transactional` | This mode allows for transaction-based data access. | - -4. **Set Cache Usage Mode** - - The usage mode can either be set using the hibernate-mapping file or through Java annotations. - - To set the mode with the hibernate-mapping file, refer to this example: - - ``` pre - - <hibernate-mapping package="PACKAGE"> - <class name="ENTITY_NAME" ...> - <cache usage="USAGE_MODE"/> - ... - </class> - </hibernate-mapping> - - ``` - - In this example, `PACKAGE` is the name of the entity package, `ENTITY_NAME` is the name of your entity, and `USAGE_MODE` is the chosen usage mode from the table given above. Refer to the [Hibernate documentation](http://hibernate.org/docs) for further information. - - To set the mode using annotations, your class definition should look something like this example which specifies the `read-only` usage mode: - - ``` pre - import org.hibernate.annotations.Cache; - import org.hibernate.annotations.CacheConcurrencyStrategy; - - @Entity - @Cacheable - @Cache( - region = 'REGION_NAME', - usage = CacheConcurrencyStrategy.READ_ONLY - ) - - public class MyClass implements Serializable { ... } - ``` - -5. **Start a Locator** - - ``` pre - $ gfsh start locator â-name=locator1 - ``` - -6. **Start Hibernate** - - You are now ready to build, deploy, and run your Hibernate application, which will also launch Geode. See the [Hibernate website documentation](http://hibernate.org/docs) for further information about performing these actions. - -7. **Verify that Geode Started Successfully** - - Similar to Hibernate, Geode uses Simple Logging Facade for Java (SLF4J) to log messages. Upon successful startup, Geode will log the following message: - - ``` pre - 2010-11-15 INFO [org.apache.geode.modules.hibernate.GemFireRegionFactory] - - <Initializing Apache Geode Modules Version 1.1> - ``` - - SLF4J can send this and other Geode log messages to several logging frameworks. Refer to the [SLF4J](http://www.slf4j.org/) website for additional information. - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/fd8927cb/geode-docs/tools_modules/hibernate_cache/using_hibernate_with_http_session.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/hibernate_cache/using_hibernate_with_http_session.html.md.erb b/geode-docs/tools_modules/hibernate_cache/using_hibernate_with_http_session.html.md.erb deleted file mode 100644 index d6a3719..0000000 --- a/geode-docs/tools_modules/hibernate_cache/using_hibernate_with_http_session.html.md.erb +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Using Hibernate Cache Module with HTTP Session Management Module ---- - -<!-- -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 section describes how to set up the Hibernate Cache module if you are also using the HTTP Session Management module. - -If you have already configured your tc Server or Tomcat application server to use the HTTP Session Management Module, follow these steps to configure Hibernate module for your application: - -1. Install and configure the Hibernate Cache Module as described in [Installing the Hibernate Cache Module](installing_gemfire_and_module.html#installing_gemfire_and_module) and [Setting Up the Geode Hibernate Cache Module](setting_up_the_module.html#settup_up_the_module). -2. Make sure that your Hibernate application is using the same Geode topology as your application server. -3. Include gemfire-modules-<version>.jar in your application .war file. This is typically done by putting the .jar file under the `WEB-INF/lib` directory. - **Note:** - Even though both modules include a gemfire-modules-<version>.jar file in their distribution, you only need to put one gemfire-modules-<version>.jar file in your .war file. It does not matter which one you use. You can even be using different versions of the HTTP Session Management and Hibernate Cache modules. - -4. Make sure that gemfire.jar is not included in your application .war file. -5. Deploy your application .war file. -6. These configuration steps will work with the default gemfire properties configurations that ship with the Geode modules. If you have added or modified Gemfire properties for the HTTP Session Management Module (for example, as described in[Changing the Default Geode Configuration in the Tomcat Module](../http_session_mgmt/tomcat_changing_gf_default_cfg.html#tomcat_changing_gf_default_cfg) or [Changing the Default Geode Configuration in the tc Server Module](../http_session_mgmt/tc_changing_gf_default_cfg.html#tc_changing_gf_default_cfg)), then you must make the same changes for the Hibernate Cache module. See [Changing Default Configuration of the Hibernate Cache Module](changing_gemfire_default_cfg.html#changing_gemfire_default_cfg) for instructions on how to modify the default Hibernate Cache configuration. - -**Note:** -Using the Hibernate Cache Module with the HTTP Session Management Module creates a single Geode cache in your application server. This cache will be shared by all applications deployed on the application server. Therefore, if two applications use the same entity objects (specified by fully qualified class names) or are configured to use the same cache region, all instances of these entities will end up in the single Geode cache region. If this is not the desired behavior, then include gemfire.jar in the application war file. A Geode cache will be created in the application's class loader. - -
