Package org.opencms.ugc

Class CmsUgcValueTranformHandler

java.lang.Object

org.opencms.ugc.CmsUgcValueTranformHandler

public class CmsUgcValueTranformHandler
extends Object

The class transforms the values that should be written to an XML content via UGC according to a content type specific value transformation configuration. By default all values are xml escaped to void XSS issues when content that is created via UGC is rendered on a webpage without any extra caution.

Field Summary

Fields

Modifier and Type	Field	Description
static final CmsUgcValueTranformHandler	DEFAULT	The default value transformer.

Constructor Summary

Constructors

Constructor	Description
CmsUgcValueTranformHandler(CmsObject cms, CmsResource resource)	Creates the value transformer instance for the provided resource.

Method Summary

Modifier and Type	Method	Description
String	transformValue(String path, String value)	The method applies the configured value transformer to the given value.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final CmsUgcValueTranformHandler DEFAULT

The default value transformer.

Constructor Details

CmsUgcValueTranformHandler

public CmsUgcValueTranformHandler(CmsObject cms,
 CmsResource resource)
                           throws CmsXmlException,
CmsException,
IllegalArgumentException,
JSONException

Creates the value transformer instance for the provided resource.

Parameters:

cms - the context

resource - the resource of the XML content to get the mapping security for

Throws:

CmsXmlException - thrown if the content can't be unmarshalled

CmsException - thrown if the content can't be read

IllegalArgumentException - thrown if the value transformer configuration contains invalid transformers.

JSONException - thrown if the value transformer configuration is no valid JSON.

Method Details

transformValue

public String transformValue(String path,
 String value)

The method applies the configured value transformer to the given value.

Parameters:

path - the XML path to store the value

value - the value to transform

Returns:

the transformed value