org.jahia.services.content.interceptor

Class URLInterceptor

java.lang.Object

org.jahia.services.content.interceptor.BaseInterceptor

org.jahia.services.content.interceptor.URLInterceptor

All Implemented Interfaces:

PropertyInterceptor, org.springframework.beans.factory.InitializingBean

public class URLInterceptor
extends BaseInterceptor
implements org.springframework.beans.factory.InitializingBean

URL Interceptor catches internal URLs inside richtext, and transform them to store references to the pointed nodes instead of paths. It also replaces the servlet context and servlet name by a placeholder so that the stored link is not dependant of the deployment.

Two types of links are detected : CMS links (like /cms/render/default/en/sites/ACME/home.html ) and files links ( /files/sites/ACME/files/Pictures/BannerTeaser/img-home-fr.jpg ).

File path are transformed with references placeholders like ##ref:link1##. References targets are stored in the jmix:referenceInField child nodes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CMS_CONTEXT_PLACEHOLDER
static Pattern	CMS_CONTEXT_PLACEHOLDER_PATTERN
static String	DOC_CONTEXT_PLACEHOLDER
static Pattern	DOC_CONTEXT_PLACEHOLDER_PATTERN
static String	MISSING_IMAGE

Constructor Summary

Constructors

Constructor and Description
URLInterceptor(HtmlTagAttributeTraverser urlTraverser) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
javax.jcr.Value	afterGetValue(JCRPropertyWrapper property, javax.jcr.Value storedValue) Restore value by replace context ( ##doc-context## and ##cms-context## ) and references ( ##ref:link[0-9]+## placeholders.
javax.jcr.Value[]	afterGetValues(JCRPropertyWrapper property, javax.jcr.Value[] storedValues) Called after getting the value.
void	afterPropertiesSet()
void	beforeRemove(JCRNodeWrapper node, String name, ExtendedPropertyDefinition definition)
javax.jcr.Value	beforeSetValue(JCRNodeWrapper node, String name, ExtendedPropertyDefinition definition, javax.jcr.Value originalValue) Transform user URL with servlet context and links placeholders for storage.
javax.jcr.Value[]	beforeSetValues(JCRNodeWrapper node, String name, ExtendedPropertyDefinition definition, javax.jcr.Value[] originalValues) Called before setting the value on the property.
String	getCmsContext()
Pattern	getCmsPattern()
Pattern	getCmsPatternWithContextPlaceholder()
String	getDmsContext()
Pattern	getRefPattern()
void	setUrlReplacers(List<URLReplacer> urlReplacers)

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

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

Field Detail

DOC_CONTEXT_PLACEHOLDER

public static final String DOC_CONTEXT_PLACEHOLDER

See Also:

Constant Field Values

CMS_CONTEXT_PLACEHOLDER

public static final String CMS_CONTEXT_PLACEHOLDER

See Also:

Constant Field Values

DOC_CONTEXT_PLACEHOLDER_PATTERN

public static final Pattern DOC_CONTEXT_PLACEHOLDER_PATTERN

CMS_CONTEXT_PLACEHOLDER_PATTERN

public static final Pattern CMS_CONTEXT_PLACEHOLDER_PATTERN

MISSING_IMAGE

public static final String MISSING_IMAGE

See Also:

Constant Field Values

Constructor Detail

URLInterceptor

public URLInterceptor(HtmlTagAttributeTraverser urlTraverser)

Initializes an instance of this class.

Parameters:

urlTraverser - the URL utility class to visit HTML tag attributes

Method Detail

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

Overrides:

beforeRemove in class BaseInterceptor

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

Transform user URL with servlet context and links placeholders for storage.

Only URLs starting with //cms or //files are recognized.

CMS URLs can use mode and language placeholders : //cms/render/default/en/sites/ACME/home.html and //cms/##mode##/##lang##/sites/ACME/home.html are both recognized.

If any link is invalid, a ConstraintViolationException is thrown.

Add jmix:referencesInField mixin type to the parent node and j:referenceInField with the list of references contained in the value.

Specified by:

beforeSetValue in interface PropertyInterceptor

Overrides:

beforeSetValue in class BaseInterceptor

Parameters:

node -

name -

definition -

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

Throws:

javax.jcr.ValueFormatException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.RepositoryException - in case of JCR-related errors

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

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

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

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

Restore value by replace context ( ##doc-context## and ##cms-context## ) and references ( ##ref:link[0-9]+## placeholders. Resolves reference node and put path instead to make a valid link. If referenced node is not found, log an error and put # as a path.

Specified by:

afterGetValue in interface PropertyInterceptor

Overrides:

afterGetValue in class BaseInterceptor

Parameters:

property -

storedValue -

Returns:

Throws:

javax.jcr.ValueFormatException

javax.jcr.RepositoryException - in case of JCR-related errors

afterGetValues

public 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.

Specified by:

afterGetValues in interface PropertyInterceptor

Overrides:

afterGetValues in class BaseInterceptor

Parameters:

property -

storedValues -

Returns:

Throws:

javax.jcr.ValueFormatException

javax.jcr.RepositoryException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

setUrlReplacers

public void setUrlReplacers(List<URLReplacer> urlReplacers)

getDmsContext

public String getDmsContext()

getCmsContext

public String getCmsContext()

getCmsPattern

public Pattern getCmsPattern()

getCmsPatternWithContextPlaceholder

public Pattern getCmsPatternWithContextPlaceholder()

getRefPattern

public Pattern getRefPattern()