01: /**
02: * Copyright (c) 2003-2007, David A. Czarnecki
03: * All rights reserved.
04: *
05: * Redistribution and use in source and binary forms, with or without
06: * modification, are permitted provided that the following conditions are met:
07: *
08: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
09: * following disclaimer.
10: * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
11: * following disclaimer in the documentation and/or other materials provided with the distribution.
12: * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
13: * endorse or promote products derived from this software without specific prior written permission.
14: * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
15: * without prior written permission of David A. Czarnecki.
16: *
17: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
19: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21: * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26: * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30: */package org.blojsom.dispatcher;
31:
32: import org.blojsom.blog.Blog;
33:
34: import javax.servlet.ServletException;
35: import javax.servlet.http.HttpServletRequest;
36: import javax.servlet.http.HttpServletResponse;
37: import java.io.IOException;
38: import java.util.Map;
39:
40: /**
41: * Dispatcher
42: *
43: * @author David Czarnecki
44: * @since blojsom 3.0
45: * @version $Id: Dispatcher.java,v 1.2 2007/01/17 02:35:16 czarneckid Exp $
46: */
47: public interface Dispatcher {
48:
49: /**
50: * Initialization method for blojsom dispatchers
51: *
52: * @throws org.blojsom.BlojsomException If there is an error initializing the dispatcher
53: */
54: public void init() throws org.blojsom.BlojsomException;
55:
56: /**
57: * Dispatch a request and response. A context map is provided for the BlojsomServlet to pass
58: * any required information for use by the dispatcher. The dispatcher is also
59: * provided with the template for the requested flavor along with the content type for the
60: * specific flavor.
61: *
62: * @param httpServletRequest Request
63: * @param httpServletResponse Response
64: * @param blog {@link Blog}
65: * @param context Context map
66: * @param flavorTemplate Template to dispatch to for the requested flavor
67: * @param flavorContentType Content type for the requested flavor
68: * @throws IOException If there is an exception during IO
69: * @throws ServletException If there is an exception in dispatching the request
70: */
71: public void dispatch(HttpServletRequest httpServletRequest,
72: HttpServletResponse httpServletResponse, Blog blog,
73: Map context, String flavorTemplate, String flavorContentType)
74: throws IOException, ServletException;
75: }
|