annotate common/src/main/java/digilib/servlet/DigilibConfiguration.java @ 903:7779b37d1d05

refactored into maven modules per servlet type. can build servlet-api 2.3 and 3.0 via profile now!
author robcast
date Tue, 26 Apr 2011 20:24:31 +0200
parents
children 28d007673346
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
903
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
1 /*
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
2 * DigilibConfiguration -- Holding all parameters for digilib servlet.
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
3 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
4 * Digital Image Library servlet components
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
5 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
6 * Copyright (C) 2001, 2002 Robert Casties (robcast@mail.berlios.de)
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
7 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
8 * This program is free software; you can redistribute it and/or modify it
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
9 * under the terms of the GNU General Public License as published by the Free
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
10 * Software Foundation; either version 2 of the License, or (at your option)
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
11 * any later version.
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
12 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
13 * Please read license.txt for the full details. A copy of the GPL may be found
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
14 * at http://www.gnu.org/copyleft/lgpl.html
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
15 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
16 * You should have received a copy of the GNU General Public License along with
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
17 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
18 * Place, Suite 330, Boston, MA 02111-1307 USA
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
19 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
20 */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
21
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
22 package digilib.servlet;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
23
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
24 import java.io.IOException;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
25
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
26 import org.apache.log4j.BasicConfigurator;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
27 import org.apache.log4j.Logger;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
28
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
29 import digilib.image.DocuImage;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
30 import digilib.image.DocuImageImpl;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
31 import digilib.io.ImageInput;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
32 import digilib.util.ParameterMap;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
33
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
34 /**
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
35 * Class to hold the digilib servlet configuration parameters. The parameters
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
36 * can be read from the digilib-config file and be passed to other servlets or
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
37 * beans. <br>errorImgFileName: image file to send in case of error. <br>
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
38 * denyImgFileName: image file to send if access is denied. <br>baseDirs:
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
39 * array of base directories in order of preference (prescaled versions first).
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
40 * <br>useAuth: use authentication information. <br>authConfPath:
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
41 * authentication configuration file. <br>... <br>
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
42 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
43 * @author casties
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
44 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
45 */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
46 public abstract class DigilibConfiguration extends ParameterMap {
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
47
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
48 /** DocuImage class instance */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
49 protected static Class<DocuImageImpl> docuImageClass = null;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
50
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
51 /** Log4J logger */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
52 protected Logger logger = Logger.getLogger("digilib.config");
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
53
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
54 /**
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
55 * Default constructor defines all parameters and their default values.
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
56 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
57 */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
58 public DigilibConfiguration() {
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
59 super(20);
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
60 // we start with a default logger config
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
61 BasicConfigurator.configure();
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
62 initParams();
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
63 }
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
64
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
65 /**
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
66 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
67 */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
68 protected void initParams() {
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
69 /*
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
70 * Definition of parameters and default values. System parameters that
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
71 * are not read from config file have a type 's'.
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
72 */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
73 }
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
74
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
75 /**
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
76 * Creates a new DocuImage instance.
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
77 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
78 * The type of DocuImage is specified by docuimage-class.
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
79 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
80 * @return DocuImage
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
81 */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
82 public static DocuImage getDocuImageInstance() {
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
83 DocuImageImpl di = null;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
84 try {
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
85 di = docuImageClass.newInstance();
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
86 } catch (Exception e) {
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
87 }
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
88 return di;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
89 }
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
90
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
91 /**
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
92 * Check image size and type and store in ImageFile imgf
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
93 *
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
94 * @param imgf
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
95 * @return
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
96 * @throws IOException
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
97 */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
98 public static ImageInput identifyDocuImage(ImageInput imgf) throws IOException {
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
99 // use fresh DocuImage instance
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
100 DocuImage di = getDocuImageInstance();
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
101 return di.identify(imgf);
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
102 }
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
103
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
104 /**
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
105 * @return Returns the docuImageClass.
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
106 */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
107 public static Class<DocuImageImpl> getDocuImageClass() {
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
108 return docuImageClass;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
109 }
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
110
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
111 /**
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
112 * @param docuImageClass The docuImageClass to set.
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
113 */
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
114 public static void setDocuImageClass(Class<DocuImageImpl> dic) {
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
115 docuImageClass = dic;
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
116 }
7779b37d1d05 refactored into maven modules per servlet type.
robcast
parents:
diff changeset
117 }