Mercurial > hg > digilib-old

annotate servlet/src/digilib/servlet/Scaler.java @ 867:987cfe401970 stream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add default error message type config.
author robcast
date Thu, 10 Mar 2011 21:21:10 +0100
parents ace973a106b5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
1 package digilib.servlet;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
2
79
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
3 import java.io.File;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
4 import java.io.IOException;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
5 import java.util.List;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
6
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
7 import javax.servlet.AsyncContext;
79
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
8 import javax.servlet.ServletConfig;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
9 import javax.servlet.ServletContext;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
10 import javax.servlet.ServletException;
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
11 import javax.servlet.annotation.WebServlet;
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
12 import javax.servlet.http.HttpServlet;
79
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
13 import javax.servlet.http.HttpServletRequest;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
14 import javax.servlet.http.HttpServletResponse;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
15
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
16 import org.apache.log4j.Logger;
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
17
79
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
18 import digilib.auth.AuthOpException;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
19 import digilib.auth.AuthOps;
543
919e008ab1fb more steps towards more standard java.util.concurrent design
robcast
parents: 542
diff changeset
20 import digilib.image.DocuImage;
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
21 import digilib.image.ImageJobDescription;
570
fd2ef7e46119 more cleanup, set version to 1.8.2
robcast
parents: 563
diff changeset
22 import digilib.image.ImageOpException;
86
997ba69afb81 New version 1.8b1.
robcast
parents: 85
diff changeset
23 import digilib.io.DocuDirCache;
335
9bce7008a514 Servlet version 1.5.3b
robcast
parents: 303
diff changeset
24 import digilib.io.DocuDirectory;
588
aee436f0549d more work on stream input
robcast
parents: 577
diff changeset
25 import digilib.io.ImageInput;
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
26 import digilib.util.DigilibJobCenter;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
27
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
28 @WebServlet(name="Scaler", urlPatterns={"/Scaler", "/servlet/Scaler/*"}, asyncSupported=true)
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
29 public class Scaler extends HttpServlet {
263
e16d132aa6f6 Servlet version 1.21b1
robcast
parents: 253
diff changeset
30
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
31 private static final long serialVersionUID = 5289386646192471549L;
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
32
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
33 /** digilib servlet version (for all components) */
867
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
34 public static final String version = "1.9.1a26";
79
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
35
558
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
36 /** servlet error codes */
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
37 public static enum Error {UNKNOWN, AUTH, FILE, IMAGE};
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
38
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
39 /** type of error message */
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
40 public static enum ErrMsg {IMAGE, TEXT, CODE};
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
41
867
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
42 /** default error message type */
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
43 public static ErrMsg defaultErrMsgType = ErrMsg.IMAGE;
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
44
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
45 /** logger for accounting requests */
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
46 protected static Logger accountlog = Logger.getLogger("account.request");
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
47
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
48 /** gengeral logger for this class */
572
800f2bb57f1f slightly better logging
robcast
parents: 571
diff changeset
49 protected static Logger logger = Logger.getLogger("digilib.scaler");
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
50
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
51 /** logger for authentication related */
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
52 protected static Logger authlog = Logger.getLogger("digilib.auth");
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
53
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
54 /** DocuDirCache instance */
837
e718f3441d39 small cleanup
robcast
parents: 836
diff changeset
55 protected DocuDirCache dirCache;
161
ace2a4a0ba74 servlet version 1.16a4
robcast
parents: 156
diff changeset
56
543
919e008ab1fb more steps towards more standard java.util.concurrent design
robcast
parents: 542
diff changeset
57 /** Image executor */
837
e718f3441d39 small cleanup
robcast
parents: 836
diff changeset
58 protected DigilibJobCenter<DocuImage> imageJobCenter;
543
919e008ab1fb more steps towards more standard java.util.concurrent design
robcast
parents: 542
diff changeset
59
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
60 /** authentication error image file */
837
e718f3441d39 small cleanup
robcast
parents: 836
diff changeset
61 public static File denyImgFile;
298
1ecaf9c1fd8a Servlet version 1.5.0b -- the beginning of the next generation :-)
robcast
parents: 288
diff changeset
62
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
63 /** image error image file */
837
e718f3441d39 small cleanup
robcast
parents: 836
diff changeset
64 public static File errorImgFile;
298
1ecaf9c1fd8a Servlet version 1.5.0b -- the beginning of the next generation :-)
robcast
parents: 288
diff changeset
65
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
66 /** not found error image file */
837
e718f3441d39 small cleanup
robcast
parents: 836
diff changeset
67 public static File notfoundImgFile;
298
1ecaf9c1fd8a Servlet version 1.5.0b -- the beginning of the next generation :-)
robcast
parents: 288
diff changeset
68
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
69 /** send files as is? */
837
e718f3441d39 small cleanup
robcast
parents: 836
diff changeset
70 protected boolean sendFileAllowed = true;
298
1ecaf9c1fd8a Servlet version 1.5.0b -- the beginning of the next generation :-)
robcast
parents: 288
diff changeset
71
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
72 /** DigilibConfiguration instance */
837
e718f3441d39 small cleanup
robcast
parents: 836
diff changeset
73 protected DigilibConfiguration dlConfig;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
74
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
75 /** use authorization database */
837
e718f3441d39 small cleanup
robcast
parents: 836
diff changeset
76 protected boolean useAuthorization = true;
298
1ecaf9c1fd8a Servlet version 1.5.0b -- the beginning of the next generation :-)
robcast
parents: 288
diff changeset
77
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
78 /** AuthOps instance */
837
e718f3441d39 small cleanup
robcast
parents: 836
diff changeset
79 protected AuthOps authOp;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
80
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
81 /**
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
82 * Initialisation on first run.
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
83 *
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
84 * @throws ServletException
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
85 *
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
86 * @see javax.servlet.Servlet#init(javax.servlet.ServletConfig)
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
87 */
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
88 public void init(ServletConfig config) throws ServletException {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
89 super.init(config);
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 177
diff changeset
90
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
91 System.out
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
92 .println("***** Digital Image Library Image Scaler Servlet (version "
563
686086d6e6d6 more refactoring and rearranging
robcast
parents: 558
diff changeset
93 + version + ") *****");
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
94 // say hello in the log file
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
95 logger.info("***** Digital Image Library Image Scaler Servlet (version "
563
686086d6e6d6 more refactoring and rearranging
robcast
parents: 558
diff changeset
96 + version + ") *****");
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
97
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
98 // get our ServletContext
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
99 ServletContext context = config.getServletContext();
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
100 // see if there is a Configuration instance
806
d811204ce5a4 Initialiser is now a ServletContextListener (doesn't need web.xml).
robcast
parents: 804
diff changeset
101 dlConfig = (DigilibConfiguration) context.getAttribute("digilib.servlet.configuration");
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
102 if (dlConfig == null) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
103 // no Configuration
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
104 throw new ServletException("No Configuration!");
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
105 }
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
106 // set our AuthOps
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
107 useAuthorization = dlConfig.getAsBoolean("use-authorization");
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
108 authOp = (AuthOps) dlConfig.getValue("servlet.auth.op");
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
109
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
110 // DocuDirCache instance
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
111 dirCache = (DocuDirCache) dlConfig.getValue("servlet.dir.cache");
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
112
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
113 // Executor
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
114 imageJobCenter = (DigilibJobCenter<DocuImage>) dlConfig
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
115 .getValue("servlet.worker.imageexecutor");
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
116
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
117 denyImgFile = ServletOps.getFile(
806
d811204ce5a4 Initialiser is now a ServletContextListener (doesn't need web.xml).
robcast
parents: 804
diff changeset
118 (File) dlConfig.getValue("denied-image"), context);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
119 errorImgFile = ServletOps.getFile(
806
d811204ce5a4 Initialiser is now a ServletContextListener (doesn't need web.xml).
robcast
parents: 804
diff changeset
120 (File) dlConfig.getValue("error-image"), context);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
121 notfoundImgFile = ServletOps.getFile(
806
d811204ce5a4 Initialiser is now a ServletContextListener (doesn't need web.xml).
robcast
parents: 804
diff changeset
122 (File) dlConfig.getValue("notfound-image"), context);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
123 sendFileAllowed = dlConfig.getAsBoolean("sendfile-allowed");
867
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
124 try {
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
125 defaultErrMsgType = ErrMsg.valueOf(dlConfig.getAsString("default-errmsg-type"));
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
126 } catch (Exception e) {
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
127 // nothing to do
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
128 }
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
129 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
130
821
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
131 /**
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
132 * Returns modification time relevant to the request for caching.
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
133 *
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
134 * @see javax.servlet.http.HttpServlet#getLastModified(javax.servlet.http.HttpServletRequest)
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
135 */
750
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
136 public long getLastModified(HttpServletRequest request) {
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
137 accountlog.debug("GetLastModified from " + request.getRemoteAddr()
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
138 + " for " + request.getQueryString());
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
139 long mtime = -1;
821
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
140 try {
833
8ee72433bb8f logs more request and response headers.
robcast
parents: 831
diff changeset
141 // create new digilib request
821
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
142 DigilibRequest dlReq = new DigilibRequest(request);
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
143 DocuDirectory dd = dirCache.getDirectory(dlReq.getFilePath());
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
144 if (dd != null) {
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
145 mtime = dd.getDirMTime() / 1000 * 1000;
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
146 }
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
147 } catch (Exception e) {
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
148 logger.error("error in getLastModified: " + e.getMessage());
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
149 }
821
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
150 logger.debug(" returns " + mtime);
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
151 return mtime;
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
152 }
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
153
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
154 /* (non-Javadoc)
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
155 * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
156 */
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
157 public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException {
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
158 accountlog.info("GET from " + request.getRemoteAddr());
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
159 this.processRequest(request, response);
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
160 }
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
161
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
162
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
163 /* (non-Javadoc)
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
164 * @see javax.servlet.http.HttpServlet#doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
165 */
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
166 public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException {
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
167 accountlog.info("POST from " + request.getRemoteAddr());
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
168 this.processRequest(request, response);
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
169 }
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
170
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
171
750
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
172 protected void doHead(HttpServletRequest req, HttpServletResponse resp)
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
173 throws ServletException, IOException {
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
174 logger.debug("HEAD from "+req.getRemoteAddr());
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
175 super.doHead(req, resp);
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
176 }
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
177
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
178 protected void doOptions(HttpServletRequest req, HttpServletResponse resp)
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
179 throws ServletException, IOException {
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
180 logger.debug("OPTIONS from "+req.getRemoteAddr());
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
181 super.doOptions(req, resp);
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
182 }
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
183
4f5aaa0de456 removed synchronized from some methods
robcast
parents: 594
diff changeset
184 /** Service this request using the response.
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
185 * @param request
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
186 * @param response
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
187 * @throws ServletException
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
188 */
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
189 public void processRequest(HttpServletRequest request,
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
190 HttpServletResponse response) throws ServletException {
487
6c01d283e90e Servlet version 1.16.1
robcast
parents: 478
diff changeset
191
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
192 if (dlConfig == null) {
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
193 logger.error("ERROR: No Configuration!");
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
194 throw new ServletException("NO VALID digilib CONFIGURATION!");
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
195 }
502
157d4c7d2343 readded support for direct sending of image files
cmielack
parents: 501
diff changeset
196
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
197 accountlog.debug("request: " + request.getQueryString());
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
198 logger.debug("request: " + request.getQueryString());
833
8ee72433bb8f logs more request and response headers.
robcast
parents: 831
diff changeset
199 logger.debug("headers: " + ServletOps.headersToString(request));
8ee72433bb8f logs more request and response headers.
robcast
parents: 831
diff changeset
200 //logger.debug("response:"+ response + " committed=" + response.isCommitted());
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
201 final long startTime = System.currentTimeMillis();
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
202
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
203 // parse request
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
204 DigilibRequest dlRequest = new DigilibRequest(request);
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
205 // extract the job information
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
206 final ImageJobDescription jobTicket = ImageJobDescription.getInstance(dlRequest, dlConfig);
502
157d4c7d2343 readded support for direct sending of image files
cmielack
parents: 501
diff changeset
207
558
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
208 // type of error reporting
867
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
209 ErrMsg errMsgType = defaultErrMsgType;
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
210 if (dlRequest.hasOption("errimg")) {
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
211 errMsgType = ErrMsg.IMAGE;
987cfe401970 add default error message type config.
robcast
parents: 865
diff changeset
212 } else if (dlRequest.hasOption("errtxt")) {
558
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
213 errMsgType = ErrMsg.TEXT;
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
214 } else if (dlRequest.hasOption("errcode")) {
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
215 errMsgType = ErrMsg.CODE;
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
216 }
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
217
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
218 try {
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
219 /*
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
220 * check if we can fast-track without scaling
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
221 */
593
7768ea8f59cf more work on stream input -- cleaning up references to files
robcast
parents: 588
diff changeset
222 ImageInput fileToLoad = (ImageInput) jobTicket.getInput();
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
223
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
224 // check permissions
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
225 if (useAuthorization) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
226 // get a list of required roles (empty if no restrictions)
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
227 List<String> rolesRequired = authOp.rolesForPath(
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
228 jobTicket.getFilePath(), request);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
229 if (rolesRequired != null) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
230 authlog.debug("Role required: " + rolesRequired);
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
231 authlog.debug("User: " + request.getRemoteUser());
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
232 // is the current request/user authorized?
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
233 if (!authOp.isRoleAuthorized(rolesRequired, request)) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
234 // send deny answer and abort
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
235 throw new AuthOpException();
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
236 }
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
237 }
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
238 }
79
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality:
robcast
parents: 73
diff changeset
239
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
240 // if requested, send image as a file
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
241 if (sendFileAllowed && jobTicket.getSendAsFile()) {
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
242 String mt = null;
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
243 if (jobTicket.hasOption("rawfile")) {
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
244 mt = "application/octet-stream";
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
245 }
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
246 logger.debug("Sending RAW File as is.");
572
800f2bb57f1f slightly better logging
robcast
parents: 571
diff changeset
247 ServletOps.sendFile(fileToLoad.getFile(), mt, null, response, logger);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
248 logger.info("Done in " + (System.currentTimeMillis() - startTime) + "ms");
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
249 return;
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
250 }
487
6c01d283e90e Servlet version 1.16.1
robcast
parents: 478
diff changeset
251
547
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
252 // if possible, send the image without actually having to transform it
e1094c5ec032 more cleanup and refactoring
robcast
parents: 544
diff changeset
253 if (! jobTicket.isTransformRequired()) {
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
254 logger.debug("Sending File as is.");
572
800f2bb57f1f slightly better logging
robcast
parents: 571
diff changeset
255 ServletOps.sendFile(fileToLoad.getFile(), null, null, response, logger);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
256 logger.info("Done in " + (System.currentTimeMillis() - startTime) + "ms");
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
257 return;
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
258 }
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 177
diff changeset
259
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
260 // check load of workers
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
261 if (imageJobCenter.isBusy()) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
262 logger.error("Servlet overloaded!");
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
263 response.sendError(HttpServletResponse.SC_SERVICE_UNAVAILABLE);
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
264 return;
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
265 }
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
266
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
267 // worker job is done asynchronously
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
268 AsyncContext asyncCtx = request.startAsync(request, response);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
269 // create job
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
270 AsyncServletWorker job = new AsyncServletWorker(dlConfig, jobTicket, asyncCtx, errMsgType, startTime);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
271 // submit job
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
272 imageJobCenter.submit(job);
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
273 // we're done for now
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
274
570
fd2ef7e46119 more cleanup, set version to 1.8.2
robcast
parents: 563
diff changeset
275 } catch (ImageOpException e) {
fd2ef7e46119 more cleanup, set version to 1.8.2
robcast
parents: 563
diff changeset
276 logger.error(e.getClass() + ": " + e.getMessage());
fd2ef7e46119 more cleanup, set version to 1.8.2
robcast
parents: 563
diff changeset
277 digilibError(errMsgType, Error.IMAGE, null, response);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
278 } catch (IOException e) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
279 logger.error(e.getClass() + ": " + e.getMessage());
558
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
280 digilibError(errMsgType, Error.FILE, null, response);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
281 } catch (AuthOpException e) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
282 logger.error(e.getClass() + ": " + e.getMessage());
558
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
283 digilibError(errMsgType, Error.AUTH, null, response);
821
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
284 } catch (Exception e) {
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
285 logger.error("Other Exception: ", e);
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
286 // TODO: should we rethrow or swallow?
6c752969f9e8 more tries and catches...
robcast
parents: 819
diff changeset
287 //throw new ServletException(e);
543
919e008ab1fb more steps towards more standard java.util.concurrent design
robcast
parents: 542
diff changeset
288 }
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
289 }
298
1ecaf9c1fd8a Servlet version 1.5.0b -- the beginning of the next generation :-)
robcast
parents: 288
diff changeset
290
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
291 /**
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
292 * Sends an error to the client as text or image.
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
293 *
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
294 * @param type
558
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
295 * @param error
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
296 * @param msg
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
297 * @param response
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
298 */
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
299 public static void digilibError(ErrMsg type, Error error, String msg,
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
300 HttpServletResponse response) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
301 try {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
302 File img = null;
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
303 int status = 0;
558
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
304 if (error == Error.AUTH) {
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
305 if (msg == null) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
306 msg = "ERROR: Unauthorized access!";
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
307 }
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
308 img = denyImgFile;
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
309 status = HttpServletResponse.SC_FORBIDDEN;
558
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
310 } else if (error == Error.FILE) {
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
311 if (msg == null) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
312 msg = "ERROR: Image file not found!";
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
313 }
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
314 img = notfoundImgFile;
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
315 status = HttpServletResponse.SC_NOT_FOUND;
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
316 } else {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
317 if (msg == null) {
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
318 msg = "ERROR: Other image error!";
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
319 }
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
320 img = errorImgFile;
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
321 status = HttpServletResponse.SC_BAD_REQUEST;
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
322 }
803
225054177f67 remove all ServletOutputStream.flush(). (stupid me ;-)
robcast
parents: 752
diff changeset
323 if (response.isCommitted()) {
225054177f67 remove all ServletOutputStream.flush(). (stupid me ;-)
robcast
parents: 752
diff changeset
324 // response already committed
804
587c90bc5976 first version using officially approved Servlet 3.0 async support.
robcast
parents: 802
diff changeset
325 logger.warn("Response committed for error "+msg);
803
225054177f67 remove all ServletOutputStream.flush(). (stupid me ;-)
robcast
parents: 752
diff changeset
326 }
558
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
327 if (type == ErrMsg.TEXT) {
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
328 ServletOps.htmlMessage(msg, response);
558
2e971b9f3022 added some enums
robcast
parents: 557
diff changeset
329 } else if (type == ErrMsg.CODE) {
557
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
330 response.sendError(status, msg);
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
331 } else if (img != null) {
0885f5ca5b24 more refactoring and rearranging
robcast
parents: 552
diff changeset
332 // default: image
572
800f2bb57f1f slightly better logging
robcast
parents: 571
diff changeset
333 ServletOps.sendFile(img, null, null, response, logger);
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
334 }
570
fd2ef7e46119 more cleanup, set version to 1.8.2
robcast
parents: 563
diff changeset
335 } catch (Exception e) {
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
336 logger.error("Error sending error!", e);
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
337 }
298
1ecaf9c1fd8a Servlet version 1.5.0b -- the beginning of the next generation :-)
robcast
parents: 288
diff changeset
338
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
339 }
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
340
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
341 public static String getVersion() {
563
686086d6e6d6 more refactoring and rearranging
robcast
parents: 558
diff changeset
342 return version;
544
5ff500d6812a more steps towards more standard java.util.concurrent design
robcast
parents: 543
diff changeset
343 }
489
882ee6a055bd try to fix small problem with version number display
robcast
parents: 487
diff changeset
344
500
b2325b33b77b completely restructured the scaler
cmielack
parents: 1
diff changeset
345 }