HTMLEscapingAggregationState (Magnolia Main Project (Parent) 5.7.1 API)

java.lang.Object
- info.magnolia.cms.core.AggregationState
- - info.magnolia.cms.core.HTMLEscapingAggregationState

```
public class HTMLEscapingAggregationState
extends AggregationState
```
Wrapper around AggregationState created in order to escape all output to rendering. See info.magnolia.rendering.renderer.AbstractRenderer#getAggregationStateSafely. Should you need the raw output, it can still be accessed from a template, with, for instance: ${state.unwrap().originalURI}. However, be warned that this may expose your webapp to XSS attacks. This class belongs to Magnolia's "private" API and it should NOT be extended/overridden, even though it is not marked as final. Its API and/or implementation may change without notice. The class may also be removed altogether without notice.

Constructor Summary

Constructors
Modifier Constructor and Description

protected HTMLEscapingAggregationState(javax.inject.Provider<AggregationState> aggregationStateProvider)

Constructors
Modifier	Constructor and Description
`protected`	`HTMLEscapingAggregationState(javax.inject.Provider<AggregationState> aggregationStateProvider)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Channel`	`getChannel()`
`String`	`getCharacterEncoding()`
`javax.jcr.Node`	`getCurrentContentNode()`
`String`	`getCurrentURI()`
`String`	`getExtension()`
`File`	`getFile()`
`String`	`getHandle()`
`Locale`	`getLocale()` If the aggregation state local is not set explicitly the contexts locale is returned.
`javax.jcr.Node`	`getMainContentNode()`
`String`	`getOriginalBrowserURI()`
`String`	`getOriginalBrowserURL()`
`String`	`getOriginalURI()` Returns the original request URI, decoded and without the context path.
`String`	`getOriginalURL()`
`String`	`getQueryString()` Returns the original request query string.
`String`	`getRepository()`
`String`	`getSelector()` A selector is the part between the first `SelectorUtil.SELECTOR_DELIMITER` and the extension of an URI.
`String[]`	`getSelectors()`
`String`	`getTemplateName()`
`String`	`getUriPrefix()`
`boolean`	`isPreviewMode()`
`void`	`setChannel(Channel channel)`
`void`	`setCharacterEncoding(String characterEncoding)`
`void`	`setCurrentContentNode(javax.jcr.Node currentContentNode)`
`void`	`setCurrentURI(String currentURI)`
`void`	`setExtension(String extension)`
`void`	`setFile(File file)`
`void`	`setHandle(String handle)`
`void`	`setLocale(Locale locale)`
`void`	`setMainContentNode(javax.jcr.Node mainContentNode)`
`void`	`setOriginalBrowserURI(String originalBrowserURI)`
`void`	`setOriginalBrowserURL(String originalBrowserURL)`
`void`	`setOriginalURI(String originalURI)`
`void`	`setOriginalURL(String originalURL)`
`void`	`setPreviewMode(boolean previewMode)`
`void`	`setQueryString(String queryString)`
`void`	`setRepository(String repository)`
`void`	`setSelector(String selector)` Warning - this might change in the future - see MAGNOLIA-2343 for details.
`void`	`setTemplateName(String templateName)`
`void`	`setUriPrefix(String uriPrefix)`
`protected String`	`stripContextPathIfExists(String uri)` WARNING: If passing URI without context path but it starts with same text as the context path it will be stripped off as well!!!
`AggregationState`	`unwrap()` WARNING: doing for instance ${state.unwrap()} in a template and then calling any method on the raw {@link AggregationState} will disable automatic HTML escaping provided by this wrapper thus potentially exposing your webapp to XSS attacks.

Methods inherited from class info.magnolia.cms.core.AggregationState
resetURIs

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

- Constructor Detail
  - HTMLEscapingAggregationState
```
@Inject
protected HTMLEscapingAggregationState(javax.inject.Provider<AggregationState> aggregationStateProvider)
```
- Method Detail
  - unwrap
```
public AggregationState unwrap()
```
    WARNING: doing for instance ${state.unwrap()} in a template and then calling any method on the raw {@link AggregationState} will disable automatic HTML escaping provided by this wrapper thus potentially exposing your webapp to XSS attacks.
    
    Returns:
    
    the plain AggregationState object.
  - getCurrentURI
