org.springframework.extensions.directives

Class AbstractDependencyExtensibilityDirective

java.lang.Object

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

org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

org.springframework.extensions.directives.AbstractDependencyExtensibilityDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel, org.springframework.extensions.surf.extensibility.ExtensibilityDirective

Direct Known Subclasses:

ChecksumResourceDirective, JavaScriptDependencyDirective, OutputCSSDirective, OutputJavaScriptDirective, RelocateJavaScriptOutputDirective, StandaloneWebScriptWrapper

public abstract class AbstractDependencyExtensibilityDirective
extends org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

An abstract directive implementation that provides additional methods for handling dependencies. These methods explicitly deal with manipulating dependency URLs to take application context and servlet context mappings into consideration.

Author:

David Draper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractDependencyExtensibilityDirective.ProcessedDependency Inner class that is provided to allow explicit processed dependency information to be passed.

Field Summary

Fields

Modifier and Type	Field and Description
protected DependencyAggregator	dependencyAggregator
protected DependencyHandler	dependencyHandler A DependencyHandler is used to handle locating and producing checksums for resource files.

Fields inherited from interface org.springframework.extensions.surf.extensibility.ExtensibilityDirective

ACTION, ACTION_AFTER, ACTION_BEFORE, ACTION_MERGE, ACTION_MODIFY, ACTION_REMOVE, ACTION_REPLACE, DIRECTIVE_ID, TARGET

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
AbstractDependencyExtensibilityDirective(String directiveName, org.springframework.extensions.surf.extensibility.ExtensibilityModel model)

Method Summary

Methods

Modifier and Type	Method and Description
ModelObject	getModelObject() Gets the ModelObject for the current thread.
RequestContext	getRequestContext() Retrieves the RequestContext for the current thread.
protected String	getResourceControllerMapping() Returns a String that is used to map requests to the ResourceController.
protected String	getToInsert(AbstractDependencyExtensibilityDirective.ProcessedDependency pd) Retrieves the prefix to insert of the URL from the AbstractDependencyExtensibilityDirective.ProcessedDependency object.
protected String	getUpdatedSrc(AbstractDependencyExtensibilityDirective.ProcessedDependency pd) Retrieves the modified source URL from the AbstractDependencyExtensibilityDirective.ProcessedDependency object.
WebFrameworkConfigElement	getWebFrameworkConfig()
AbstractDependencyExtensibilityDirective.ProcessedDependency	processDependency(String src) Examines the supplied dependency source and returns a AbstractDependencyExtensibilityDirective.ProcessedDependency instance containing the updated source (to be passed to the DependencyHandler as well as the prefix that should be added back to the updated source when outputting the source in the HTML element.
void	setDependencyAggregator(DependencyAggregator dependencyAggregator)
void	setDependencyHandler(DependencyHandler dependencyHandler) Sets the DependencyHandler
void	setModelObject(ModelObject object) Sets the ModelObject for the current thread.
void	setRequestContext(RequestContext requestContext) Sets the RequestContext for the current thread.
void	setWebFrameworkConfig(WebFrameworkConfigElement webFrameworkConfig)

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

after, before, createExtensibilityDirectiveData, execute, getId, getModel, merge, remove, replace

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

Field Detail

dependencyHandler

protected DependencyHandler dependencyHandler

A DependencyHandler is used to handle locating and producing checksums for resource files. This variable should be set through the Spring application context.

dependencyAggregator

protected DependencyAggregator dependencyAggregator

Constructor Detail

AbstractDependencyExtensibilityDirective

public AbstractDependencyExtensibilityDirective(String directiveName,
                                        org.springframework.extensions.surf.extensibility.ExtensibilityModel model)

Method Detail

getResourceControllerMapping

protected String getResourceControllerMapping()

Returns a String that is used to map requests to the ResourceController. This defaults to "/res/" but has been abstracted to a method so that this can be overridden.

Returns:

String

getWebFrameworkConfig

public WebFrameworkConfigElement getWebFrameworkConfig()

setWebFrameworkConfig

public void setWebFrameworkConfig(WebFrameworkConfigElement webFrameworkConfig)

setDependencyHandler

public void setDependencyHandler(DependencyHandler dependencyHandler)

Sets the DependencyHandler

Parameters:

dependencyHandler - DependencyHandler

setDependencyAggregator

public void setDependencyAggregator(DependencyAggregator dependencyAggregator)

setRequestContext

public void setRequestContext(RequestContext requestContext)

Sets the RequestContext for the current thread.

Parameters:

requestContext - RequestContext

getRequestContext

public RequestContext getRequestContext()

Retrieves the RequestContext for the current thread.

Returns:

RequestContext

setModelObject

public void setModelObject(ModelObject object)

Sets the ModelObject for the current thread.

Parameters:

object - ModelObject

getModelObject

public ModelObject getModelObject()

Gets the ModelObject for the current thread.

Returns:

ModelObject

processDependency

public AbstractDependencyExtensibilityDirective.ProcessedDependency processDependency(String src)

Examines the supplied dependency source and returns a AbstractDependencyExtensibilityDirective.ProcessedDependency instance containing the updated source (to be passed to the DependencyHandler as well as the prefix that should be added back to the updated source when outputting the source in the HTML element.

Parameters:

src - String

Returns:

ProcessedDependency

getUpdatedSrc

protected String getUpdatedSrc(AbstractDependencyExtensibilityDirective.ProcessedDependency pd)

Retrieves the modified source URL from the AbstractDependencyExtensibilityDirective.ProcessedDependency object. This method simply wraps that provided by AbstractDependencyExtensibilityDirective.ProcessedDependency but does so to allow overrides to customise behaviour.

Parameters:

pd - ProcessedDependency

Returns:

String

getToInsert

protected String getToInsert(AbstractDependencyExtensibilityDirective.ProcessedDependency pd)

Retrieves the prefix to insert of the URL from the AbstractDependencyExtensibilityDirective.ProcessedDependency object. This method simply wraps that provided by AbstractDependencyExtensibilityDirective.ProcessedDependency but does so to allow overrides to customise behaviour.

Parameters:

pd - ProcessedDependency

Returns:

String