@java.lang.SuppressWarnings("unused") public interface WebFacade
Web Facade for access to HTTP Servlet objects and information.
Type Params | Return Type | Name and description |
---|---|---|
|
public java.util.Map<java.lang.String, java.lang.Object> |
getApplicationAttributes() |
|
public java.util.Map<java.lang.String, java.lang.Object> |
getErrorParameters() |
|
public java.util.List<ValidationError> |
getFieldValidationErrors(java.lang.String fieldName) Get saved (in session) and current MessageFacade validation errors for the given field name, if null returns all errors; if no errors found returns null |
|
public java.lang.String |
getHostName(boolean withPort) |
|
public java.util.Map<java.lang.String, java.lang.Object> |
getParameters() |
|
public java.lang.String |
getPathInfo() Alternative to HttpServletRequest.getPathInfo() that uses URLDecoder to decode path segments to match the use of URLEncoder for URL generation using the 'application/x-www-form-urlencoded' MIME format |
|
public java.util.ArrayList<java.lang.String> |
getPathInfoList() Like getPathInfo() but returns a list of decoded path segment Strings. |
|
public javax.servlet.http.HttpServletRequest |
getRequest() |
|
public java.util.Map<java.lang.String, java.lang.Object> |
getRequestAttributes() |
|
public java.lang.String |
getRequestBodyText() If Content-Type request header is a text type and body length is greater than zero you can get the full body text here |
|
public java.util.Map<java.lang.String, java.lang.Object> |
getRequestParameters() Returns a Map with request parameters including session saved, multi-part body, json body, declared and named path parameters, and standard Servlet request parameters (query string parameters, form body parameters). |
|
public java.lang.String |
getRequestUrl() |
|
public java.lang.String |
getResourceDistinctValue() Returns a String to append to a URL to make it distinct to force browser reload |
|
public javax.servlet.http.HttpServletResponse |
getResponse() |
|
public java.util.List<java.lang.String> |
getSavedErrors() |
|
public java.util.List<MessageInfo> |
getSavedMessages() |
|
public java.util.List<MessageInfo> |
getSavedPublicMessages() |
|
public java.util.List<ValidationError> |
getSavedValidationErrors() |
|
public java.util.List<java.util.Map> |
getScreenHistory() A list of recent screen requests to show to a user (does not include requests to transitions or standalone screens). |
|
public java.util.Map<java.lang.String, java.lang.Object> |
getSecureRequestParameters() Returns a Map with only secure (encrypted if over HTTPS) request parameters including session saved, multi-part body, json body, and form body parameters (standard Servlet request parameters not in query string). |
|
public javax.servlet.ServletContext |
getServletContext() |
|
public javax.servlet.http.HttpSession |
getSession() |
|
public java.util.Map<java.lang.String, java.lang.Object> |
getSessionAttributes() |
|
public java.lang.String |
getSessionToken() Get the token to include in all POST requests with the name moquiSessionToken or the X-CSRF-Token request header (in the session as 'moqui.session.token') |
|
public java.lang.String |
getWebappRootUrl(boolean requireFullUrl, java.lang.Boolean useEncryption) |
|
public void |
handleEntityRestCall(java.util.List<java.lang.String> extraPathNameList, boolean masterNameInPath) |
|
public void |
handleJsonRpcServiceCall() |
|
public void |
handleServiceRestCall(java.util.List<java.lang.String> extraPathNameList) |
|
public void |
handleSystemMessage(java.util.List<java.lang.String> extraPathNameList) |
|
public void |
sendError(int errorCode, java.lang.String message, java.lang.Throwable origThrowable) |
|
public void |
sendJsonError(int statusCode, java.lang.String message, java.lang.Throwable origThrowable) |
|
public void |
sendJsonResponse(java.lang.Object responseObj) |
|
public void |
sendResourceResponse(java.lang.String location) Send content of specified resource location to client via HttpResponse. |
|
public void |
sendResourceResponse(java.lang.String location, boolean inline) Send content of specified resource location to client via HttpResponse. |
|
public void |
sendTextResponse(java.lang.String text) |
|
public void |
sendTextResponse(java.lang.String text, java.lang.String contentType, java.lang.String filename) |
Get saved (in session) and current MessageFacade validation errors for the given field name, if null returns all errors; if no errors found returns null
Alternative to HttpServletRequest.getPathInfo() that uses URLDecoder to decode path segments to match the use of URLEncoder for URL generation using the 'application/x-www-form-urlencoded' MIME format
Like getPathInfo() but returns a list of decoded path segment Strings. If there is no extra path after the servlet path returns an empty list.
If Content-Type request header is a text type and body length is greater than zero you can get the full body text here
Returns a Map with request parameters including session saved, multi-part body, json body, declared and named path parameters, and standard Servlet request parameters (query string parameters, form body parameters).
Returns a String to append to a URL to make it distinct to force browser reload
A list of recent screen requests to show to a user (does not include requests to transitions or standalone screens). Map contains 'name' (screen name plus up to 2 parameter values), 'url' (full URL with parameters), 'screenLocation', 'image' (last menu image in screen render path), and 'imageType' fields.
Returns a Map with only secure (encrypted if over HTTPS) request parameters including session saved, multi-part body, json body, and form body parameters (standard Servlet request parameters not in query string).
Get the token to include in all POST requests with the name moquiSessionToken or the X-CSRF-Token request header (in the session as 'moqui.session.token')
Send content of specified resource location to client via HttpResponse. Always uses attachment Content-Disposition to tell browser to download.
Send content of specified resource location to client via HttpResponse.
location
- Resource locationinline
- If true use inline Content-Disposition to tell browser to display, otherwise use attachment to tell browser to download.