Mercurial > dive4elements > gnv-client
annotate gnv/src/main/java/de/intevation/gnv/propertiesreader/ServletPropertiesReader.java @ 960:c3d628c2c4c3
Add more Javadocs
gnv/trunk@1104 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Tim Englich <tim.englich@intevation.de> |
---|---|
date | Tue, 18 May 2010 10:08:57 +0000 |
parents | 89ade245ca7a |
children | 28a0628b11b0 |
rev | line source |
---|---|
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
1 package de.intevation.gnv.propertiesreader; |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
2 |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
3 import java.util.Enumeration; |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
4 import java.util.HashMap; |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
5 import java.util.Map; |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
6 |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
7 import javax.servlet.ServletConfig; |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
8 |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
9 import org.apache.log4j.Logger; |
690
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
10 |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
11 /** |
960 | 12 * This reader fetches the properties it will provide from the |
13 * <code>ServletConfig</code> of an <code>Context</code>. | |
14 * It will read the InitParameters which could be configured using | |
15 * the <code>web.xml</code-file of each <code>context</code>. | |
16 * | |
684
57fa8019fbdc
Bring @author javadoc tags in form '@author <a href="john.doe@example.com">John Doe</a>'
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
683
diff
changeset
|
17 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
681
15ac78a91d1b
Removed trailing whitespace.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
36
diff
changeset
|
18 * |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
19 */ |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
20 public class ServletPropertiesReader implements PropertiesReader { |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
21 |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
22 /** |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
23 * the logger, used to log exceptions and additonaly information |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
24 */ |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
25 private static Logger log = Logger.getLogger(ServletPropertiesReader.class); |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
26 |
960 | 27 /** |
28 * The properties which are read from the <code>ServletConfig</code>. | |
29 */ | |
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
3
diff
changeset
|
30 private Map<String, String> properties = null; |
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
3
diff
changeset
|
31 |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
32 /** |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
33 * Constructor |
960 | 34 * |
35 * @param config the <code>ServletConfig</code> where | |
36 * the properties should be read from. | |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
37 */ |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
38 public ServletPropertiesReader(ServletConfig config) { |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
39 super(); |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
40 log.info("ServletPropertiesReader will be initialized"); |
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
3
diff
changeset
|
41 if (config != null) { |
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
3
diff
changeset
|
42 |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
43 Enumeration<String> keys = config.getInitParameterNames(); |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
44 properties = new HashMap<String, String>(); |
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
3
diff
changeset
|
45 while (keys.hasMoreElements()) { |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
46 String key = keys.nextElement(); |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
47 String value = config.getInitParameter(key); |
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
3
diff
changeset
|
48 log.info("New ConbfigurationValue; " + key + " ==> " + value); |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
49 this.properties.put(key, value); |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
50 } |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
51 } |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
52 } |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
53 |
690
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
54 |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
55 public String getPropertieValue(String key, String defaultValue) { |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
56 String value = this.properties.get(key); |
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
3
diff
changeset
|
57 if (value == null) { |
3
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
58 value = defaultValue; |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
59 } |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
60 return value; |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
61 } |
d7b4a77ba892
Infrastructur for Providing Applicationsettings
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
62 } |
700
89ade245ca7a
Using unix line endings only.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
690
diff
changeset
|
63 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |