Package com.atlassian.confluence.velocity.htmlsafe

Class ConfluenceHtmlEntityEncodingPolicy

java.lang.Object

com.atlassian.confluence.velocity.htmlsafe.ConfluenceHtmlEntityEncodingPolicy

All Implemented Interfaces:

com.atlassian.velocity.htmlsafe.ReferenceInsertionPolicy

public final class ConfluenceHtmlEntityEncodingPolicy
extends Object
implements com.atlassian.velocity.htmlsafe.ReferenceInsertionPolicy

This reference insertion policy implements the strategy used by Confluence to determine whether automatic HTML entity encoding should be applied to any particular context or template used by the Velocity rendering system.

Since:

8.6

Constructor Summary

Constructors

Constructor	Description
ConfluenceHtmlEntityEncodingPolicy()

Method Summary

Modifier and Type	Method	Description
org.apache.velocity.app.event.ReferenceInsertionEventHandler	getReferenceInsertionEventHandler(org.apache.velocity.context.Context context)
boolean	shouldAutoEncode(org.apache.velocity.context.Context context)
boolean	shouldAutoEncode(org.apache.velocity.context.Context context, @Nullable org.apache.velocity.Template template)	Decides whether autoencoding should be enabled for a given context and optional template.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfluenceHtmlEntityEncodingPolicy

public ConfluenceHtmlEntityEncodingPolicy()

Method Details

shouldAutoEncode

public boolean shouldAutoEncode(org.apache.velocity.context.Context context,
 @Nullable org.apache.velocity.Template template)

Decides whether autoencoding should be enabled for a given context and optional template. We currently autoencode:

• if the template is a HtmlSafeVelocityTemplate without autoencodeDisabled
• OR if the template is null or otherwise not a HtmlSafeVelocityTemplate and the context _is_ or _wraps an OutputMimeTypeAwareContext with a mimetype of html

Parameters:

context - a context which will be handled specially if it is an OutputMimeTypeAwareContext or is an InternalContextAdapter containing an OutputMimeTypeAwareContext.

template - a nullable template which will be handled specially if it's a HtmlSafeVelocityTemplate

Returns:

true if autoencoding should be enabled for this context and template.

shouldAutoEncode

public boolean shouldAutoEncode(org.apache.velocity.context.Context context)

getReferenceInsertionEventHandler

public org.apache.velocity.app.event.ReferenceInsertionEventHandler getReferenceInsertionEventHandler(org.apache.velocity.context.Context context)

Specified by:

getReferenceInsertionEventHandler in interface com.atlassian.velocity.htmlsafe.ReferenceInsertionPolicy