annotate servlet/src/digilib/servlet/ServletOps.java @ 291:1cec876f2788 gen2

servlet version 2b1 ("scaleable digilib") - only using Semaphore to limit max number of threads
author robcast
date Thu, 21 Oct 2004 22:00:55 +0200
parents 5d0c0da080ec
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
1 /*
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
2 * ServletOps -- Servlet utility class
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
3 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
4 * Digital Image Library servlet components
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
5 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
6 * Copyright (C) 2001, 2002 Robert Casties (robcast@mail.berlios.de)
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
7 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
8 * This program is free software; you can redistribute it and/or modify it under
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
9 * the terms of the GNU General Public License as published by the Free Software
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
10 * Foundation; either version 2 of the License, or (at your option) any later
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
11 * version.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
12 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
13 * Please read license.txt for the full details. A copy of the GPL may be found
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
14 * at http://www.gnu.org/copyleft/lgpl.html
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
15 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
16 * You should have received a copy of the GNU General Public License along with
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
17 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
18 * Place, Suite 330, Boston, MA 02111-1307 USA
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
19 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
20 */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
21
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
22 package digilib.servlet;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
23
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
24 import java.io.File;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
25 import java.io.FileInputStream;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
26 import java.io.IOException;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
27 import java.io.OutputStream;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
28 import java.io.PrintWriter;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
29 import java.util.StringTokenizer;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
30
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
31 import javax.servlet.ServletConfig;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
32 import javax.servlet.http.HttpServletResponse;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
33
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
34 import org.apache.log4j.Logger;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
35
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
36 import digilib.io.FileOpException;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
37 import digilib.io.FileOps;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
38
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
39 public class ServletOps {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
40
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
41 private static Logger logger = Logger.getLogger("servlet.op");
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
42
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
43 /**
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
44 * convert a string with a list of pathnames into an array of strings using
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
45 * the system's path seperator string
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
46 */
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
47 public static String[] getPathArray(String paths) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
48 // split list into directories
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
49 StringTokenizer dirs = new StringTokenizer(paths,
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
50 java.io.File.pathSeparator);
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
51 int n = dirs.countTokens();
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
52 if (n < 1) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
53 return null;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
54 }
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
55 // add directories into array
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
56 String[] pathArray = new String[n];
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
57 for (int i = 0; i < n; i++) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
58 pathArray[i] = dirs.nextToken();
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
59 }
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
60 return pathArray;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
61 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
62
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
63 /**
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
64 * get a real File for a config File.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
65 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
66 * If the File is not absolute the path is appended to the WEB-INF directory
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
67 * of the web-app.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
68 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
69 * @param file
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
70 * @param sc
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
71 * @return
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
72 */
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
73 public static File getConfigFile(File f, ServletConfig sc) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
74 // is the filename absolute?
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
75 if (!f.isAbsolute()) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
76 // relative path -> use getRealPath to resolve in WEB-INF
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
77 String fn = sc.getServletContext().getRealPath(
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
78 "WEB-INF/" + f.getPath());
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
79 f = new File(fn);
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
80 }
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
81 return f;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
82 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
83
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
84 /**
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
85 * get a real file name for a config file pathname.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
86 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
87 * If filename starts with "/" its treated as absolute else the path is
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
88 * appended to the WEB-INF directory of the web-app.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
89 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
90 * @param filename
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
91 * @param sc
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
92 * @return
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
93 */
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
94 public static String getConfigFile(String filename, ServletConfig sc) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
95 File f = new File(filename);
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
96 // is the filename absolute?
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
97 if (!f.isAbsolute()) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
98 // relative path -> use getRealPath to resolve in WEB-INF
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
99 filename = sc.getServletContext()
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
100 .getRealPath("WEB-INF/" + filename);
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
101 }
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
102 return filename;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
103 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
104
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
105 /**
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
106 * print a servlet response and exit
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
107 */
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
108 public static void htmlMessage(String msg, HttpServletResponse response)
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
109 throws IOException {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
110 htmlMessage("Scaler", msg, response);
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
111 }
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
112
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
113 /**
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
114 * print a servlet response and exit
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
115 */
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
116 public static void htmlMessage(String title, String msg,
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
117 HttpServletResponse response) throws IOException {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
118 response.setContentType("text/html; charset=iso-8859-1");
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
119 PrintWriter out = response.getWriter();
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
120 out.println("<html>");
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
121 out.println("<head><title>" + title + "</title></head>");
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
122 out.println("<body>");
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
123 out.println("<p>" + msg + "</p>");
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
124 out.println("</body></html>");
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
125 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
126
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
127 /**
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
128 * Transfers an image file as-is with the mime type mt.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
129 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
130 * The local file is copied to the <code>OutputStream</code> of the
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
131 * <code>ServletResponse</code>. If mt is null then the mime-type is
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
132 * auto-detected with mimeForFile.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
133 *
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
134 * @param mt
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
135 * mime-type of the file.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
136 * @param f
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
137 * Image file to be sent.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
138 * @param res
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
139 * ServletResponse where the image file will be sent.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
140 * @throws FileOpException
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
141 * Exception is thrown for a IOException.
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
142 */
291
1cec876f2788 servlet version 2b1 ("scaleable digilib")
robcast
parents: 290
diff changeset
143 public static void sendFile(File f, String mt,
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
144 HttpServletResponse response) throws FileOpException {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
145 logger.debug("sendRawFile(" + mt + ", " + f + ")");
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
146 if (mt == null) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
147 // auto-detect mime-type
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
148 mt = FileOps.mimeForFile(f);
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
149 if (mt == null) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
150 throw new FileOpException("Unknown file type.");
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
151 }
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
152 }
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
153 response.setContentType(mt);
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
154 // open file
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
155 try {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
156 if (mt.equals("application/octet-stream")) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
157 response.addHeader("Content-Disposition",
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
158 "attachment; filename=\"" + f.getName() + "\"");
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
159 }
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
160 FileInputStream inFile = new FileInputStream(f);
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
161 OutputStream outStream = response.getOutputStream();
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
162 byte dataBuffer[] = new byte[4096];
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
163 int len;
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
164 while ((len = inFile.read(dataBuffer)) != -1) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
165 // copy out file
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
166 outStream.write(dataBuffer, 0, len);
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
167 }
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
168 inFile.close();
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
169 response.flushBuffer();
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
170 } catch (IOException e) {
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
171 throw new FileOpException("Unable to send file.");
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
172 }
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
173 }
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
174
290
5d0c0da080ec digilib servlet version 2 ("scaleable digilib")
robcast
parents: 1
diff changeset
175 }