{"id":1024,"date":"2012-03-08T16:02:00","date_gmt":"2012-03-08T16:02:00","guid":{"rendered":"http:\/\/www.javacodegeeks.com\/2012\/10\/adding-ehcache-to-openxava-application.html"},"modified":"2012-10-21T23:18:50","modified_gmt":"2012-10-21T23:18:50","slug":"adding-ehcache-to-openxava-application","status":"publish","type":"post","link":"https:\/\/www.javacodegeeks.com\/2012\/03\/adding-ehcache-to-openxava-application.html","title":{"rendered":"Adding Ehcache to Openxava application"},"content":{"rendered":"
Introduction<\/span><\/p>\n

This article shows how to quickly enable Ehcache on Openxava applications and thus improving performance.<\/p>\n

When viewing an entity and its graph, relationships are loaded. Adding a second-level cache fasten the retrieval of associated elements, since already loaded elements are retrieved from cache and not database.<\/p>\n

Eventually this page explains how minuteproject treats this aspect with keeping its promise: write nothing.
\nAs an example, we will take the Lazuly minuteproject showcase. <\/p>\n

Openxava-Ehcache integration<\/span><\/p>\n

In Openxava, you describe your model in the manner of Java annotated POJO.The annotations come from the standard JPA2 ORM and Openxava specific ones.
\nBut nothing prevents you to add others. This is what is done to add caching. There are also couple of configurations to undertake to enable caching.<\/p>\n

List of actions<\/span><\/p>\n

    \n
  1. Add ehcache.xml config file at the root of your sources<\/li>\n
  2. Modify persistence.xml to include second level cache<\/li>\n
  3. Add caching annotation (alongside JPA2)<\/li>\n<\/ol>\n

    Remark:<\/u><\/p>\n

    Openxava comes with the ehcache.jar so there is no need to add a dependency.<\/p>\n

      <\/ol>\n

      Detailed actions<\/span><\/p>\n

      Add ehcache.xml<\/strong><\/p>\n

      In \/persistence place ehcache.xml file<\/p>\n

      <ehcache>\r\n    <defaultCache\r\n            maxElementsInMemory=\"1000\"\r\n            eternal=\"false\"\r\n            timeToIdleSeconds=\"300\"\r\n            timeToLiveSeconds=\"300\"\r\n            overflowToDisk=\"false\"\r\n            diskPersistent=\"false\"\r\n            diskExpiryThreadIntervalSeconds=\"300\"\r\n            memoryStoreEvictionPolicy=\"LRU\"\r\n            \/>\r\n   <cache\r\n    name=\"your.domain.object\"\r\n    maxElementsInMemory=\"5000\"\r\n    eternal=\"false\"\r\n    timeToIdleSeconds=\"300\"\r\n    timeToLiveSeconds=\"600\"\r\n    overflowToDisk=\"false\"\r\n   \/>\r\n<\/ehcache>\r\n<\/pre>\n
      Modify persistence.xml<\/strong><\/p>\n
      Persistence.xml file contains information related to the persitence unit such as connection pool info,
      \nclass or configuration to load. ‘persistence.xml’ is located in \/persistence\/META-INF<\/p>\n
      We will append properties for L2 cache. <\/p>\n
      <properties>\r\n            <property name=\"hibernate.dialect\" value=\"org.hibernate.dialect.MySQLDialect\"\/>\r\n            <property name=\"hibernate.cache.provider_class\" value=\"net.sf.ehcache.hibernate.SingletonEhCacheProvider\" \/>\r\n            <property name=\"net.sf.ehcache.configurationResourceName\" value=\"\/ehcache.xml\" \/>\r\n            <property name=\"hibernate.cache.use_query_cache\" value=\"true\" \/>\r\n            <property name=\"hibernate.cache.use_second_level_cache\" value=\"true\" \/>\r\n            <property name=\"hibernate.generate_statistics\" value=\"true\" \/>   \r\n\r\n        <\/properties>\r\n<\/pre>\n
      Add cache annotation<\/strong><\/p>\n
      Here the hibernate annotation is used instead of the standard one (Cacheable in fact seems not to work)
      \nPlace Cache annotation at class level of your domain object.<\/p>\n
      @org.hibernate.annotations.Cache(usage = org.hibernate.annotations.CacheConcurrencyStrategy.READ_WRITE)\r\n<\/pre>\n
      Example<\/span><\/p>\n
      Lazuly application <\/strong><\/span><\/p>\n
      Lazuly is a sample database holding conference information used for MinuteProject showcase purpose.
      \nMinuteproject generates a comprehensive set of artefacts to speedup the release of OX application.
      \nFurther information can be found in Minuteproject 4 Openxava Lazuly showcase<\/a>.
      \nOn this part we focus on the artefacts generated for the caching specific.
      \nMinuteproject for the generation base itself on a configuration file, where we define the datamodel to reverse engineer. In this configuration there is an enrichement part where you can add information.
      \nOne of this information deals with the type of content is held in an entity. There are 4 possibilities (reference-data, master-data, pseudo-static-data, live-business-data)
      \nIf you enrich your entity with the content-type=”master-data” or “reference-data” MinuteProject 4 Openxava will generate associated caching.<\/p>\n
      This is done here for the entity Country.<\/p>\n
      <entity name=\"COUNTRY\" content-type=\"reference-data\"><\/pre>\n
      Here are the cache related artefacts <\/u><\/p>\n
      ehcache.xml <\/strong><\/p>\n
      <ehcache>\r\n\r\n  <!--\r\n    Sets the path to the directory where cache files are created.\r\n\r\n    If the path is a Java System Property it is replaced by its value in the\r\n    running VM.\r\n\r\n    The following properties are translated:\r\n    * user.home - User's home directory\r\n    * user.dir - User's current working directory\r\n    * java.io.tmpdir - Default temp file path\r\n\r\n    Subdirectories can be specified below the property e.g. java.io.tmpdir\/one\r\n    -->\r\n<!--MP-MANAGED-UPDATABLE-BEGINNING-DISABLE @ehcache-main-config-conference@-->\r\n    <diskStore path=\"java.io.tmpdir\"\/>\r\n\r\n <!--\r\n    Mandatory Default Cache configuration. These settings will be applied to caches\r\n    created programmtically using CacheManager.add(String cacheName)\r\n    -->\r\n    <defaultCache\r\n            maxElementsInMemory=\"1000\"\r\n            eternal=\"false\"\r\n            timeToIdleSeconds=\"300\"\r\n            timeToLiveSeconds=\"300\"\r\n            overflowToDisk=\"false\"\r\n            diskPersistent=\"false\"\r\n            diskExpiryThreadIntervalSeconds=\"300\"\r\n            memoryStoreEvictionPolicy=\"LRU\"\r\n            \/>\r\n<!-- The unnamed query cache -->\r\n   <cache\r\n    name=\"org.hibernate.cache.StandardQueryCache\"\r\n    maxElementsInMemory=\"1000\"\r\n    eternal=\"false\"\r\n    timeToLiveSeconds=\"300\"\r\n    overflowToDisk=\"false\"\r\n   \/>\r\n<!--MP-MANAGED-UPDATABLE-ENDING-->\r\n\r\n<!--MP-MANAGED-UPDATABLE-BEGINNING-DISABLE @cache-entity-country-conference@-->\r\n   <cache\r\n    name=\"net.sf.mp.demo.conference.domain.admin.Country\"\r\n    maxElementsInMemory=\"5000\"\r\n    eternal=\"false\"\r\n    timeToIdleSeconds=\"300\"\r\n    timeToLiveSeconds=\"600\"\r\n    overflowToDisk=\"false\"\r\n   \/>\r\n<!--MP-MANAGED-UPDATABLE-ENDING-->\r\n\r\n<!--MP-MANAGED-ADDED-AREA-BEGINNING @custom-cache-definition@-->\r\n<!--MP-MANAGED-ADDED-AREA-ENDING @custom-cache-definition@-->\r\n\r\n<\/ehcache>\r\n<\/pre>\n
      Persistence.xml<\/strong>
       
      <\/div> <\/div><\/p>\n
      <persistence xmlns=\"http:\/\/java.sun.com\/xml\/ns\/persistence\"\r\n             xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\r\n             xsi:schemaLocation=\"http:\/\/java.sun.com\/xml\/ns\/persistence http:\/\/java.sun.com\/xml\/ns\/persistence\/persistence_1_0.xsd\"\r\n             version=\"1.0\">\r\n             \r\n    <!-- Tomcat + Hypersonic -->\r\n    <persistence-unit name=\"default\">\r\n     <non-jta-data-source>java:comp\/env\/jdbc\/conferenceDS<\/non-jta-data-source>\r\n     <class>org.openxava.session.GalleryImage<\/class>\r\n        <properties>\r\n            <property name=\"hibernate.dialect\" value=\"org.hibernate.dialect.MySQLDialect\"\/>\r\n            <property name=\"hibernate.cache.provider_class\" value=\"net.sf.ehcache.hibernate.SingletonEhCacheProvider\" \/>\r\n            <property name=\"net.sf.ehcache.configurationResourceName\" value=\"\/ehcache.xml\" \/>\r\n            <property name=\"hibernate.cache.use_query_cache\" value=\"true\" \/>\r\n            <property name=\"hibernate.cache.use_second_level_cache\" value=\"true\" \/>\r\n            <property name=\"hibernate.generate_statistics\" value=\"true\" \/>   \r\n<!--MP-MANAGED-ADDED-AREA-BEGINNING @properties@-->\r\n<!--MP-MANAGED-ADDED-AREA-ENDING @properties@-->\r\n        <\/properties>\r\n<!--MP-MANAGED-ADDED-AREA-BEGINNING @persistence-unit@-->\r\n<!--MP-MANAGED-ADDED-AREA-ENDING @persistence-unit@-->\r\n    <\/persistence-unit>       \r\n\r\n<!--MP-MANAGED-ADDED-AREA-BEGINNING @persistence@-->\r\n<!--MP-MANAGED-ADDED-AREA-ENDING @persistence@-->\r\n\r\n<\/persistence>\r\n<\/pre>\n
      Class annotation <\/strong><\/p>\n
      @org.hibernate.annotations.Cache(usage = org.hibernate.annotations.CacheConcurrencyStrategy.READ_WRITE)\r\n\/\/MP-MANAGED-ADDED-AREA-BEGINNING @class-annotation@\r\n\/\/MP-MANAGED-ADDED-AREA-ENDING @class-annotation@\r\npublic class Country {\r\n\r\n    @Hidden @Id @Column(name=\"id\" )\r\n    @GeneratedValue(strategy = GenerationType.AUTO)\r\n    private Integer id; \r\n...\r\n<\/pre>\n
      Generated code remark<\/strong><\/u> <\/p>\n
      The generated code has markers inside file extension comment.<\/p>\n
      Within MP-MANAGED-ADDED-AREA-BEGINNING and  MP-MANAGED-ADDED-AREA-ENDING you can place customized code
      \nWithin MP-MANAGED-UPDATABLE-BEGINNING-DISABLE and  MP-MANAGED-UPDATABLE-ENDING you can alter the code. To keep your modifications please change MP-MANAGED-UPDATABLE-BEGINNING-DISABLE into MP-MANAGED-UPDATABLE-BEGINNING-ENABLE.
      \nUpdatable code prevent you to lose your customisation over consecutive generations. <\/p>\n
      For more information on updatable code see Minuteproject updatable code<\/a>.<\/p>\n
      Generation<\/span><\/p>\n