Package org.springframework.extensions.webscripts

Class ExtensibilityContainer

java.lang.Object
org.springframework.extensions.webscripts.AbstractRuntimeContainer
org.springframework.extensions.webscripts.PresentationContainer
org.springframework.extensions.webscripts.ExtensibilityContainer
All Implemented Interfaces:
EventListener, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener, HandlesExtensibility, Container, RuntimeContainer
public class ExtensibilityContainer extends PresentationContainer implements HandlesExtensibility

A simple extensibility Container for processing WebScripts. This extends the PresentationContainer and implements the HandlesExtensibility interface so that a standalone WebScript runtime (i.e. one that is not used within Surf) can process extensions.

Author:
David Draper

  • Field Details

  • Constructor Details

    • ExtensibilityContainer

      public ExtensibilityContainer()

  • Method Details

    • setExtensibilityModuleHandler

      public void setExtensibilityModuleHandler(WebScriptExtensibilityModuleHandler extensibilityModuleHandler)

      Sets the WebScriptExtensibilityModuleHandler for this Container.

      Parameters:
      extensibilityModuleHandler - WebScriptExtensibilityModuleHandler

    • openExtensibilityModel

      public ExtensibilityModel openExtensibilityModel()

      Creates a new ExtensibilityModel and sets it on the current thread

      Specified by:
      openExtensibilityModel in interface HandlesExtensibility
      Returns:
      A reference to a new nested ExtensibilityModel.

    • closeExtensibilityModel

      public void closeExtensibilityModel(ExtensibilityModel model, Writer out)

      Flushes the ExtensibilityModel provided and sets its parent as the current ExtensibilityModel for the current thread.

      Specified by:
      closeExtensibilityModel in interface HandlesExtensibility
      Parameters:
      model - The model to close.
      out - The Writer to render the output of the closed model to.

    • getCurrentExtensibilityModel

      public ExtensibilityModel getCurrentExtensibilityModel()

      Returns the ExtensibilityModel for the current thread.

      Specified by:
      getCurrentExtensibilityModel in interface HandlesExtensibility
      Returns:
      ExtensibilityModel

    • updateExtendingModuleDependencies

      public void updateExtendingModuleDependencies(String pathBeingProcessed, Map<String,Object> model)

      This method is implemented to perform no action as it is not necessary for a standalone WebScript container to add dependencies for processing.

      Specified by:
      updateExtendingModuleDependencies in interface HandlesExtensibility
      Parameters:
      pathBeingProcessed - String
      model - Map<String, Object>

    • getCachedExtendedBundle

      public ResourceBundle getCachedExtendedBundle(String webScriptId)

      Checks the cache to see if it has cached an extended bundle (that is a basic ResourceBundle that has had extension modules applied to it. Extended bundles can only be safely cached once per request as the modules applied can vary for each request.

      Specified by:
      getCachedExtendedBundle in interface HandlesExtensibility
      Parameters:
      webScriptId - The id of the WebScript to retrieve the extended bundle for.
      Returns:
      A cached bundle or null if the bundle has not previously been cached.

    • addExtensionBundleToCache

      public void addExtensionBundleToCache(String webScriptId, WebScriptPropertyResourceBundle extensionBundle)

      Adds a new extended bundle to the cache. An extended bundle is a WebScript ResourceBundle that has had ResourceBundle instances merged into it from extension modules that have been applied. These can only be cached for the lifetime of the request as different modules may be applied to the same WebScript for different requests.

      Specified by:
      addExtensionBundleToCache in interface HandlesExtensibility
      Parameters:
      webScriptId - The id of the WebScript to cache the extended bundle against.
      extensionBundle - The extended bundle to cache.

    • getFileBeingProcessed

      public String getFileBeingProcessed()

      Returns the path of the file currently being processed in the model by the current thread. This information is primarily provided for the purposes of generating debug information.

      Specified by:
      getFileBeingProcessed in interface HandlesExtensibility
      Returns:
      The path of the file currently being processed.

    • setFileBeingProcessed

      public void setFileBeingProcessed(String file)

      Sets the path of the file currently being processed in the model by the current thread. This information should be collected to assist with providing debug information.

      Specified by:
      setFileBeingProcessed in interface HandlesExtensibility
      Parameters:
      file - The path of the file currently being processed.

    • getExtendingModuleFiles

      public List<String> getExtendingModuleFiles(String pathBeingProcessed)
      Description copied from interface: HandlesExtensibility

      Returns a List of the files that should be applied to an ExtensibilityModel being processed.

      Specified by:
      getExtendingModuleFiles in interface HandlesExtensibility
      Parameters:
      pathBeingProcessed - The path of the file being processed. This will typically be a FreeMarker template, JavaScript controller or NLS properties file.
      Returns:
      A List of the files that extend the current file being processed.

    • getEvaluatedModules

      public List<BasicExtensionModule> getEvaluatedModules()

      Retrieve the list of ExtensionModule instances that have been evaluated as applicable for the current request. If this list has not yet been populated then use the ExtensibilityModuleHandler configured in the Spring application context to evaluate them.

      Returns:
      A list of ExtensionModule instances that are applicable to the current request.

    • getExtendedScriptConfigModel

      public ScriptConfigModel getExtendedScriptConfigModel(String xmlConfig)

      Creates a new ExtendedScriptConfigModel instance using the local configuration generated for this request. If configuration for the request will be generated if it does not yet exist. It is likely that this method will be called multiple times within the context of a single request and although the configuration containers will always be the same a new ExtendedScriptConfigModel instance will always be created as the the supplied xmlConfig string could be different for each call (because each WebScript invoked in the request will supply different configuration.

      Specified by:
      getExtendedScriptConfigModel in interface HandlesExtensibility
      Parameters:
      xmlConfig - Optional additional XML configuration to include. This is typically provided by WebScripts.
      Returns:
      A new ExtendedScriptConfigModel or null if one could not be created.

    • getExtendedTemplateConfigModel

      public TemplateConfigModel getExtendedTemplateConfigModel(String xmlConfig)

      Creates a new TemplateConfigModel instance using the local configuration generated for this request. If configuration for the request will be generated if it does not yet exist. It is likely that this method will be called multiple times within the context of a single request and although the configuration containers will always be the same a new TemplateConfigModel instance will always be created as the the supplied xmlConfig string could be different for each call (because each WebScript invoked in the request will supply different configuration.

      Specified by:
      getExtendedTemplateConfigModel in interface HandlesExtensibility
      Parameters:
      xmlConfig - Optional additional XML configuration to include. This is typically provided by WebScripts.
      Returns:
      A new ExtendedTemplateConfigModel or null if one could not be created.

    • addExtensibilityDirectives

      public void addExtensibilityDirectives(Map<String,Object> freeMarkerModel, ExtensibilityModel extModel)
      Description copied from interface: HandlesExtensibility

      Adds any custom FreeMarker directives required for rendering templates when being processed.

      Specified by:
      addExtensibilityDirectives in interface HandlesExtensibility
      Parameters:
      freeMarkerModel - The model to add the directives to.
      extModel - The current ExtensibilityModel being worked on.

    • isExtensibilitySuppressed

      public boolean isExtensibilitySuppressed()
      Description copied from interface: HandlesExtensibility

      This indicates that although extensibility is handled it has been temporarily suppressed

      Specified by:
      isExtensibilitySuppressed in interface HandlesExtensibility
      Returns:
      boolean