Package org.apache.ofbiz.base.util

Class UtilCodec.HtmlEncoder

java.lang.Object

org.apache.ofbiz.base.util.UtilCodec.HtmlEncoder

All Implemented Interfaces:

UtilCodec.SimpleEncoder

Enclosing class:

UtilCodec

public static class UtilCodec.HtmlEncoder
extends Object
implements UtilCodec.SimpleEncoder

Field Summary

Fields

Modifier and Type	Field	Description
static final org.owasp.html.PolicyFactory	BIRT_FLEXIBLE_REPORT_POLICY
static final org.owasp.html.PolicyFactory	PERMISSIVE_POLICY

Constructor Summary

Constructors

Constructor	Description
HtmlEncoder()

Method Summary

Modifier and Type	Method	Description
String	encode(String original)
String	sanitize(String original)	Deprecated. Use sanitize(String, String) instead
String	sanitize(String original, String contentTypeId)	This method will start a configurable sanitizing process.

Methods inherited from class java.lang.Object

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

Field Details

PERMISSIVE_POLICY

public static final org.owasp.html.PolicyFactory PERMISSIVE_POLICY

BIRT_FLEXIBLE_REPORT_POLICY

public static final org.owasp.html.PolicyFactory BIRT_FLEXIBLE_REPORT_POLICY

Constructor Details

HtmlEncoder

public HtmlEncoder()

Method Details

encode

public String encode(String original)

Specified by:

encode in interface UtilCodec.SimpleEncoder

sanitize

@Deprecated
public String sanitize(String original)

Deprecated.

Use sanitize(String, String) instead

Specified by:

sanitize in interface UtilCodec.SimpleEncoder

sanitize

public String sanitize(String original,
 String contentTypeId)

This method will start a configurable sanitizing process. The sanitizer can be turns off through "sanitizer.enable=false", the default value is true. It is possible to configure a custom policy using the properties "sanitizer.permissive.policy" and "sanitizer.custom.permissive.policy.class". The custom policy has to implement SanitizerCustomPolicy.

Specified by:

sanitize in interface UtilCodec.SimpleEncoder

Parameters:

original -

contentTypeId -

Returns:

sanitized HTML-Code if enabled, original HTML-Code when disabled

See Also:

• CustomPermissivePolicy