01: /*
02: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Kernel/Sources/es/udc/mypersonalizer/kernel/controller/requestprocessor/PreProcessingFilter.java,v 1.1.1.1 2004/03/25 12:08:38 fbellas Exp $
03: * $Revision: 1.1.1.1 $
04: * $Date: 2004/03/25 12:08:38 $
05: *
06: * =============================================================================
07: *
08: * Copyright (c) 2003, The MyPersonalizer Development Group
09: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
10: * University Of A Coruna
11: * All rights reserved.
12: *
13: * Redistribution and use in source and binary forms, with or without
14: * modification, are permitted provided that the following conditions are met:
15: *
16: * - Redistributions of source code must retain the above copyright notice,
17: * this list of conditions and the following disclaimer.
18: *
19: * - Redistributions in binary form must reproduce the above copyright notice,
20: * this list of conditions and the following disclaimer in the documentation
21: * and/or other materials provided with the distribution.
22: *
23: * - Neither the name of the University Of A Coruna nor the names of its
24: * contributors may be used to endorse or promote products derived from
25: * this software without specific prior written permission.
26: *
27: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37: * POSSIBILITY OF SUCH DAMAGE.
38: *
39: */
40:
41: package es.udc.mypersonalizer.kernel.controller.requestprocessor;
42:
43: import es.udc.mypersonalizer.kernel.util.exceptions.InternalErrorException;
44: import java.util.Map;
45: import javax.servlet.http.HttpServletRequest;
46: import javax.servlet.http.HttpServletResponse;
47: import org.apache.struts.action.Action;
48: import org.apache.struts.action.ActionForm;
49: import org.apache.struts.action.ActionForward;
50: import org.apache.struts.action.ActionMapping;
51:
52: /**
53: * This interface represents a pre-processing filter that may be applied
54: * to an action request previously to its execution by
55: * MyPersonalizerRequestProcessor.
56: *
57: * @author Daniel Fernandez
58: * @since 1.0
59: */
60: public interface PreProcessingFilter {
61:
62: /**
63: * Establishes the next filter in the chain
64: *
65: * @param filter the next PreProcessingFilter to be executed after this one
66: */
67: public void setNextFilter(PreProcessingFilter filter);
68:
69: /**
70: * Sets this filter's configuration parameters
71: *
72: * @param configurationParameters a Map with the filter's configuration
73: * parameters
74: * @since 1.0
75: */
76: public void setConfigurationParameters(Map configurationParameters);
77:
78: /**
79: * Applies the filter by processing the request the way it may need
80: *
81: * @param request the HttpServletRequest to be processed
82: * @param response the HttpServletResponse associated
83: * @param action the Struts' Action
84: * @param form the Struts' ActionForm
85: * @param mapping the Struts' ActionMapping
86: * @return a ActionForward with the result of the filter execution, null
87: * if filter processing did not raise any error.
88: * @throws InternalErrorException if a fatal error ocurrs.
89: */
90: public ActionForward process(HttpServletRequest request,
91: HttpServletResponse response, Action action,
92: ActionForm form, ActionMapping mapping)
93: throws InternalErrorException;
94:
95: }
|