org.jahia.services.content.interceptor

Class BaseInterceptor

java.lang.Object

org.jahia.services.content.interceptor.BaseInterceptor

All Implemented Interfaces:

PropertyInterceptor

Direct Known Subclasses:

ChangedNodeInterceptor, HtmlFilteringInterceptor, LastModifiedInterceptor, RichTextInterceptor, TagInterceptor, TemplateModuleInterceptor, URLInterceptor

public abstract class BaseInterceptor
extends Object
implements PropertyInterceptor

Abstract property interceptor that does not do any value modifications. To be subclassed for particular usage.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
BaseInterceptor()

Method Summary

Modifier and Type	Method and Description
javax.jcr.Value	afterGetValue(JCRPropertyWrapper property, javax.jcr.Value storedValue) Called after getting the value.
javax.jcr.Value[]	afterGetValues(JCRPropertyWrapper property, javax.jcr.Value[] storedValues) Called after getting the value.
void	beforeRemove(JCRNodeWrapper node, String name, ExtendedPropertyDefinition definition)
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.
boolean	canApplyOnProperty(JCRNodeWrapper node, ExtendedPropertyDefinition definition) Checks if this interceptor need to be called on that property.
boolean	equals(Object obj)
protected Set<String>	getNodeTypes()
protected Set<String>	getPropertyNames()
protected Set<Integer>	getRequiredTypes()
protected Set<Integer>	getSelectors()
int	hashCode()
void	setNodeTypes(Set<String> nodeTypes)
void	setPropertyNames(Set<String> propertyNames)
void	setRequiredTypes(Set<String> requiredTypes)
void	setSelectors(Set<String> selectors)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseInterceptor

public BaseInterceptor()

Method Detail

afterGetValue

public javax.jcr.Value afterGetValue(JCRPropertyWrapper property,
                                     javax.jcr.Value storedValue)
                              throws javax.jcr.ValueFormatException,
                                     javax.jcr.RepositoryException

Description copied from interface: PropertyInterceptor

Called after getting the value. Stored value is passed to the interceptor and can be transformed.

Specified by:

afterGetValue in interface PropertyInterceptor

Returns:

Throws:

javax.jcr.ValueFormatException

javax.jcr.RepositoryException

afterGetValues

public javax.jcr.Value[] afterGetValues(JCRPropertyWrapper property,
                                        javax.jcr.Value[] storedValues)
                                 throws javax.jcr.ValueFormatException,
                                        javax.jcr.RepositoryException

Description copied from interface: PropertyInterceptor

Called after getting the value. Stored value is passed to the interceptor and can be transformed.

Specified by:

afterGetValues in interface PropertyInterceptor

Returns:

Throws:

javax.jcr.ValueFormatException

javax.jcr.RepositoryException

beforeRemove

public void beforeRemove(JCRNodeWrapper node,
                         String name,
                         ExtendedPropertyDefinition definition)
                  throws javax.jcr.version.VersionException,
                         javax.jcr.lock.LockException,
                         javax.jcr.nodetype.ConstraintViolationException,
                         javax.jcr.RepositoryException

Specified by:

beforeRemove in interface PropertyInterceptor

Throws:

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.RepositoryException

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

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

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

canApplyOnProperty

public boolean canApplyOnProperty(JCRNodeWrapper node,
                                  ExtendedPropertyDefinition definition)
                           throws javax.jcr.RepositoryException

Description copied from interface: PropertyInterceptor

Checks if this interceptor need to be called on that property.

Specified by:

canApplyOnProperty in interface PropertyInterceptor

definition - @return

Throws:

javax.jcr.RepositoryException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getNodeTypes

protected Set<String> getNodeTypes()

getPropertyNames

protected Set<String> getPropertyNames()

getRequiredTypes

protected Set<Integer> getRequiredTypes()

getSelectors

protected Set<Integer> getSelectors()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setNodeTypes

public void setNodeTypes(Set<String> nodeTypes)

setPropertyNames

public void setPropertyNames(Set<String> propertyNames)

setRequiredTypes

public void setRequiredTypes(Set<String> requiredTypes)

setSelectors

public void setSelectors(Set<String> selectors)

toString

public String toString()

Overrides:

toString in class Object