org.jahia.services.content.interceptor

Class HtmlFilteringInterceptor

java.lang.Object

org.jahia.services.content.interceptor.BaseInterceptor

org.jahia.services.content.interceptor.HtmlFilteringInterceptor

All Implemented Interfaces:

PropertyInterceptor

public class HtmlFilteringInterceptor
extends BaseInterceptor

Filters out unwanted HTML elements from the rich text property values before saving.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
HtmlFilteringInterceptor()

Method Summary

Modifier and Type	Method and Description
javax.jcr.Value	beforeSetValue(JCRNodeWrapper node, String name, ExtendedPropertyDefinition definition, javax.jcr.Value originalValue) Called before setting the value on the property.
javax.jcr.Value[]	beforeSetValues(JCRNodeWrapper node, String name, ExtendedPropertyDefinition definition, javax.jcr.Value[] originalValues) Called before setting the value on the property.
protected static String	filterTags(String content, Set<String> filteredTags, boolean removeContentBetweenTags) Filters out configured "unwanted" HTML tags and returns the modified content.
void	setConsiderSiteSettingsForFiltering(boolean considerSiteSettingsForFiltering)
void	setFilteredTags(String tagsToFilter)
void	setRemoveContentBetweenTags(boolean removeContentBetweenTags) if set to true the content between the start and end tag elements will be also removed from the output; otherwise only start and end tags themselves are removed.

Methods inherited from class org.jahia.services.content.interceptor.BaseInterceptor

afterGetValue, afterGetValues, beforeRemove, canApplyOnProperty, equals, getNodeTypes, getPropertyNames, getRequiredTypes, getSelectors, hashCode, setNodeTypes, setPropertyNames, setRequiredTypes, setSelectors, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HtmlFilteringInterceptor

public HtmlFilteringInterceptor()

Method Detail

filterTags

protected static String filterTags(String content,
                                   Set<String> filteredTags,
                                   boolean removeContentBetweenTags)

Filters out configured "unwanted" HTML tags and returns the modified content. If no modifications needs to be done, returns the original content.

Parameters:

content - the content to be modified

filteredTags - the set of tags to be filtered out

removeContentBetweenTags - if set to true the content between the start and end tag elements will be also removed from the output; otherwise only start and end tags themselves are removed.

Returns:

filtered out content or the original one if no modifications needs to be done

beforeSetValue

public javax.jcr.Value beforeSetValue(JCRNodeWrapper node,
                                      String name,
                                      ExtendedPropertyDefinition definition,
                                      javax.jcr.Value originalValue)
                               throws javax.jcr.ValueFormatException,
                                      javax.jcr.version.VersionException,
                                      javax.jcr.lock.LockException,
                                      javax.jcr.nodetype.ConstraintViolationException,
                                      javax.jcr.RepositoryException

Description copied from interface: PropertyInterceptor

Called before setting the value on the property. Can throw an exception if the value is not valid, and transform the value into another value. The interceptor can also directly operate on the property before the property is effectively set. Returns the value to set - or null if no property need to be set, but without sending an error.

Specified by:

beforeSetValue in interface PropertyInterceptor

Overrides:

beforeSetValue in class BaseInterceptor

originalValue - Original value @return Value to set, or null @throws ValueFormatException

Throws:

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.ValueFormatException

javax.jcr.RepositoryException

beforeSetValues

public javax.jcr.Value[] beforeSetValues(JCRNodeWrapper node,
                                         String name,
                                         ExtendedPropertyDefinition definition,
                                         javax.jcr.Value[] originalValues)
                                  throws javax.jcr.ValueFormatException,
                                         javax.jcr.version.VersionException,
                                         javax.jcr.lock.LockException,
                                         javax.jcr.nodetype.ConstraintViolationException,
                                         javax.jcr.RepositoryException

Description copied from interface: PropertyInterceptor

Called before setting the value on the property. Can throw an exception if the value is not valid, and transform the value into another value. The interceptor can also directly operate on the property before the property is effectively set. Returns the value to set - or null if no property need to be set, but without sending an error.

Specified by:

beforeSetValues in interface PropertyInterceptor

Overrides:

beforeSetValues in class BaseInterceptor

originalValues - Original value @return Value to set, or null @throws ValueFormatException

Throws:

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.ValueFormatException

javax.jcr.RepositoryException

setConsiderSiteSettingsForFiltering

public void setConsiderSiteSettingsForFiltering(boolean considerSiteSettingsForFiltering)

setFilteredTags

public void setFilteredTags(String tagsToFilter)

setRemoveContentBetweenTags

public void setRemoveContentBetweenTags(boolean removeContentBetweenTags)

if set to true the content between the start and end tag elements will be also removed from the output; otherwise only start and end tags themselves are removed.

Parameters:

removeContentBetweenTags - do we remove the content between tag elements?