org.hippoecm.hst.content.rewriter.impl

Class SimpleContentRewriter

java.lang.Object

org.hippoecm.hst.content.rewriter.impl.AbstractContentRewriter<String>

org.hippoecm.hst.content.rewriter.impl.SimpleContentRewriter

All Implemented Interfaces:

ContentRewriter<String>

public class SimpleContentRewriter
extends AbstractContentRewriter<String>

SimpleContentRewriter Rewrites rich text stored in HippoHtml nodes. Links to repository content are rewritten to URLs. The href attributes of anchor tags can contain a reference to a child node of the HippoHtml node. This child node will contain a link to a repository resource. The same applies to the src attributes of image tags.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ATTR_END
protected static Pattern	BODY_TAG_PATTERN
protected static String	END_TAG
protected static String[]	EXTERNALS External URL resources which are not generated from the repository resources.
protected static String	HREF_ATTR_NAME
protected static Pattern	HTML_TAG_PATTERN
protected static String	IMG_TAG
protected static String	LINK_TAG
protected static String	SRC_ATTR_NAME

Constructor Summary

Constructors

Constructor and Description
SimpleContentRewriter()

Method Summary

Modifier and Type	Method and Description
protected HstLink	createInternalLink(javax.jcr.Node referencedNode, HstRequestContext requestContext, Mount targetMount) Create an HstLink to a referenced node in rich text.
protected String	decodePath(String path)
protected HstLink	getBinaryLink(String path, javax.jcr.Node node, HstRequestContext requestContext, Mount targetMount)
protected HstLink	getDocumentLink(String path, javax.jcr.Node hippoHtmlNode, HstRequestContext requestContext, Mount targetMount)
protected HstLink	getLink(String path, javax.jcr.Node hippoHtmlNode, HstRequestContext requestContext, Mount targetMount)
protected boolean	isExternal(String tagReference) Check to see if a tag does not reference a dynamic resource
String	rewrite(String html, HstRequestContext requestContext) Rewrites the content with HstRequestContext.
String	rewrite(String html, javax.jcr.Node hippoHtmlNode, HstRequestContext requestContext) Rewrites the content for Node contentNode.
String	rewrite(String html, javax.jcr.Node hippoHtmlNode, HstRequestContext requestContext, Mount targetMount) Rewrite link references in rich text to valid URLs.
String	rewrite(String html, javax.jcr.Node hippoHtmlNode, HstRequestContext requestContext, String targetSiteAlias) Rewrites the content of the content node.
protected String	rewriteBinaryLink(String binaryLinkReference, javax.jcr.Node hippoHtmlNode, HstRequestContext requestContext, Mount targetMount) Rewrites binary link in src attribute of img tag.
protected String	rewriteDocumentLink(String documentLinkReference, javax.jcr.Node hippoHtmlNode, HstRequestContext requestContext, Mount targetMount) Rewrites document link in href attribute of anchor tag.

Methods inherited from class org.hippoecm.hst.content.rewriter.impl.AbstractContentRewriter

getImageVariant, isCanonicalLinks, isFullyQualifiedLinks, setCanonicalLinks, setFullyQualifiedLinks, setImageVariant

Methods inherited from class java.lang.Object

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

Field Detail

EXTERNALS

protected static final String[] EXTERNALS

External URL resources which are not generated from the repository resources.

LINK_TAG

protected static final String LINK_TAG

See Also:

Constant Field Values

IMG_TAG

protected static final String IMG_TAG

See Also:

Constant Field Values

END_TAG

protected static final String END_TAG

See Also:

Constant Field Values

HREF_ATTR_NAME

protected static final String HREF_ATTR_NAME

See Also:

Constant Field Values

SRC_ATTR_NAME

protected static final String SRC_ATTR_NAME

See Also:

Constant Field Values

ATTR_END

protected static final String ATTR_END

See Also:

Constant Field Values

HTML_TAG_PATTERN

protected static final Pattern HTML_TAG_PATTERN

BODY_TAG_PATTERN

protected static final Pattern BODY_TAG_PATTERN

Constructor Detail

SimpleContentRewriter

public SimpleContentRewriter()

Method Detail

rewrite

public String rewrite(String html,
                      HstRequestContext requestContext)

Description copied from interface: ContentRewriter

