org.springframework.extensions.directives

Class ResourceFreemarkerTagDirective

java.lang.Object

org.springframework.extensions.surf.extensibility.impl.AbstractFreeMarkerDirective

org.springframework.extensions.directives.RenderServiceFreeMarkerDirective

org.springframework.extensions.directives.ResourceFreemarkerTagDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

public class ResourceFreemarkerTagDirective
extends RenderServiceFreeMarkerDirective

Outputs the requested url representation of a resource. Named Resource Examples:

• <@res name="resourceName" />
• <@res id="://<endpoint>/<object id>" />
• <@res protocol="<protocol>" endpoint="<endpoint>" object="<object id>" />
• <@res name="resourceName" payload="metadata" />
• <@res name="resourceName" payload="content" />

Author:

David Draper, muzquiano

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
ResourceFreemarkerTagDirective(String directiveName, RequestContext context, ModelObject object, RenderService renderService) Instantiates a new ResourceFreemarkerTagDirective.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(freemarker.core.Environment env, Map params, freemarker.template.TemplateModel[] loopVars, freemarker.template.TemplateDirectiveBody body) This method is declared by the TemplateDirectiveModel interface that the abstract superclass AbstractFreeMarkerDirective implements.

Methods inherited from class org.springframework.extensions.directives.RenderServiceFreeMarkerDirective

getObject, getRenderService, getRequestContext

Methods inherited from class org.springframework.extensions.surf.extensibility.impl.AbstractFreeMarkerDirective

getBooleanProperty, getDirectiveName, getStringProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceFreemarkerTagDirective

public ResourceFreemarkerTagDirective(String directiveName,
                              RequestContext context,
                              ModelObject object,
                              RenderService renderService)

Instantiates a new ResourceFreemarkerTagDirective. The RenderService will be used by calling its generateResourceURL method to generate the URL to output. The directive name is only needed for generating useful exception messages to assist debugging problems but an effort should be made to set it correctly

Parameters:

directiveName - The name of the directive represented by the instance of this class.

context - A RenderContext required as an argument to the RenderService methods.

renderService - A RenderService used to generate the output of the directive.

Method Detail

execute

public void execute(freemarker.core.Environment env,
           Map params,
           freemarker.template.TemplateModel[] loopVars,
           freemarker.template.TemplateDirectiveBody body)
             throws freemarker.template.TemplateException,
                    IOException

This method is declared by the TemplateDirectiveModel interface that the abstract superclass AbstractFreeMarkerDirective implements. It retrieves any properties supplied when invoking the directive and passes them onto the PresentationService method.

Throws:

freemarker.template.TemplateException

IOException