Dispatcher


1   /**
2    * Copyright (c) 2003-2006, David A. Czarnecki
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions are met:
7    *
8    * Redistributions of source code must retain the above copyright notice, this list of conditions and the
9    *     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   */
31  package org.blojsom.dispatcher;
32  
33  import org.blojsom.blog.Blog;
34  
35  import javax.servlet.ServletException  ;
36  import javax.servlet.http.HttpServletRequest  ;
37  import javax.servlet.http.HttpServletResponse  ;
38  import java.io.IOException  ;
39  import java.util.Map  ;
40  
41  /**
42   * Dispatcher
43   *
44   * @author David Czarnecki
45   * @since blojsom 3.0
46   * @version $Id: Dispatcher.java,v 1.1 2006/03/20 21:31:13 czarneckid Exp $
47   */
48  public interface Dispatcher {
49  
50      /**
51       * Initialization method for blojsom dispatchers
52       *
53       * @throws org.blojsom.BlojsomException If there is an error initializing the dispatcher
54       */
55      public void init() throws org.blojsom.BlojsomException;
56  
57      /**
58       * Dispatch a request and response. A context map is provided for the BlojsomServlet to pass
59       * any required information for use by the dispatcher. The dispatcher is also
60       * provided with the template for the requested flavor along with the content type for the
61       * specific flavor.
62       *
63       * @param httpServletRequest  Request
64       * @param httpServletResponse Response
65       * @param blog                {@link Blog}
66       * @param context             Context map
67       * @param flavorTemplate      Template to dispatch to for the requested flavor
68       * @param flavorContentType   Content type for the requested flavor
69       * @throws IOException      If there is an exception during IO
70       * @throws ServletException If there is an exception in dispatching the request
71       */
72      public void dispatch(HttpServletRequest   httpServletRequest, HttpServletResponse   httpServletResponse, Blog blog, Map   context, String   flavorTemplate, String   flavorContentType) throws IOException  , ServletException  ;
73  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags