edu.utexas.its.eis.tools.qwicap.servlet
Interface FormDataSetFilter
public interface FormDataSetFilter
Defines the interface for a class that filters the form data set received by Qwicap before it is processed by
Qwicap, or passed-along to the client application. The filter may directly modify the data set, and may instruct
Qwicap to take various actions. You instruct Qwicap to use a FormDataSetFilter
object by passing that
object to Qwicap.setInputFilter(FormDataSetFilter)
. Note that there can be only one filter at a time.
- Author:
- Chris W. Johnson
filter
void filter(FormDataSet DataSet,
FormDataSetFilterContext FilterContext,
FormDataSetFilterResponse YourResponse)
throws QwicapException
- Invoked whenever Qwicap receives a new form data set (or the data sets present in URLs). The
filter
implemenetation may alter the contents of the DataSet
parameter, and may instruct Qwicap to perform
various actions by invoking methods on the FormDataSetFilterResponse
instance passed as the
YourResponse
parameter. The implementation may even choose to write a complete reply to the client
through the HttpServletResponse
instance passed as the Resp
parameter - in this case,
the implementation should invoke the ignoreDataSet
method on the YourResponse
object.
- Parameters:
DataSet
- The data set received through this request. By altering the contests of this object
you will change the data set that Qwicap delivers to your client application.FilterContext
- Information about the context in which the filter was invoked.YourResponse
- Invoking the public methods of this object allows you to instruct Qwicap to take
various actions after this filter
method has exited.
- Throws:
QwicapException
- If any of the usual Qwicap exceptions occurred during filter execution. In the case of
Qwicap exceptions like abandonment exceptions (see QwicapAbandonmentException
),
proper operation of the web application depends on those propagating in manner
consistent with the behavior of the "prompt pattern", so filter implementations must
not interfere with the propagation of Qwicap exceptions.