```
public String getCurrentURI()
```
    Overrides:
    
    getCurrentURI in class AggregationState
    
    Returns:
    
    the URI of the current request, decoded and without the context path. This URI might have been modified by various filters.
  - getOriginalURI
```
public String getOriginalURI()
```
    Description copied from class: AggregationState
    
    Returns the original request URI, decoded and without the context path. Can never be modified.
    
    Overrides:
    
    getOriginalURI in class AggregationState
  - getOriginalURL
```
public String getOriginalURL()
```
    Overrides:
    
    getOriginalURL in class AggregationState
  - getQueryString
```
public String getQueryString()
```
    Description copied from class: AggregationState
    
    Returns the original request query string.
    
    Overrides:
    
    getQueryString in class AggregationState
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Overrides:
    
    getCharacterEncoding in class AggregationState
  - getOriginalBrowserURI
```
public String getOriginalBrowserURI()
```
    Overrides:
    
    getOriginalBrowserURI in class AggregationState
  - getOriginalBrowserURL
```
public String getOriginalBrowserURL()
```
    Overrides:
    
    getOriginalBrowserURL in class AggregationState
  - getExtension
```
public String getExtension()
```
    Overrides:
    
    getExtension in class AggregationState
  - getUriPrefix
```
public String getUriPrefix()
```
    Overrides:
    
    getUriPrefix in class AggregationState
  - getHandle
```
public String getHandle()
```
    Overrides:
    
    getHandle in class AggregationState
  - getRepository
```
public String getRepository()
```
    Overrides:
    
    getRepository in class AggregationState
  - getSelector
```
public String getSelector()
```
    Description copied from class: AggregationState
    
    A selector is the part between the first SelectorUtil.SELECTOR_DELIMITER and the extension of an URI. I.e. given a URI like http://myserver/mypage~x~foo=bar~.html the entire selector is ~x~foo=bar~. A selector can be split in turn into several selectors separated from each other by the SelectorUtil.SELECTOR_DELIMITER. In the above example, single selectors are x and foo=bar. The latter is a name=value selector which is set in the MgnlContext as an attribute with scope Context.LOCAL_SCOPE. You can retrieve its value via MgnlContext.getAttribute("foo").
    You can get and iterate over a full selector with the AggregationState.getSelectors() method.
    Warning - this might change in the future - see MAGNOLIA-2343 for details.
    
    Overrides:
    
    getSelector in class AggregationState
  - getTemplateName
```
public String getTemplateName()
```
    Overrides:
    
    getTemplateName in class AggregationState
  - stripContextPathIfExists
```
protected String stripContextPathIfExists(String uri)
```
    Description copied from class: AggregationState
    
    WARNING: If passing URI without context path but it starts with same text as the context path it will be stripped off as well!!!
    
    Overrides:
    
    stripContextPathIfExists in class AggregationState
    
    Parameters:
    
    uri - with contextPath (maybe)
    
    Returns:
    
    uri stripped of the prefix matching the contextPath
  - getSelectors
```
public String[] getSelectors()
```
    Overrides:
    
    getSelectors in class AggregationState
    
    Returns:
    
    an array containing the selectors found in the URI. The array is empty if no selector is in the current aggregation state. Given a URI like this http://www.magnolia-cms.com/node~value1~value2~.html?someparam=booo, the entire selector is ~value1~value2~, whereas the single selectors are value1 and value2. Selectors are delimited by SelectorUtil.SELECTOR_DELIMITER.
    Warning - this might change in the future - see MAGNOLIA-2343 for details.
  - setOriginalURI
```
public void setOriginalURI(String originalURI)
```
    Overrides:
    
    setOriginalURI in class AggregationState
  - setOriginalBrowserURI
```
public void setOriginalBrowserURI(String originalBrowserURI)
```
    Overrides:
    
    setOriginalBrowserURI in class AggregationState
  - setCurrentURI
```
public void setCurrentURI(String currentURI)
```
    Overrides:
    
    setCurrentURI in class AggregationState
  - setQueryString
```
public void setQueryString(String queryString)
```
    Overrides:
    
    setQueryString in class AggregationState
  - setOriginalURL