Rewrites the content with HstRequestContext. Since there is no contentNode param as is for ContentRewriter.rewrite(Object, javax.jcr.Node, org.hippoecm.hst.core.request.HstRequestContext) this method typically cannot translate internal links in the content

Specified by:

rewrite in interface ContentRewriter<String>

Overrides:

rewrite in class AbstractContentRewriter<String>

rewrite

public String rewrite(String html,
                      javax.jcr.Node hippoHtmlNode,
                      HstRequestContext requestContext)

Description copied from interface: ContentRewriter

Rewrites the content for Node contentNode.

Specified by:

rewrite in interface ContentRewriter<String>

Overrides:

rewrite in class AbstractContentRewriter<String>

Parameters:

html - content object. It can be type of String or whatever, depending on the implementation and the context.

hippoHtmlNode - the Node that contains the content

requestContext - the HstRequestContext

Returns:

the rewritten content T

rewrite

public String rewrite(String html,
                      javax.jcr.Node hippoHtmlNode,
                      HstRequestContext requestContext,
                      String targetSiteAlias)

Description copied from interface: ContentRewriter

Rewrites the content of the content node.

Specified by:

rewrite in interface ContentRewriter<String>

Overrides:

rewrite in class AbstractContentRewriter<String>

rewrite

public String rewrite(String html,
                      javax.jcr.Node hippoHtmlNode,
                      HstRequestContext requestContext,
                      Mount targetMount)

Rewrite link references in rich text to valid URLs. A link reference must match the name of a child node of the HippoHtml node that contains a link to a JCR node.

Specified by:

rewrite in interface ContentRewriter<String>

Overrides:

rewrite in class AbstractContentRewriter<String>

Parameters:

html - rich text with possible link references

hippoHtmlNode - the node that has child nodes that contain references to JCR nodes

requestContext - the context for the current request

targetMount - mount that the links must point to

Returns:

rewritten html with URLs

rewriteDocumentLink

protected String rewriteDocumentLink(String documentLinkReference,
                                     javax.jcr.Node hippoHtmlNode,
                                     HstRequestContext requestContext,
                                     Mount targetMount)

Rewrites document link in href attribute of anchor tag.

Parameters:

documentLinkReference - reference to a document link child node of the hippoHtmlNode

hippoHtmlNode - the node that contains rich text and child nodes with jcr links

requestContext - the context for the current request

targetMount - mount that the link must point to

Returns:

document link reference rewritten to a URL or page not found link

rewriteBinaryLink

protected String rewriteBinaryLink(String binaryLinkReference,
                                   javax.jcr.Node hippoHtmlNode,
                                   HstRequestContext requestContext,
                                   Mount targetMount)

Rewrites binary link in src attribute of img tag.

Parameters:

binaryLinkReference - reference to a document link child node of the hippoHtmlNode

hippoHtmlNode - the node that contains rich text and child nodes with jcr links

requestContext - the context for the current request

targetMount - mount that the link must point to

Returns:

binary link reference rewritten to a URL or page not found link

getDocumentLink

protected HstLink getDocumentLink(String path,
                                  javax.jcr.Node hippoHtmlNode,
                                  HstRequestContext requestContext,
                                  Mount targetMount)

getBinaryLink

protected HstLink getBinaryLink(String path,
                                javax.jcr.Node node,
                                HstRequestContext requestContext,
                                Mount targetMount)

getLink

protected HstLink getLink(String path,
                          javax.jcr.Node hippoHtmlNode,
                          HstRequestContext requestContext,
                          Mount targetMount)

decodePath

protected String decodePath(String path)

createInternalLink

protected HstLink createInternalLink(javax.jcr.Node referencedNode,
                                     HstRequestContext requestContext,
                                     Mount targetMount)
                              throws javax.jcr.RepositoryException

Create an HstLink to a referenced node in rich text.

Parameters:

referencedNode - the node to create a link to

requestContext - the context for the current request

targetMount - mount that the link must point to. may be null

Returns:

link to the referenced node and optional target mount. target mount is ignored in case links must be canonical.

Throws:

javax.jcr.RepositoryException - if no path can be retrieved from the referencedNode

isExternal

protected boolean isExternal(String tagReference)

Check to see if a tag does not reference a dynamic resource

Parameters:

tagReference - the tag reference

Returns:

true if the tag does not reference a dynamic resource