HTMLEscapingWebContextWrapper (Magnolia Core 5.7.3 API)

java.lang.Object
- info.magnolia.context.HTMLEscapingWebContextWrapper

All Implemented Interfaces:

Context, WebContext, Map
```
public class HTMLEscapingWebContextWrapper
extends Object
implements WebContext
```
A wrapper around WebContext which will return an escaped AggregationState.

See Also:

HTMLEscapingAggregationState, getAggregationState()

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from interface info.magnolia.context.WebContext
  ATTRIBUTE_REQUEST_CHARACTER_ENCODING, ATTRIBUTE_REQUEST_URI
- Fields inherited from interface info.magnolia.context.Context
  APPLICATION_SCOPE, ATTRIBUTE_COMMENT, ATTRIBUTE_EXCEPTION, ATTRIBUTE_MESSAGE, ATTRIBUTE_PATH, ATTRIBUTE_RECURSIVE, ATTRIBUTE_REPOSITORY, ATTRIBUTE_REQUESTOR, ATTRIBUTE_USERNAME, ATTRIBUTE_UUID, ATTRIBUTE_VERSION, ATTRIBUTE_VERSION_MAP, LOCAL_SCOPE, SESSION_SCOPE

Constructor Summary

Constructors
Constructor and Description

HTMLEscapingWebContextWrapper(WebContext original)

Constructors
Constructor and Description
`HTMLEscapingWebContextWrapper(WebContext original)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`Object`	`compute(Object key, BiFunction remappingFunction)`
`Object`	`computeIfAbsent(Object key, Function mappingFunction)`
`Object`	`computeIfPresent(Object key, BiFunction remappingFunction)`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry>`	`entrySet()`
`boolean`	`equals(Object o)`
`void`	`forEach(BiConsumer action)`
`Object`	`get(Object key)`
`AccessManager`	`getAccessManager(String name)` Get a an `AccessManager` for logical entities.
`AggregationState`	`getAggregationState()` Retrieves the Aggregator instance, which gathers all info regarding the current request (paths, etc).
`<T> T`	`getAttribute(String name)` Get attribute value without passing a scope.
`<T> T`	`getAttribute(String name, int scope)` Get attribute value.
`Map<String,Object>`	`getAttributes()` Get an over all map.
`Map<String,Object>`	`getAttributes(int scope)` Get a map of a attributes set in the scope.
`String`	`getContextPath()` Get the current context path.
`javax.jcr.Session`	`getJCRSession(String workspaceName)`
`Locale`	`getLocale()` Get the current locale.
`Messages`	`getMessages()` Get the default messages.
`Messages`	`getMessages(String basename)` Get the messages of the named bundle.
`Object`	`getOrDefault(Object key, Object defaultValue)`
`javax.servlet.jsp.PageContext`	`getPageContext()` Returns the current jsp page context, if any.
`String`	`getParameter(String name)` Get a parameter value as string.
`Map<String,String>`	`getParameters()` Get all parameter values as a Map<String, String>.
`String[]`	`getParameterValues(String name)` Get parameter values as string[].
`MultipartForm`	`getPostedForm()` Get form object assembled by `MultipartRequestFilter`.
`javax.servlet.http.HttpServletRequest`	`getRequest()` Avoid calls to this method wherever possible.
`javax.servlet.http.HttpServletResponse`	`getResponse()` Avoid depending on this as much as possible.
`javax.servlet.ServletContext`	`getServletContext()` Returns the current servlet context.
`Subject`	`getSubject()`
`User`	`getUser()` If this is not a UserContext this method will very likely return the system user.
`int`	`hashCode()`
`void`	`include(String path, Writer out)` Includes/render the given path into the given Writer, by wrapping it in the current HttpServletResponse.
`void`	`init(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext servletContext)` Method used to initialize the context.
`boolean`	`isEmpty()`
`Set`	`keySet()`
`Object`	`merge(Object key, Object value, BiFunction remappingFunction)`
`void`	`pop()`
`void`	`push(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`Object`	`put(Object key, Object value)`
`void`	`putAll(Map m)`
`Object`	`putIfAbsent(Object key, Object value)`
`void`	`release()` Release any resource used by this Context (e.g.
`Object`	`remove(Object key)`
`boolean`	`remove(Object key, Object value)`
`void`	`removeAttribute(String name, int scope)` Remove an attribute.
`Object`	`replace(Object key, Object value)`
`boolean`	`replace(Object key, Object oldValue, Object newValue)`
`void`	`replaceAll(BiFunction function)`
`void`	`resetAggregationState()` Resets the current aggregator instance.
`void`	`setAttribute(String name, Object value, int scope)` Set attribute value, scope of the attribute is defined.
`void`	`setLocale(Locale locale)`
`void`	`setPageContext(javax.servlet.jsp.PageContext pageContext)` Sets the current jsp page context.
`int`	`size()`
`WebContext`	`unwrap()`
`Collection`	`values()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HTMLEscapingWebContextWrapper
```
public HTMLEscapingWebContextWrapper(WebContext original)
```
- Method Detail
  - unwrap
