org.apache.ofbiz.webapp.control

Class RequestHandler

java.lang.Object

org.apache.ofbiz.webapp.control.RequestHandler

public class RequestHandler
extends Object

RequestHandler - Request Processor Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	module

Method Summary

Modifier and Type	Method and Description
void	doRequest(HttpServletRequest request, HttpServletResponse response, String chain, GenericValue userLogin, Delegator delegator)
static RequestHandler	from(HttpServletRequest request) Retrieves the request handler which is stored inside an HTTP request.
ConfigXMLReader.ControllerConfig	getControllerConfig()
String	getDefaultErrorPage(HttpServletRequest request) Returns the default error page for this request.
EventFactory	getEventFactory() Returns the EventFactory Object.
static String	getOverrideViewUri(String path)
static RequestHandler	getRequestHandler(ServletContext servletContext)
static String	getRequestUri(String path)
String	getStatusCode(HttpServletRequest request) Returns the default status-code for this request.
ViewFactory	getViewFactory() Returns the ViewFactory Object.
String	makeLink(HttpServletRequest request, HttpServletResponse response, String url)
String	makeLink(HttpServletRequest request, HttpServletResponse response, String url, boolean fullPath, boolean secure, boolean encode)
String	makeLink(HttpServletRequest request, HttpServletResponse response, String url, boolean fullPath, boolean secure, boolean encode, String targetControlPath)
String	makeLinkWithQueryString(HttpServletRequest request, HttpServletResponse response, String url, ConfigXMLReader.RequestResponse requestResponse)
String	makeQueryString(HttpServletRequest request, ConfigXMLReader.RequestResponse requestResponse) Creates a query string based on the redirect parameters for a request response, if specified, or for all request parameters if no redirect parameters are specified.
static String	makeUrl(HttpServletRequest request, HttpServletResponse response, String url)
static String	makeUrl(HttpServletRequest request, HttpServletResponse response, String url, boolean fullPath, boolean secure, boolean encode)
void	runAfterLoginEvents(HttpServletRequest req, HttpServletResponse resp) Run all the "after-login" Web events defined in the controller configuration.
void	runBeforeLogoutEvents(HttpServletRequest req, HttpServletResponse resp) Run all the "before-logout" Web events defined in the controller configuration.
String	runEvent(HttpServletRequest request, HttpServletResponse response, ConfigXMLReader.Event event, ConfigXMLReader.RequestMap requestMap, String trigger) Find the event handler and invoke an event.
boolean	trackStats(HttpServletRequest request) Checks if server hits must be tracked for a given request.
boolean	trackVisit(HttpServletRequest request) Checks if visits must be tracked for a given request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

module

public static final String module

Method Detail

getRequestHandler

public static RequestHandler getRequestHandler(ServletContext servletContext)

getControllerConfig

public ConfigXMLReader.ControllerConfig getControllerConfig()

doRequest

public void doRequest(HttpServletRequest request,
                      HttpServletResponse response,
                      String chain,
                      GenericValue userLogin,
                      Delegator delegator)
               throws RequestHandlerException,
                      RequestHandlerExceptionAllowExternalRequests

Throws:

RequestHandlerException

RequestHandlerExceptionAllowExternalRequests

runEvent

public String runEvent(HttpServletRequest request,
                       HttpServletResponse response,
                       ConfigXMLReader.Event event,
                       ConfigXMLReader.RequestMap requestMap,
                       String trigger)
                throws EventHandlerException

Find the event handler and invoke an event.

Throws:

EventHandlerException

getDefaultErrorPage

public String getDefaultErrorPage(HttpServletRequest request)

Returns the default error page for this request.

getStatusCode

public String getStatusCode(HttpServletRequest request)

Returns the default status-code for this request.

getViewFactory

public ViewFactory getViewFactory()

Returns the ViewFactory Object.

getEventFactory

public EventFactory getEventFactory()

Returns the EventFactory Object.

getRequestUri

public static String getRequestUri(String path)

getOverrideViewUri

public static String getOverrideViewUri(String path)

makeQueryString

public String makeQueryString(HttpServletRequest request,
                              ConfigXMLReader.RequestResponse requestResponse)

Creates a query string based on the redirect parameters for a request response, if specified, or for all request parameters if no redirect parameters are specified.

Parameters:

request - the Http request

requestResponse - the RequestResponse Object

Returns:

return the query string

makeLinkWithQueryString

public String makeLinkWithQueryString(HttpServletRequest request,
                                      HttpServletResponse response,
                                      String url,
                                      ConfigXMLReader.RequestResponse requestResponse)

makeLink

public String makeLink(HttpServletRequest request,
                       HttpServletResponse response,
                       String url)

makeLink

public String makeLink(HttpServletRequest request,
                       HttpServletResponse response,
                       String url,
                       boolean fullPath,
                       boolean secure,
                       boolean encode)

makeLink

public String makeLink(HttpServletRequest request,
                       HttpServletResponse response,
                       String url,
                       boolean fullPath,
                       boolean secure,
                       boolean encode,
                       String targetControlPath)

makeUrl

public static String makeUrl(HttpServletRequest request,
                             HttpServletResponse response,
                             String url)

makeUrl

public static String makeUrl(HttpServletRequest request,
                             HttpServletResponse response,
                             String url,
                             boolean fullPath,
                             boolean secure,
                             boolean encode)

runAfterLoginEvents

public void runAfterLoginEvents(HttpServletRequest req,
                                HttpServletResponse resp)

Run all the "after-login" Web events defined in the controller configuration.

Parameters:

req - the request to run the events with

resp - the response to run the events with

runBeforeLogoutEvents

public void runBeforeLogoutEvents(HttpServletRequest req,
                                  HttpServletResponse resp)

Run all the "before-logout" Web events defined in the controller configuration.

Parameters:

req - the request to run the events with

resp - the response to run the events with

trackStats

public boolean trackStats(HttpServletRequest request)

Checks if server hits must be tracked for a given request.

Parameters:

request - the HTTP request that can potentially be tracked

Returns:

true when the request must be tracked.

trackVisit

public boolean trackVisit(HttpServletRequest request)

Checks if visits must be tracked for a given request.

Parameters:

request - the HTTP request that can potentially be tracked

Returns:

true when the request must be tracked.

from

public static RequestHandler from(HttpServletRequest request)

Retrieves the request handler which is stored inside an HTTP request.

Parameters:

request - the HTTP request containing the request handler

Returns:

a request handler or null when absent

Throws:

NullPointerException - when request or the servlet context is null.