annotate gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/cache/CacheFactory.java @ 1115:f953c9a559d8

Added license file and license headers. gnv-artifacts/trunk@1260 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Tue, 02 Nov 2010 17:46:55 +0000
parents cf421645a2d3
children
rev   line source
1115
f953c9a559d8 Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 1065
diff changeset
1 /*
f953c9a559d8 Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 1065
diff changeset
2 * Copyright (c) 2010 by Intevation GmbH
f953c9a559d8 Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 1065
diff changeset
3 *
f953c9a559d8 Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 1065
diff changeset
4 * This program is free software under the LGPL (>=v2.1)
f953c9a559d8 Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 1065
diff changeset
5 * Read the file LGPL.txt coming with the software for details
f953c9a559d8 Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 1065
diff changeset
6 * or visit http://www.gnu.org/licenses/ if it does not exist.
f953c9a559d8 Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 1065
diff changeset
7 */
f953c9a559d8 Added license file and license headers.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 1065
diff changeset
8
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
9 package de.intevation.gnv.artifacts.cache;
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
10
1065
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
11 import java.lang.management.ManagementFactory;
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
12
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
13 import javax.management.MBeanServer;
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
14
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
15 import net.sf.ehcache.Cache;
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
16 import net.sf.ehcache.CacheManager;
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
17
1065
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
18 import net.sf.ehcache.management.ManagementService;
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
19
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
20 import org.apache.log4j.Logger;
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
21
845
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
22 import de.intevation.gnv.geobackend.base.query.cache.CacheCleaner;
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
23 import de.intevation.gnv.state.cache.ThematicDataCacheCleaner;
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
24
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
25 /**
790
f198e4620546 Added and repaired JavaDoc in cache package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
26 * The <code>CacheFactory</code> is used to initialize and retrieve Cache.
803
feae2f9d6c6f Removed trailing whitespace.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 790
diff changeset
27 *
780
c4156275c1e1 Bring @author javadoc tags in form '@author <a href="john.doe@example.com">John Doe</a>'
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 779
diff changeset
28 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
29 */
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
30 public class CacheFactory {
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
31
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
32 /**
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
33 * the logger, used to log exceptions and additonaly information
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
34 */
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
35 private static Logger log = Logger.getLogger(CacheFactory.class);
171
7fb9441dd8af Format Code to max 80 Chars per Row and Cleanup
Tim Englich <tim.englich@intevation.de>
parents: 99
diff changeset
36
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
37 private final static String CACHENAME = "artifactdata";
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
38
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
39 /**
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
40 * The singleton Instance of this Factory.
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
41 */
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
42 private static CacheFactory instance = null;
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
43
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
44 /**
845
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
45 * The manager of the Cache
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
46 */
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
47 private CacheManager cacheManager = null;
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
48
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
49 /**
845
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
50 * The Cleaner of the Cache
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
51 */
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
52 private CacheCleaner cacheCleaner = null;
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
53
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
54 /**
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
55 * Basic-Constructor of this Class
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
56 */
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
57 private CacheFactory() {
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
58 super();
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
59 }
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
60
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
61 /**
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
62 * This Method provides an singleton Instance of this Class.
778
9a828e5a2390 Removed trailing whitespace
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 171
diff changeset
63 *
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
64 * @return an singleton Instance of this Class
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
65 */
171
7fb9441dd8af Format Code to max 80 Chars per Row and Cleanup
Tim Englich <tim.englich@intevation.de>
parents: 99
diff changeset
66 public static CacheFactory getInstance() {
7fb9441dd8af Format Code to max 80 Chars per Row and Cleanup
Tim Englich <tim.englich@intevation.de>
parents: 99
diff changeset
67 if (instance == null) {
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
68 instance = new CacheFactory();
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
69 }
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
70 return instance;
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
71 }
171
7fb9441dd8af Format Code to max 80 Chars per Row and Cleanup
Tim Englich <tim.englich@intevation.de>
parents: 99
diff changeset
72
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
73 /**
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
74 * Getting the ConnectionPool
778
9a828e5a2390 Removed trailing whitespace
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 171
diff changeset
75 *
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
76 * @return the ConnectionPool
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
77 */
171
7fb9441dd8af Format Code to max 80 Chars per Row and Cleanup
Tim Englich <tim.englich@intevation.de>
parents: 99
diff changeset
78 public Cache getCache() {
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
79 return this.cacheManager.getCache(CACHENAME);
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
80 }
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
81
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
82 /**
171
7fb9441dd8af Format Code to max 80 Chars per Row and Cleanup
Tim Englich <tim.englich@intevation.de>
parents: 99
diff changeset
83 * Initializes the ConnectionPool. Should only be called once on system
7fb9441dd8af Format Code to max 80 Chars per Row and Cleanup
Tim Englich <tim.englich@intevation.de>
parents: 99
diff changeset
84 * startup
778
9a828e5a2390 Removed trailing whitespace
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 171
diff changeset
85 *
790
f198e4620546 Added and repaired JavaDoc in cache package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
86 * @param configurationFileName
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
87 */
171
7fb9441dd8af Format Code to max 80 Chars per Row and Cleanup
Tim Englich <tim.englich@intevation.de>
parents: 99
diff changeset
88 public void initializeCache(String configurationFileName) {
7fb9441dd8af Format Code to max 80 Chars per Row and Cleanup
Tim Englich <tim.englich@intevation.de>
parents: 99
diff changeset
89 if (cacheManager == null) {
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
90 cacheManager = new CacheManager(configurationFileName);
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
91 cacheManager.addCache(CACHENAME);
1065
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
92
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
93 MBeanServer beanServer = ManagementFactory.getPlatformMBeanServer();
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
94 ManagementService.registerMBeans(
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
95 cacheManager, beanServer, false, false, false, true);
cf421645a2d3 Made cache statistics available as MBeans (eg in JConsole).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 845
diff changeset
96
845
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
97 this.cacheCleaner = new ThematicDataCacheCleaner();
797a6264b89b Integrated the CacheCleaner for the ThematicDataCache
Tim Englich <tim.englich@intevation.de>
parents: 803
diff changeset
98 this.cacheCleaner.start();
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
99 }
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
100 }
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
101
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
102 /**
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
103 * Checks if the ConnectionPool has already been initialized.
778
9a828e5a2390 Removed trailing whitespace
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 171
diff changeset
104 *
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
105 * @return true if the ConnectionPool is initialized.
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
106 */
171
7fb9441dd8af Format Code to max 80 Chars per Row and Cleanup
Tim Englich <tim.englich@intevation.de>
parents: 99
diff changeset
107 public boolean isInitialized() {
99
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
108 return this.cacheManager != null;
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
109 }
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
110
bb45c5097cb6 ehcache Integration for storing the chartresultvalues
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
111 }

http://dive4elements.wald.intevation.org