```
public WebContext unwrap()
```
    Returns:
    
    the unwrapped/original WebContext
  - init
```
public void init(javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response,
                 javax.servlet.ServletContext servletContext)
```
    Description copied from interface: WebContext
    
    Method used to initialize the context.
    
    Specified by:
    
    init in interface WebContext
  - getAggregationState
```
public AggregationState getAggregationState()
```
    Description copied from interface: WebContext
    
    Retrieves the Aggregator instance, which gathers all info regarding the current request (paths, etc).
    
    Specified by:
    
    getAggregationState in interface WebContext
    
    Returns:
    
    AggregationState wrapped as HTMLEscapingAggregationState.
  - resetAggregationState
```
public void resetAggregationState()
```
    Description copied from interface: WebContext
    
    Resets the current aggregator instance.
    
    Specified by:
    
    resetAggregationState in interface WebContext
  - getPostedForm
```
public MultipartForm getPostedForm()
```
    Description copied from interface: WebContext
    
    Get form object assembled by MultipartRequestFilter.
    
    Specified by:
    
    getPostedForm in interface WebContext
    
    Returns:
    
    multipart form object
  - getParameter
```
public String getParameter(String name)
```
    Description copied from interface: WebContext
    
    Get a parameter value as string.
    
    Specified by:
    
    getParameter in interface WebContext
    
    Returns:
    
    parameter value
  - getParameters
```
public Map<String,String> getParameters()
```
    Description copied from interface: WebContext
    
    Get all parameter values as a Map<String, String>.
    
    Specified by:
    
    getParameters in interface WebContext
    
    Returns:
    
    parameter values
  - getContextPath
```
public String getContextPath()
```
    Description copied from interface: WebContext
    
    Get the current context path.
    
    Specified by:
    
    getContextPath in interface WebContext
  - getRequest
```
public javax.servlet.http.HttpServletRequest getRequest()
```
    Description copied from interface: WebContext
    
    Avoid calls to this method wherever possible.
    
    Specified by:
    
    getRequest in interface WebContext
    
    Returns:
    
    Returns the request.
  - getResponse
```
public javax.servlet.http.HttpServletResponse getResponse()
```
    Description copied from interface: WebContext
    
    Avoid depending on this as much as possible.
    
    Specified by:
    
    getResponse in interface WebContext
  - getUser
```
public User getUser()
```
    Description copied from interface: Context
    
    If this is not a UserContext this method will very likely return the system user.
  - getSubject
```
public Subject getSubject()
```
  - setLocale
```
public void setLocale(Locale locale)
```
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    Description copied from interface: WebContext
    
    Returns the current servlet context.
    
    Specified by:
    
    getServletContext in interface WebContext
    
    Returns:
    
    ServletContext instance
  - getLocale
```
public Locale getLocale()
```
    Description copied from interface: Context
    
    Get the current locale.
  - getJCRSession
```
public javax.jcr.Session getJCRSession(String workspaceName)
                                throws javax.jcr.LoginException,
                                       javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.LoginException
    
    javax.jcr.RepositoryException
  - include
```
public void include(String path,
                    Writer out)
             throws javax.servlet.ServletException,
                    IOException
```
    Description copied from interface: WebContext
    
    Includes/render the given path into the given Writer, by wrapping it in the current HttpServletResponse.
    
    Specified by:
    
    include in interface WebContext
    
    Throws:
    
    javax.servlet.ServletException
    
    IOException
    
    See Also:
    
    ServletRequest.getRequestDispatcher(String), RequestDispatcher.include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
  - getAccessManager
```
public AccessManager getAccessManager(String name)
```
    Description copied from interface: Context
    
    Get a an AccessManager for logical entities. The accesses to the repository are handled by the repository itself.
  - setPageContext
```
public void setPageContext(javax.servlet.jsp.PageContext pageContext)
```
    Description copied from interface: WebContext
    
    Sets the current jsp page context. Callers should take care of appropriately unset it once done with it. Typically a jsp renderer will setPageContext(null) after having rendered a jsp.
    
    Specified by:
    
    setPageContext in interface WebContext
    
    Parameters:
    
    pageContext - jsp page context
  - getPageContext
```
public javax.servlet.jsp.PageContext getPageContext()
```
    Description copied from interface: WebContext
    
    Returns the current jsp page context, if any.
    
    Specified by:
    
    getPageContext in interface WebContext
    
    Returns:
    
    jsp page context or null if it has not been populated by calling setPageContext
  - push
```
public void push(javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response)
```
    Specified by:
    
    push in interface WebContext
  - pop
```
public void pop()
```
    Specified by:
    
    pop in interface WebContext
  - setAttribute
```
public void setAttribute(String name,
                         Object value,
                         int scope)
