Package org.apache.ofbiz.webapp.control
Class RequestHandler
java.lang.Object
org.apache.ofbiz.webapp.control.RequestHandler
RequestHandler - Request Processor Object
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.getDefaultErrorPage
(HttpServletRequest request) Returns the default error page for this request.Returns the EventFactory Object.static String
getOverrideViewUri
(String path) static RequestHandler
getRequestHandler
(ServletContext servletContext) static String
getRequestUri
(String path) getStatusCode
(HttpServletRequest request) Returns the default status-code for this request.Returns the ViewFactory Object.makeLink
(HttpServletRequest request, HttpServletResponse response, String url) makeLink
(HttpServletRequest request, HttpServletResponse response, String url, boolean fullPath, boolean secure, boolean encode) makeLink
(HttpServletRequest request, HttpServletResponse response, String url, boolean fullPath, boolean secure, boolean encode, String targetControlPath) makeLinkWithQueryString
(HttpServletRequest request, HttpServletResponse response, String url, ConfigXMLReader.RequestResponse requestResponse) 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
Run all the "after-login" Web events defined in the controller configuration.void
Run all the "before-logout" Web events defined in the controller configuration.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.
-
Method Details
-
getRequestHandler
-
getRequestUri
-
getOverrideViewUri
-
makeUrl
-
makeUrl
public static String makeUrl(HttpServletRequest request, HttpServletResponse response, String url, boolean fullPath, boolean secure, boolean encode) -
from
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
- whenrequest
or the servlet context isnull
.
-
getControllerConfig
-
doRequest
public void doRequest(HttpServletRequest request, HttpServletResponse response, String chain, GenericValue userLogin, Delegator delegator) 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
Returns the default error page for this request.- Throws:
MalformedURLException
-
getStatusCode
Returns the default status-code for this request. -
getViewFactory
Returns the ViewFactory Object. -
getEventFactory
Returns the EventFactory Object. -
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 requestrequestResponse
- the RequestResponse Object- Returns:
- return the query string
-
makeLinkWithQueryString
public String makeLinkWithQueryString(HttpServletRequest request, HttpServletResponse response, String url, ConfigXMLReader.RequestResponse requestResponse) -
makeLink
-
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) -
runAfterLoginEvents
Run all the "after-login" Web events defined in the controller configuration.- Parameters:
req
- the request to run the events withresp
- the response to run the events with
-
runBeforeLogoutEvents
Run all the "before-logout" Web events defined in the controller configuration.- Parameters:
req
- the request to run the events withresp
- the response to run the events with
-
trackStats
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
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.
-