org.jahia.services.content.interceptor

Interface PropertyInterceptor

All Known Implementing Classes:

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

public interface PropertyInterceptor

Property interceptor catch get and set on properties. They can transform the value and veto a set operation, and retransform it back when getting values. An interceptor is called or not on a property, based on the parent node and property definition. Interceptors are called only in localized sessions.

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.

Method Detail

canApplyOnProperty

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

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

Parameters:

node -

definition - @return

Throws:

javax.jcr.RepositoryException

beforeRemove

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

Throws:

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.RepositoryException

beforeSetValue

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

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.

Parameters:

node -

name -

definition -

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

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

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.

Parameters:

node -

name -

definition -

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

afterGetValue

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

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

Parameters:

property -

storedValue -

Returns:

Throws:

javax.jcr.ValueFormatException

javax.jcr.RepositoryException

afterGetValues

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

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

Parameters:

property -

storedValues -

Returns:

Throws:

javax.jcr.ValueFormatException

javax.jcr.RepositoryException