com.cleo.lexicom.external

Interface IHttpRequestFilter

public interface IHttpRequestFilter

Pre-process or post-process HTTP requests. Refer to IListenerController.setHttpRequestFilter(IHttpRequestFilter).

Method Summary

Modifier and Type	Method and Description
void	postProcessRequest(java.lang.String[] source, java.lang.String[] mailbox, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.io.File file) Allows HTTP server requests to be post-processed after being processed by VLTrader.
java.lang.String	postProcessRequest(java.lang.String[] source, java.lang.String[] mailbox, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String responseContent) Allows HTTP server requests to be post-processed after being processed by VLTrader.
boolean	preProcessRequest(java.lang.String[] source, java.lang.String[] mailbox, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Allows HTTP server requests to be pre-processed before the request is processed by VLTrader.

Method Detail

preProcessRequest

boolean preProcessRequest(java.lang.String[] source,
                          java.lang.String[] mailbox,
                          javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception

Allows HTTP server requests to be pre-processed before the request is processed by VLTrader. Headers can be added to the response, and/or response.sendError() or response.setStatus() can be invoked to respond with a modified HTTP status code.

Parameters:

source - alias path of the action or local listener that is receiving

mailbox - alias path of the mailbox corresponding to the incoming request

request - the HTTP request

response - the HTTP response

Returns:

true if pre-processing was successful and processing should continue; false if VLTrader should not continue processing

Throws:

java.lang.Exception

postProcessRequest

void postProcessRequest(java.lang.String[] source,
                        java.lang.String[] mailbox,
                        javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        java.io.File file)
                 throws java.lang.Exception

Allows HTTP server requests to be post-processed after being processed by VLTrader. Headers can be modified in the response, and/or response.sendError() or response.setStatus() can be invoked to respond with a modified HTTP status code.

Parameters:

source - alias path of the HTTP local listener service

mailbox - alias path of the local user mailbox corresponding to the incoming request

request - the HTTP request

response - the HTTP response

file - the file to be returned in the response by VLTrader

Throws:

java.lang.Exception

postProcessRequest

java.lang.String postProcessRequest(java.lang.String[] source,
                                    java.lang.String[] mailbox,
                                    javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    java.lang.String responseContent)
                             throws java.lang.Exception

Allows HTTP server requests to be post-processed after being processed by VLTrader. Headers can be modified in the response, the response content can be altered, and/or response.sendError() or response.setStatus() can be invoked to respond with a modified HTTP status code.

Parameters:

source - alias path of the HTTP local listener service

mailbox - alias path of the local user mailbox corresponding to the incoming request

request - the HTTP request

response - the HTTP response

responseContent - the text to be returned in the response by VLTrader

Returns:

the same responseContent or null if the responseContent should not change; otherwise the modified responseContent

Throws:

java.lang.Exception