WebFacadeImpl (Moqui Framework 3.0.0)

org.moqui.impl.context.WebFacadeImpl

All Implemented Interfaces and Traits:

WebFacade
```
@groovy.transform.CompileStatic
class WebFacadeImpl
extends java.lang.Object
implements WebFacade
```
This class is a facade to easily get information from and about the web context.

Field Summary

Fields
Modifiers	Name	Description
`protected java.util.Map<java.lang.String, java.lang.Object>`	`applicationAttributes`
`protected java.util.Map<java.lang.String, java.lang.Object>`	`declaredPathParameters`
`protected ExecutionContextImpl`	`eci`
`protected java.util.Map<java.lang.String, java.lang.Object>`	`errorParameters`
`protected java.util.Map<java.lang.String, java.lang.Object>`	`jsonParameters`
`protected static org.slf4j.Logger`	`logger`
`protected java.util.Map<java.lang.String, java.lang.Object>`	`multiPartParameters`
`protected ContextStack`	`parameters`
`protected javax.servlet.http.HttpServletRequest`	`request`
`protected java.util.Map<java.lang.String, java.lang.Object>`	`requestAttributes`
`protected java.lang.String`	`requestBodyText`
`protected java.util.Map<java.lang.String, java.lang.Object>`	`requestParameters`
`protected javax.servlet.http.HttpServletResponse`	`response`
`protected java.util.List<java.lang.String>`	`savedErrors`
`protected java.util.List<MessageInfo>`	`savedMessages`
`protected java.util.Map<java.lang.String, java.lang.Object>`	`savedParameters`
`protected java.util.List<MessageInfo>`	`savedPublicMessages`
`protected java.util.List<ValidationError>`	`savedValidationErrors`
`protected java.util.Map<java.lang.String, java.lang.Object>`	`sessionAttributes`
`protected java.lang.String`	`webappMoquiName`

Properties Summary

Properties
Type	Name and description
`static java.util.Map<java.lang.Integer, java.lang.String>`	`errorCodeNames`
`static SimpleSigner`	`qzSigner`
`static byte[]`	`trackingPng`

Constructor Summary