```
public void setOriginalURL(String originalURL)
```
    Overrides:
    
    setOriginalURL in class AggregationState
  - setOriginalBrowserURL
```
public void setOriginalBrowserURL(String originalBrowserURL)
```
    Overrides:
    
    setOriginalBrowserURL in class AggregationState
  - setCharacterEncoding
```
public void setCharacterEncoding(String characterEncoding)
```
    Overrides:
    
    setCharacterEncoding in class AggregationState
  - setExtension
```
public void setExtension(String extension)
```
    Overrides:
    
    setExtension in class AggregationState
  - setFile
```
public void setFile(File file)
```
    Overrides:
    
    setFile in class AggregationState
  - setUriPrefix
```
public void setUriPrefix(String uriPrefix)
```
    Overrides:
    
    setUriPrefix in class AggregationState
  - setHandle
```
public void setHandle(String handle)
```
    Overrides:
    
    setHandle in class AggregationState
  - setMainContentNode
```
public void setMainContentNode(javax.jcr.Node mainContentNode)
```
    Overrides:
    
    setMainContentNode in class AggregationState
  - setRepository
```
public void setRepository(String repository)
```
    Overrides:
    
    setRepository in class AggregationState
  - setSelector
```
public void setSelector(String selector)
```
    Description copied from class: AggregationState
    
    Warning - this might change in the future - see MAGNOLIA-2343 for details. The provided selector value is decoded upon settings according to rules described in URLDecoder.decode(java.lang.String, java.lang.String)
    
    Overrides:
    
    setSelector in class AggregationState
  - setTemplateName
```
public void setTemplateName(String templateName)
```
    Overrides:
    
    setTemplateName in class AggregationState
  - setLocale
```
public void setLocale(Locale locale)
```
    Overrides:
    
    setLocale in class AggregationState
    
    Parameters:
    
    locale - The aggregation state level locale, i.e. the locale that should be used for contents
  - setPreviewMode
```
public void setPreviewMode(boolean previewMode)
```
    Overrides:
    
    setPreviewMode in class AggregationState
  - setChannel
```
public void setChannel(Channel channel)
```
    Overrides:
    
    setChannel in class AggregationState
  - setCurrentContentNode
```
public void setCurrentContentNode(javax.jcr.Node currentContentNode)
```
    Overrides:
    
    setCurrentContentNode in class AggregationState
  - getFile
```
public File getFile()
```
    Overrides:
    
    getFile in class AggregationState
  - getMainContentNode
```
public javax.jcr.Node getMainContentNode()
```
    Overrides:
    
    getMainContentNode in class AggregationState
  - getCurrentContentNode
```
public javax.jcr.Node getCurrentContentNode()
```
    Overrides:
    
    getCurrentContentNode in class AggregationState
  - getLocale
```
public Locale getLocale()
```
    Description copied from class: AggregationState
    
    If the aggregation state local is not set explicitly the contexts locale is returned.
    
    Overrides:
    
    getLocale in class AggregationState
    
    Returns:
    
    The aggregation state level locale, i.e. the locale that should be used for contents
  - isPreviewMode
```
public boolean isPreviewMode()
```
    Overrides:
    
    isPreviewMode in class AggregationState
  - getChannel
```
public Channel getChannel()
```
    Overrides:
    
    getChannel in class AggregationState

Class HTMLEscapingAggregationState

Constructor Summary

Method Summary

Methods inherited from class info.magnolia.cms.core.AggregationState

Methods inherited from class java.lang.Object

Constructor Detail

HTMLEscapingAggregationState

Method Detail

unwrap

getCurrentURI

getOriginalURI

getOriginalURL

getQueryString

getCharacterEncoding

getOriginalBrowserURI

getOriginalBrowserURL

getExtension

getUriPrefix

getHandle

getRepository

getSelector

getTemplateName

stripContextPathIfExists

getSelectors

setOriginalURI

setOriginalBrowserURI

setCurrentURI

setQueryString

setOriginalURL

setOriginalBrowserURL

setCharacterEncoding

setExtension

setFile

setUriPrefix

setHandle

setMainContentNode

setRepository

setSelector

setTemplateName

setLocale

setPreviewMode

setChannel

setCurrentContentNode

getFile

getMainContentNode

getCurrentContentNode

getLocale

isPreviewMode

getChannel