KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > servlet > PathHandler


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */

64
65 package com.jcorporate.expresso.core.servlet;
66
67 import com.jcorporate.expresso.core.misc.ConfigManager;
68 import com.jcorporate.expresso.core.misc.ConfigPathFixedParam;
69 import com.jcorporate.expresso.core.misc.ConfigPathMapping;
70 import com.jcorporate.expresso.core.misc.ConfigPathParam;
71 import com.jcorporate.expresso.core.misc.ConfigurationException;
72 import org.apache.log4j.Logger;
73 import org.apache.oro.text.regex.Pattern;
74 import org.apache.oro.text.regex.PatternMatcher;
75 import org.apache.oro.text.regex.Perl5Matcher;
76
77 import javax.servlet.RequestDispatcher JavaDoc;
78 import javax.servlet.ServletException JavaDoc;
79 import javax.servlet.http.HttpServletRequest JavaDoc;
80 import javax.servlet.http.HttpServletResponse JavaDoc;
81 import java.io.IOException JavaDoc;
82 import java.util.Enumeration JavaDoc;
83 import java.util.StringTokenizer JavaDoc;
84 import java.util.Vector JavaDoc;
85
86
87 /**
88  * Special servlet designed to interact with server-side Controller objects
89  *
90  * @author Michael Nash
91  */

92 public class PathHandler
93         extends DBServlet {
94     private static Logger log = Logger.getLogger(PathHandler.class);
95     private static PatternMatcher matcher = new Perl5Matcher();
96
97     public PathHandler() {
98     }
99
100     /**
101      * Utility method to set up the log for this object
102      */

103     private static void setupLog() {
104     }
105
106     /**
107      * Process the path to get the correct configuration
108      *
109      * @param req The Servlet Request
110      * @param res The servlet response.
111      */

112     private void process(HttpServletRequest JavaDoc req, HttpServletResponse JavaDoc res)
113             throws ServletException JavaDoc, IOException JavaDoc {
114         String JavaDoc originalPath = req.getPathInfo();
115
116         try {
117             for (Enumeration JavaDoc e = ConfigManager.getContext(getDBName(req)).getPathMappings().elements();
118                  e.hasMoreElements();) {
119                 ConfigPathMapping oneMapping = (ConfigPathMapping) e.nextElement();
120                 if (log.isDebugEnabled()) {
121                     log.debug("Mapping:" + oneMapping.getUrlPattern() + ", " +
122                             oneMapping.getPath());
123                 }
124
125                 if (log.isDebugEnabled()) {
126                     for (Enumeration JavaDoc ep = oneMapping.getParams().elements();
127                          ep.hasMoreElements();) {
128                         ConfigPathParam oneParam = (ConfigPathParam) ep.
129                                 nextElement();
130                         log.debug("-- Param:" + oneParam.getNumber() + ", " +
131                                 oneParam.getName());
132                     }
133                 }
134
135                 if (log.isDebugEnabled()) {
136                     for (Enumeration JavaDoc epf = oneMapping.getFixedParams().elements();
137                          epf.hasMoreElements();) {
138                         ConfigPathFixedParam oneFixedParam = (ConfigPathFixedParam) epf.nextElement();
139                         log.debug("-- Fixed:" + oneFixedParam.getName() + ", " +
140                                 oneFixedParam.getValue());
141                     }
142                 }
143
144                 Pattern p = oneMapping.getCompiledUrlPattern();
145
146                 boolean result;
147                 synchronized (matcher) {
148                     result = matcher.matches(originalPath, p);
149                 }
150
151                 if (result) {
152                     log.debug("Path Matches!");
153                     redirect(req, res, oneMapping);
154                 }
155             }
156         } catch (ConfigurationException ce) {
157             throw new ServletException JavaDoc(ce.getMessage());
158         }
159     }
160
161     private void redirect(HttpServletRequest JavaDoc req, HttpServletResponse JavaDoc res,
162                           ConfigPathMapping mapping)
163             throws ServletException JavaDoc, IOException JavaDoc {
164         String JavaDoc queryString = req.getQueryString();
165         String JavaDoc originalPath = req.getPathInfo();
166
167         if (log.isDebugEnabled()) {
168             log.debug("Path:" + originalPath);
169             log.debug("Query:" + queryString);
170         }
171
172         Vector JavaDoc params = new Vector JavaDoc();
173         StringTokenizer JavaDoc stk = new StringTokenizer JavaDoc(originalPath, "/");
174
175         while (stk.hasMoreElements()) {
176             params.addElement(stk.nextElement());
177         }
178
179         ConfigPathParam oneParam = null;
180         ConfigPathFixedParam oneFixedParam = null;
181         int numberNeeded = 0;
182         boolean needAmpersand = false;
183         StringBuffer JavaDoc newURL = new StringBuffer JavaDoc(mapping.getPath() + "?");
184
185         for (Enumeration JavaDoc ep = mapping.getParams().elements();
186              ep.hasMoreElements();) {
187             oneParam = (ConfigPathParam) ep.nextElement();
188
189             if (needAmpersand) {
190                 newURL.append("&");
191             }
192
193             numberNeeded = oneParam.getNumber();
194
195             if (numberNeeded <= params.size()) {
196                 newURL.append(oneParam.getName() + "=" +
197                         params.elementAt(numberNeeded));
198             }
199
200             needAmpersand = true;
201         }
202         for (Enumeration JavaDoc efp = mapping.getFixedParams().elements();
203              efp.hasMoreElements();) {
204             if (needAmpersand) {
205                 newURL.append("&");
206             }
207
208             oneFixedParam = (ConfigPathFixedParam) efp.nextElement();
209             newURL.append(oneFixedParam.getName() + "=" +
210                     oneFixedParam.getValue());
211         } /* for */
212
213
214         log.debug("New URL:" + newURL);
215
216         RequestDispatcher JavaDoc rd = getServletConfig().getServletContext().getRequestDispatcher(newURL.toString());
217
218         if (rd == null) {
219             throw new ServletException JavaDoc("Can't forward");
220         }
221
222         rd.forward(req, res);
223     }
224
225     /**
226      * Both GET and POST for the PathHandler simply pass thru to the
227      * "process" method.
228      */

229     public void doGet(HttpServletRequest JavaDoc request, HttpServletResponse JavaDoc response)
230             throws ServletException JavaDoc, IOException JavaDoc {
231         super.doGet(request, response);
232         setupLog();
233         process(request, response);
234     } /* doGet(HttpServletRequest, HttpServletResponse) */
235
236
237     /**
238      * Both GET and POST for the PathHandler simply pass thru to the
239      * "process" method.
240      */

241     public void doPost(HttpServletRequest JavaDoc request,
242                        HttpServletResponse JavaDoc response)
243             throws ServletException JavaDoc, IOException JavaDoc {
244         super.doGet(request, response);
245         setupLog();
246         process(request, response);
247     } /* doGet(HttpServletRequest, HttpServletResponse) */
248
249
250 }
Popular Tags