Constructors
Constructor and description
`WebFacadeImpl (java.lang.String webappMoquiName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ExecutionContextImpl eci)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addDeclaredPathParameter(java.lang.String name, java.lang.String value)`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getApplicationAttributes()`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getErrorParameters()`
	`java.util.List<ValidationError>`	`getFieldValidationErrors(java.lang.String fieldName)`
	`java.lang.String`	`getHostName(boolean withPort)`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getParameters()`
	`java.lang.String`	`getPathInfo()`
	`static java.lang.String`	`getPathInfo(javax.servlet.http.HttpServletRequest request)`
	`java.util.ArrayList<java.lang.String>`	`getPathInfoList()`
	`static java.util.ArrayList<java.lang.String>`	`getPathInfoList(javax.servlet.http.HttpServletRequest request)`
	`java.lang.String`	`getRemoveScreenLastPath()`
	`javax.servlet.http.HttpServletRequest`	`getRequest()`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getRequestAttributes()`
	`java.lang.String`	`getRequestBodyText()`
	`java.lang.String`	`getRequestDetails()`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getRequestParameters()`
	`java.lang.String`	`getRequestUrl()`
	`java.lang.String`	`getResourceDistinctValue()`
	`javax.servlet.http.HttpServletResponse`	`getResponse()`
	`java.util.List<java.lang.String>`	`getSavedErrors()`
	`java.util.List<MessageInfo>`	`getSavedMessages()`
	`java.util.Map`	`getSavedParameters()`
	`java.util.List<MessageInfo>`	`getSavedPublicMessages()`
	`java.util.List<ValidationError>`	`getSavedValidationErrors()`
	`java.util.List<java.util.Map>`	`getScreenHistory()`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getSecureRequestParameters()`
	`javax.servlet.ServletContext`	`getServletContext()`
	`javax.servlet.http.HttpSession`	`getSession()`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getSessionAttributes()`
	`java.lang.String`	`getSessionToken()`
	`java.lang.String`	`getWebappMoquiName()`
	`java.lang.String`	`getWebappRootUrl(boolean requireFullUrl, java.lang.Boolean useEncryption)`
	`static java.lang.String`	`getWebappRootUrl(java.lang.String webappName, java.lang.String servletContextPath, boolean requireFullUrl, java.lang.Boolean useEncryption, ExecutionContextImpl eci)`
	`void`	`handleEntityRestCall(java.util.List<java.lang.String> extraPathNameList, boolean masterNameInPath)`
	`void`	`handleJsonRpcServiceCall()`
	`void`	`handleServiceRestCall(java.util.List<java.lang.String> extraPathNameList)`
	`void`	`handleSystemMessage(java.util.List<java.lang.String> extraPathNameList)`
	`protected org.apache.commons.fileupload.disk.DiskFileItemFactory`	`makeDiskFileItemFactory()`
	`javax.servlet.http.HttpSession`	`makeNewSession()` Invalidate the current session (if there is one) and create a new session for the request, copies attributes.
	`static java.lang.String`	`makeWebappHost(java.lang.String webappName, ExecutionContextImpl eci, WebFacade webFacade, boolean requireEncryption)`
	`static java.lang.String`	`makeWebappRootUrl(java.lang.String webappName, java.lang.String servletContextPath, ExecutionContextImpl eci, WebFacade webFacade, boolean requireEncryption, boolean needFullUrl)`
	`void`	`removeScreenLastParameters(boolean moveToSaved)`
	`void`	`runAfterLoginActions()`
	`void`	`runAfterRequestActions()`
	`void`	`runBeforeLogoutActions()`
	`void`	`runBeforeRequestActions()`
	`void`	`runFirstHitInVisitActions()`
	`void`	`saveErrorParametersToSession()` Save request parameters and attributes to a Map in the moqui.error.parameters session attribute
	`void`	`saveMessagesToSession()`
	`void`	`saveParametersToSession(java.util.Map parameters)` Save passed parameters Map to a Map in the moqui.saved.parameters session attribute
	`void`	`saveRequestParametersToSession()` Save request parameters and attributes to a Map in the moqui.saved.parameters session attribute
	`void`	`saveScreenHistory(UrlInstance urlInstanceOrig)`
	`void`	`saveScreenLastInfo(java.lang.String screenPath, java.util.Map parameters)`
	`void`	`sendError(int errorCode, java.lang.String message, java.lang.Throwable origThrowable)`
	`static void`	`sendError(int errorCode, java.lang.String message, java.lang.Throwable origThrowable, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
	`void`	`sendJsonError(int statusCode, java.lang.String message, java.lang.Throwable origThrowable)`
	`static void`	`sendJsonErrorInternal(int statusCode, java.lang.String message, java.lang.Throwable origThrowable, javax.servlet.http.HttpServletResponse response)`
	`void`	`sendJsonResponse(java.lang.Object responseObj)`
	`static void`	`sendJsonResponseInternal(java.lang.Object responseObj, ExecutionContextImpl eci, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String, java.lang.Object> requestAttributes)`
	`void`	`sendQzSignedResponse(java.lang.String message)`
	`void`	`sendResourceResponse(java.lang.String location)`
	`void`	`sendResourceResponse(java.lang.String location, boolean inline)`
	`static void`	`sendResourceResponseInternal(java.lang.String location, boolean inline, ExecutionContextImpl eci, javax.servlet.http.HttpServletResponse response)`
	`void`	`sendTextResponse(java.lang.String text)`
	`void`	`sendTextResponse(java.lang.String text, java.lang.String contentType, java.lang.String filename)`
	`static void`	`sendTextResponseInternal(java.lang.String text, java.lang.String contentType, java.lang.String filename, ExecutionContextImpl eci, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String, java.lang.Object> requestAttributes)`
	`void`	`viewEmailMessage()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected java.util.Map<java.lang.String, java.lang.Object> applicationAttributes
  - protected java.util.Map<java.lang.String, java.lang.Object> declaredPathParameters
  - protected ExecutionContextImpl eci
  - protected java.util.Map<java.lang.String, java.lang.Object> errorParameters
  - protected java.util.Map<java.lang.String, java.lang.Object> jsonParameters
  - protected static final org.slf4j.Logger logger
  - protected java.util.Map<java.lang.String, java.lang.Object> multiPartParameters
  - protected ContextStack parameters
  - protected javax.servlet.http.HttpServletRequest request
  - protected java.util.Map<java.lang.String, java.lang.Object> requestAttributes
  - protected java.lang.String requestBodyText
  - protected java.util.Map<java.lang.String, java.lang.Object> requestParameters
  - protected javax.servlet.http.HttpServletResponse response
  - protected java.util.List<java.lang.String> savedErrors
  - protected java.util.List<MessageInfo> savedMessages
  - protected java.util.Map<java.lang.String, java.lang.Object> savedParameters
  - protected java.util.List<MessageInfo> savedPublicMessages
  - protected java.util.List<ValidationError> savedValidationErrors
  - protected java.util.Map<java.lang.String, java.lang.Object> sessionAttributes
  - protected java.lang.String webappMoquiName
- Property Detail
  - static java.util.Map<java.lang.Integer, java.lang.String> errorCodeNames
  - static SimpleSigner qzSigner
  - static final byte[] trackingPng
- Constructor Detail
  - WebFacadeImpl(java.lang.String webappMoquiName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ExecutionContextImpl eci)
- Method Detail
  - void addDeclaredPathParameter(java.lang.String name, java.lang.String value)
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getApplicationAttributes()
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getErrorParameters()
  - @java.lang.Override java.util.List<ValidationError> getFieldValidationErrors(java.lang.String fieldName)
  - @java.lang.Override java.lang.String getHostName(boolean withPort)
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getParameters()
  - @java.lang.Override java.lang.String getPathInfo()
  - static java.lang.String getPathInfo(javax.servlet.http.HttpServletRequest request)
  - @java.lang.Override java.util.ArrayList<java.lang.String> getPathInfoList()
  - static java.util.ArrayList<java.lang.String> getPathInfoList(javax.servlet.http.HttpServletRequest request)
  - java.lang.String getRemoveScreenLastPath()
  - @java.lang.Override javax.servlet.http.HttpServletRequest getRequest()
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getRequestAttributes()
  - @java.lang.Override java.lang.String getRequestBodyText()
  - java.lang.String getRequestDetails()
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getRequestParameters()
  - @java.lang.Override java.lang.String getRequestUrl()
  - @java.lang.Override java.lang.String getResourceDistinctValue()
  - @java.lang.Override javax.servlet.http.HttpServletResponse getResponse()
  - @java.lang.Override java.util.List<java.lang.String> getSavedErrors()
  - @java.lang.Override java.util.List<MessageInfo> getSavedMessages()
  - java.util.Map getSavedParameters()
  - @java.lang.Override java.util.List<MessageInfo> getSavedPublicMessages()
  - @java.lang.Override java.util.List<ValidationError> getSavedValidationErrors()
  - @java.lang.Override java.util.List<java.util.Map> getScreenHistory()
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getSecureRequestParameters()
  - @java.lang.Override javax.servlet.ServletContext getServletContext()
  - @java.lang.Override javax.servlet.http.HttpSession getSession()
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getSessionAttributes()
  - @java.lang.Override java.lang.String getSessionToken()
  - java.lang.String getWebappMoquiName()
  - @java.lang.Override java.lang.String getWebappRootUrl(boolean requireFullUrl, java.lang.Boolean useEncryption)
  - static java.lang.String getWebappRootUrl(java.lang.String webappName, java.lang.String servletContextPath, boolean requireFullUrl, java.lang.Boolean useEncryption, ExecutionContextImpl eci)
  - @java.lang.Override void handleEntityRestCall(java.util.List<java.lang.String> extraPathNameList, boolean masterNameInPath)
  - @java.lang.Override void handleJsonRpcServiceCall()
  - @java.lang.Override void handleServiceRestCall(java.util.List<java.lang.String> extraPathNameList)
  - void handleSystemMessage(java.util.List<java.lang.String> extraPathNameList)
  - protected org.apache.commons.fileupload.disk.DiskFileItemFactory makeDiskFileItemFactory()
  - javax.servlet.http.HttpSession makeNewSession()
    
    Invalidate the current session (if there is one) and create a new session for the request, copies attributes. NOTE that this must be called before any response is sent and more generally before screen rendering begins.
  - static java.lang.String makeWebappHost(java.lang.String webappName, ExecutionContextImpl eci, WebFacade webFacade, boolean requireEncryption)
  - static java.lang.String makeWebappRootUrl(java.lang.String webappName, java.lang.String servletContextPath, ExecutionContextImpl eci, WebFacade webFacade, boolean requireEncryption, boolean needFullUrl)
  - void removeScreenLastParameters(boolean moveToSaved)
  - void runAfterLoginActions()
  - void runAfterRequestActions()
  - void runBeforeLogoutActions()
  - void runBeforeRequestActions()
  - void runFirstHitInVisitActions()
  - void saveErrorParametersToSession()
    
    Save request parameters and attributes to a Map in the moqui.error.parameters session attribute
  - void saveMessagesToSession()
  - void saveParametersToSession(java.util.Map parameters)
    
    Save passed parameters Map to a Map in the moqui.saved.parameters session attribute
  - void saveRequestParametersToSession()
    
    Save request parameters and attributes to a Map in the moqui.saved.parameters session attribute
  - void saveScreenHistory(UrlInstance urlInstanceOrig)
  - void saveScreenLastInfo(java.lang.String screenPath, java.util.Map parameters)
  - @java.lang.Override void sendError(int errorCode, java.lang.String message, java.lang.Throwable origThrowable)
  - static void sendError(int errorCode, java.lang.String message, java.lang.Throwable origThrowable, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
  - @java.lang.Override void sendJsonError(int statusCode, java.lang.String message, java.lang.Throwable origThrowable)
  - static void sendJsonErrorInternal(int statusCode, java.lang.String message, java.lang.Throwable origThrowable, javax.servlet.http.HttpServletResponse response)
  - @java.lang.Override void sendJsonResponse(java.lang.Object responseObj)
  - static void sendJsonResponseInternal(java.lang.Object responseObj, ExecutionContextImpl eci, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String, java.lang.Object> requestAttributes)
  - void sendQzSignedResponse(java.lang.String message)
  - @java.lang.Override void sendResourceResponse(java.lang.String location)
  - @java.lang.Override void sendResourceResponse(java.lang.String location, boolean inline)
  - static void sendResourceResponseInternal(java.lang.String location, boolean inline, ExecutionContextImpl eci, javax.servlet.http.HttpServletResponse response)
  - @java.lang.Override void sendTextResponse(java.lang.String text)
  - @java.lang.Override void sendTextResponse(java.lang.String text, java.lang.String contentType, java.lang.String filename)
  - static void sendTextResponseInternal(java.lang.String text, java.lang.String contentType, java.lang.String filename, ExecutionContextImpl eci, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String, java.lang.Object> requestAttributes)
  - void viewEmailMessage()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class WebFacadeImpl

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.util.Map<java.lang.String, java.lang.Object> applicationAttributes

protected java.util.Map<java.lang.String, java.lang.Object> declaredPathParameters

protected ExecutionContextImpl eci

protected java.util.Map<java.lang.String, java.lang.Object> errorParameters

protected java.util.Map<java.lang.String, java.lang.Object> jsonParameters

protected static final org.slf4j.Logger logger

protected java.util.Map<java.lang.String, java.lang.Object> multiPartParameters

protected ContextStack parameters

protected javax.servlet.http.HttpServletRequest request

protected java.util.Map<java.lang.String, java.lang.Object> requestAttributes

protected java.lang.String requestBodyText

protected java.util.Map<java.lang.String, java.lang.Object> requestParameters

protected javax.servlet.http.HttpServletResponse response

protected java.util.List<java.lang.String> savedErrors

protected java.util.List<MessageInfo> savedMessages

protected java.util.Map<java.lang.String, java.lang.Object> savedParameters

protected java.util.List<MessageInfo> savedPublicMessages

protected java.util.List<ValidationError> savedValidationErrors

protected java.util.Map<java.lang.String, java.lang.Object> sessionAttributes

protected java.lang.String webappMoquiName

Property Detail

static java.util.Map<java.lang.Integer, java.lang.String> errorCodeNames

static SimpleSigner qzSigner

static final byte[] trackingPng

Constructor Detail

WebFacadeImpl(java.lang.String webappMoquiName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ExecutionContextImpl eci)

Method Detail

void addDeclaredPathParameter(java.lang.String name, java.lang.String value)

@java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getApplicationAttributes()

@java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getErrorParameters()

@java.lang.Override java.util.List<ValidationError> getFieldValidationErrors(java.lang.String fieldName)

@java.lang.Override java.lang.String getHostName(boolean withPort)

@java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getParameters()

@java.lang.Override java.lang.String getPathInfo()

static java.lang.String getPathInfo(javax.servlet.http.HttpServletRequest request)

@java.lang.Override java.util.ArrayList<java.lang.String> getPathInfoList()

static java.util.ArrayList<java.lang.String> getPathInfoList(javax.servlet.http.HttpServletRequest request)

java.lang.String getRemoveScreenLastPath()

@java.lang.Override javax.servlet.http.HttpServletRequest getRequest()

@java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getRequestAttributes()

@java.lang.Override java.lang.String getRequestBodyText()

java.lang.String getRequestDetails()

@java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getRequestParameters()

@java.lang.Override java.lang.String getRequestUrl()

@java.lang.Override java.lang.String getResourceDistinctValue()

@java.lang.Override javax.servlet.http.HttpServletResponse getResponse()

@java.lang.Override java.util.List<java.lang.String> getSavedErrors()

@java.lang.Override java.util.List<MessageInfo> getSavedMessages()

java.util.Map getSavedParameters()

@java.lang.Override java.util.List<MessageInfo> getSavedPublicMessages()

@java.lang.Override java.util.List<ValidationError> getSavedValidationErrors()

@java.lang.Override java.util.List<java.util.Map> getScreenHistory()

@java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getSecureRequestParameters()

@java.lang.Override javax.servlet.ServletContext getServletContext()

@java.lang.Override javax.servlet.http.HttpSession getSession()

@java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getSessionAttributes()

@java.lang.Override java.lang.String getSessionToken()

java.lang.String getWebappMoquiName()

@java.lang.Override java.lang.String getWebappRootUrl(boolean requireFullUrl, java.lang.Boolean useEncryption)

static java.lang.String getWebappRootUrl(java.lang.String webappName, java.lang.String servletContextPath, boolean requireFullUrl, java.lang.Boolean useEncryption, ExecutionContextImpl eci)

@java.lang.Override void handleEntityRestCall(java.util.List<java.lang.String> extraPathNameList, boolean masterNameInPath)

@java.lang.Override void handleJsonRpcServiceCall()

@java.lang.Override void handleServiceRestCall(java.util.List<java.lang.String> extraPathNameList)

void handleSystemMessage(java.util.List<java.lang.String> extraPathNameList)

protected org.apache.commons.fileupload.disk.DiskFileItemFactory makeDiskFileItemFactory()

javax.servlet.http.HttpSession makeNewSession()

static java.lang.String makeWebappHost(java.lang.String webappName, ExecutionContextImpl eci, WebFacade webFacade, boolean requireEncryption)

static java.lang.String makeWebappRootUrl(java.lang.String webappName, java.lang.String servletContextPath, ExecutionContextImpl eci, WebFacade webFacade, boolean requireEncryption, boolean needFullUrl)

void removeScreenLastParameters(boolean moveToSaved)

void runAfterLoginActions()

void runAfterRequestActions()

void runBeforeLogoutActions()

void runBeforeRequestActions()