```
    Description copied from interface: Context
    
    Set attribute value, scope of the attribute is defined.
    
    Parameters:
    
    name - is used as a key
    
    scope - , highest level of scope from which this attribute is visible
  - getParameterValues
```
public String[] getParameterValues(String name)
```
    Description copied from interface: WebContext
    
    Get parameter values as string[].
    
    Specified by:
    
    getParameterValues in interface WebContext
    
    Returns:
    
    parameter values
  - getAttribute
```
public <T> T getAttribute(String name,
                          int scope)
```
    Description copied from interface: Context
    
    Get attribute value.
    
    Parameters:
    
    name - to which value is associated to
    
    scope - the scope (request, session, application)
    
    Returns:
    
    attribute value
  - getAttribute
```
public <T> T getAttribute(String name)
```
    Description copied from interface: Context
    
    Get attribute value without passing a scope. the scopes are searched from bottom up (request, session, application)
    
    Parameters:
    
    name - to which value is associated to
    
    Returns:
    
    attribute value
  - getAttributes
```
public Map<String,Object> getAttributes(int scope)
```
    Description copied from interface: Context
    
    Get a map of a attributes set in the scope.
    
    Returns:
    
    the map
  - removeAttribute
```
public void removeAttribute(String name,
                            int scope)
```
    Description copied from interface: Context
    
    Remove an attribute.
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Description copied from interface: Context
    
    Get an over all map.
    
    Returns:
    
    the map
  - getMessages
```
public Messages getMessages()
```
    Description copied from interface: Context
    
    Get the default messages. It uses the locale set on this context TODO: This duplicates methods from MessagesManager : remove either
  - getMessages
```
public Messages getMessages(String basename)
```
    Description copied from interface: Context
    
    Get the messages of the named bundle. It uses the locale set on this context
    
    Parameters:
    
    basename - name of the bundle TODO: This duplicates methods from MessagesManager : remove either
  - release
```
public void release()
```
    Description copied from interface: Context
    
    Release any resource used by this Context (e.g. jcr sessions).
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map
  - get
```
public Object get(Object key)
```
    Specified by:
    
    get in interface Map
  - put
```
public Object put(Object key,
                  Object value)
```
    Specified by:
    
    put in interface Map
  - remove
```
public Object remove(Object key)
```
    Specified by:
    
    remove in interface Map
  - putAll
```
public void putAll(Map m)
```
    Specified by:
    
    putAll in interface Map
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map
  - keySet
```
public Set keySet()
```
    Specified by:
    
    keySet in interface Map
  - values
```
public Collection values()
```
    Specified by:
    
    values in interface Map
  - entrySet
```
public Set<Map.Entry> entrySet()
```
    Specified by:
    
    entrySet in interface Map
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Map
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map
    
    Overrides:
    
    hashCode in class Object
  - getOrDefault
```
public Object getOrDefault(Object key,
                           Object defaultValue)
```
    Specified by:
    
    getOrDefault in interface Map
  - forEach
```
public void forEach(BiConsumer action)
```
    Specified by:
    
    forEach in interface Map
  - replaceAll
```
public void replaceAll(BiFunction function)
```
    Specified by:
    
    replaceAll in interface Map
  - putIfAbsent
```
public Object putIfAbsent(Object key,
                          Object value)
```
    Specified by:
    
    putIfAbsent in interface Map
  - remove
```
public boolean remove(Object key,
                      Object value)
```
    Specified by:
    
    remove in interface Map
  - replace
```
public boolean replace(Object key,
                       Object oldValue,
                       Object newValue)
```
    Specified by:
    
    replace in interface Map
  - replace
```
public Object replace(Object key,
                      Object value)
```
    Specified by:
    
    replace in interface Map
  - computeIfAbsent
```
public Object computeIfAbsent(Object key,
                              Function mappingFunction)
```
    Specified by:
    
    computeIfAbsent in interface Map
  - computeIfPresent
```
public Object computeIfPresent(Object key,
                               BiFunction remappingFunction)
```
    Specified by:
    
    computeIfPresent in interface Map
  - compute
```
public Object compute(Object key,
                      BiFunction remappingFunction)
```
    Specified by:
    
    compute in interface Map
  - merge
```
public Object merge(Object key,
                    Object value,
                    BiFunction remappingFunction)
```
    Specified by:
    
    merge in interface Map

Class HTMLEscapingWebContextWrapper

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from interface info.magnolia.context.WebContext

Fields inherited from interface info.magnolia.context.Context

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HTMLEscapingWebContextWrapper

Method Detail

unwrap

init

getAggregationState

resetAggregationState

getPostedForm

getParameter

getParameters

getContextPath

getRequest

getResponse

getUser

getSubject

setLocale

getServletContext

getLocale

getJCRSession

include

getAccessManager

setPageContext

getPageContext

push

pop

setAttribute

getParameterValues

getAttribute

getAttribute

getAttributes

removeAttribute

getAttributes

getMessages

getMessages

release

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode

getOrDefault

forEach

replaceAll

putIfAbsent

remove

replace

replace

computeIfAbsent

computeIfPresent

compute

merge