Package de.hybris.platform.servicelayer.web

Class DefaultXSSFilterConfig

java.lang.Object

de.hybris.platform.servicelayer.web.DefaultXSSFilterConfig

All Implemented Interfaces:

XSSFilter.XSSFilterConfig

public class DefaultXSSFilterConfig
extends java.lang.Object
implements XSSFilter.XSSFilterConfig

Default XSSFilter.XSSFilterConfig implementation backed by the platform ConfigIntf.

Please note that this requires a running platform to use.

Constructor Summary

Constructors

Constructor	Description
DefaultXSSFilterConfig(javax.servlet.FilterConfig filterConfig)

Method Summary

Modifier and Type	Method	Description
XSSMatchAction	getActionOnMatch()	The action to be performed whenever a value is encountered which matches a filtering pattern.
java.util.Map<java.lang.String,java.lang.String>	getHeadersToInject()	In addition to matching patterns this method allows to specify a map of response headers to be injected into each response.
java.util.Map<java.lang.String,java.lang.String>	getHostHeaderWhiteList()	RegExp patterns that host header whitelist is made of.
java.util.Map<java.lang.String,java.lang.String>	getPatternDefinitions()	All regExp patterns to scan for.
boolean	isEnabled()	Enables/disables XSS logic.
void	registerForConfigChanges(XSSFilter toUpdateOnConfigChange)	Called by the filter in case it wants to be notified on configuration changes ( any property matching XSSFilter.CONFIG_RULE_PREFIX_REGEXP ).
boolean	sortRules()	Enables sorting rules by their names in alphabetical order.
void	unregisterConfigChangeListener()	Called by the filter when it does no longer wants to be notified about configuration changes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultXSSFilterConfig

public DefaultXSSFilterConfig(javax.servlet.FilterConfig filterConfig)

Method Detail

registerForConfigChanges

public void registerForConfigChanges(XSSFilter toUpdateOnConfigChange)

Description copied from interface: XSSFilter.XSSFilterConfig

Called by the filter in case it wants to be notified on configuration changes ( any property matching XSSFilter.CONFIG_RULE_PREFIX_REGEXP ). Each time this happens XSSFilter.reloadOnConfigChange() is being called.

Specified by:

registerForConfigChanges in interface XSSFilter.XSSFilterConfig

unregisterConfigChangeListener

public void unregisterConfigChangeListener()

Description copied from interface: XSSFilter.XSSFilterConfig

Called by the filter when it does no longer wants to be notified about configuration changes.

Specified by:

unregisterConfigChangeListener in interface XSSFilter.XSSFilterConfig

isEnabled

public boolean isEnabled()

Description copied from interface: XSSFilter.XSSFilterConfig

Enables/disables XSS logic. When switched off the filter should have no effect.

Specified by:

isEnabled in interface XSSFilter.XSSFilterConfig

sortRules

public boolean sortRules()

Description copied from interface: XSSFilter.XSSFilterConfig

Enables sorting rules by their names in alphabetical order. This way the order or rules can be guaranteed.

Specified by:

sortRules in interface XSSFilter.XSSFilterConfig

getActionOnMatch

public XSSMatchAction getActionOnMatch()

Description copied from interface: XSSFilter.XSSFilterConfig

The action to be performed whenever a value is encountered which matches a filtering pattern. Default should be XSSMatchAction.STRIP.

Specified by:

getActionOnMatch in interface XSSFilter.XSSFilterConfig

getPatternDefinitions

public java.util.Map<java.lang.String,java.lang.String> getPatternDefinitions()

Description copied from interface: XSSFilter.XSSFilterConfig

All regExp patterns to scan for. Note that the map keys just represent pattern names used for information purposes (e.g. when the pattern doesn't compile).

Specified by:

getPatternDefinitions in interface XSSFilter.XSSFilterConfig

getHeadersToInject

public java.util.Map<java.lang.String,java.lang.String> getHeadersToInject()

Description copied from interface: XSSFilter.XSSFilterConfig

In addition to matching patterns this method allows to specify a map of response headers to be injected into each response.

Specified by:

getHeadersToInject in interface XSSFilter.XSSFilterConfig

getHostHeaderWhiteList

public java.util.Map<java.lang.String,java.lang.String> getHostHeaderWhiteList()

Description copied from interface: XSSFilter.XSSFilterConfig

RegExp patterns that host header whitelist is made of.

Specified by:

getHostHeaderWhiteList in interface XSSFilter.XSSFilterConfig