Package org.opencms.ugc

Class CmsUgcValueTransformerConfiguration

java.lang.Object

org.opencms.ugc.CmsUgcValueTransformerConfiguration

public class CmsUgcValueTransformerConfiguration
extends Object

Wrapper for a value transformer configuration that is provided in content's schema file in the parameters section as follows:

 <parameters>
    <param name="ugc.values.transformer">
    {
        "Paragraph/Text": {
            "transformer": "antisamy"
        },
        "Title": {
            "transformer": "antisamy",
            "config": {
                "policy": "/system/modules/my.module/resources/ugc/antisamy-policy.xml"
            }
        },
        "Author": {
            "transformer": "none"
        },
        "Email": {
            "transformer": "escape"
        }
    }
    </param>
 </parameter>
 

The configuration defines how values that are added via UGC at a certain path have to be transformed, primarily to not cause XSS or other issues.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CmsUgcValueTransformerConfiguration.CmsUgcSingleValueTransformer	The transformer for a single value.

Field Summary

Fields

Modifier and Type	Field	Description
static final CmsUgcValueTransformerConfiguration	DEFAULT	The default tranformer configuration.

Constructor Summary

Constructors

Constructor	Description
CmsUgcValueTransformerConfiguration(String config)	Wraps the provided transformer configuration

Method Summary

Modifier and Type	Method	Description
CmsUgcValueTransformerConfiguration.CmsUgcSingleValueTransformer	getTransformer(String path)	Returns the transformer for the provided XML path.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final CmsUgcValueTransformerConfiguration DEFAULT

The default tranformer configuration.

Constructor Details

CmsUgcValueTransformerConfiguration

public CmsUgcValueTransformerConfiguration(String config)
                                    throws JSONException,
IllegalArgumentException

Wraps the provided transformer configuration

Parameters:

config - the configuration to wrap

Throws:

JSONException - thrown if the configuration is not a valid JSON

IllegalArgumentException - thrown if the configuration values are not as expected

Method Details

getTransformer

public CmsUgcValueTransformerConfiguration.CmsUgcSingleValueTransformer getTransformer(String path)

Returns the transformer for the provided XML path.

Parameters:

path - the XML path to get the value transformer for.

Returns:

the transformer for the provided XML path.