A simple extensibility {@link org.springframework.extensions.webscripts.Container} for processing WebScripts. This extends the {@link RepositoryContainer} and - * implements the {@link HandlesExtensibility} interface to provide extensibility capabilities.
- * - * @author David Draper - */ -public class ExtensibilityContainer extends RepositoryContainer implements HandlesExtensibility -{ - private static final Log logger = LogFactory.getLog(ExtensibilityContainer.class); - - public boolean isExtensibilitySuppressed() - { - return false; - } - - /** - *Opens a new {@link ExtensibilityModel}, defers execution to the extended {@link RepositoryContainer} and - * then closes the {@link ExtensibilityModel}.
- */ - @Override - public void executeScript(WebScriptRequest scriptReq, - WebScriptResponse scriptRes, - Authenticator auth) throws IOException - { - ExtensibilityModel extModel = this.openExtensibilityModel(); - try - { - super.executeScript(scriptReq, scriptRes, auth); - } - finally - { - // It's only necessary to close the model if it's actually been used. Not all WebScripts will make use of the - // model. An example of this would be the StreamContent WebScript. It is important not to attempt to close - // an unused model since the WebScript executed may have already flushed the response if it has overridden - // the default .execute() method. - if (this.modelUsed.get()) - { - try - { - this.closeExtensibilityModel(extModel, scriptRes.getWriter()); - } - catch (IOException e) - { - logger.error("An error occurred getting the Writer when closing an ExtensibilityModel", e); - } - } - } - } - - /** - *This keeps track of whether or not the {@link ExtensibilityModel} for the current thread has been used. The
- * thread local value will only be set to true if the getCurrentExtensibilityModel method
- * is called.
A {@link WebScriptExtensibilityModuleHandler} is required for retrieving information on what - * {@link BasicExtensionModule} instances have been configured and the extension files that need - * to be processed. This variable should be set thorugh the Spring application context configuration.
- */ - private WebScriptExtensibilityModuleHandler extensibilityModuleHandler = null; - - /** - *Sets the {@link WebScriptExtensibilityModuleHandler} for this {@link org.springframework.extensions.webscripts.Container}.
- * @param extensibilityModuleHandler WebScriptExtensibilityModuleHandler - */ - public void setExtensibilityModuleHandler(WebScriptExtensibilityModuleHandler extensibilityModuleHandler) - { - this.extensibilityModuleHandler = extensibilityModuleHandler; - } - - /** - *Maintains a list of all the {@link ExtensibilityModel} instances being used across all the - * available threads.
- */ - private ThreadLocalCreates a new {@link ExtensibilityModel} and sets it on the current thread
- */
- public ExtensibilityModel openExtensibilityModel()
- {
- if (logger.isDebugEnabled())
- {
- logger.debug("Opening for thread: " + Thread.currentThread().getName());
- }
- this.extendedBundleCache.set(new HashMap Flushes the {@link ExtensibilityModel} provided and sets its parent as the current {@link ExtensibilityModel}
- * for the current thread.
- */
- public void closeExtensibilityModel(ExtensibilityModel model, Writer out)
- {
- if (logger.isDebugEnabled())
- {
- logger.debug("Closing for thread: " + Thread.currentThread().getName());
- }
-
- model.flushModel(out);
- this.modelUsed.set(Boolean.FALSE);
- this.extensibilityModel.set(null);
- }
-
- /**
- * Returns the {@link ExtensibilityModel} for the current thread. This method is implemented to perform no action as it is not necessary for a standalone WebScript
- * container to add dependencies for processing. A thread-safe cache of extended {@link ResourceBundle} instances for the current request. Checks the cache to see if it has cached an extended bundle (that is a basic {@link 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. Adds a new extended bundle to the cache. An extended bundle is a WebScript {@link ResourceBundle} that has had
- * {@link 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. A {@link ThreadLocal} reference to the file currently being processed in the model.
- */
- private ThreadLocal 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. 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. Retrieves an files for the evaluated modules that are extending the WebScript files being processed. The list of {@link org.springframework.extensions.surf.types.ExtensionModule} instances that have been evaluated as applicable to
- * this RequestContext. This is set to Retrieve the list of {@link org.springframework.extensions.surf.types.ExtensionModule} instances that have been evaluated as applicable
- * for the current request. If this list has not yet been populated then use the {@link org.springframework.extensions.surf.extensibility.ExtensibilityModuleHandler}
- * configured in the Spring application context to evaluate them. This is a local {@link ConfigImpl} instance that will only be used when extension modules are employed. It will
- * initially be populated with the default "static" global configuration taken from the {@link ConfigService} associated
- * with this {@link org.springframework.extensions.surf.RequestContext} but then updated to include global configuration provided by extension modules that
- * have been evaluated to be applied to the current request. This map represents {@link ConfigSection} instances mapped by area. It will only be used when extension modules are
- * employed. It will initially be populated with the default "static" configuration taken from the {@link ConfigService} associated
- * with this {@link org.springframework.extensions.surf.RequestContext} but then updated to include configuration provided by extension modules that have been evaluated
- * to be applied to the current request. A list of {@link ConfigSection} instances that are only applicable to the current request. It will only be used when extension modules are
- * employed. It will initially be populated with the default "static" configuration taken from the {@link ConfigService} associated
- * with this {@link org.springframework.extensions.surf.RequestContext} but then updated to include configuration provided by extension modules that have been evaluated
- * to be applied to the current request. Creates a new {@link 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 {@link ExtendedScriptConfigModel} instance will always be created as the the supplied Creates a new {@link 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 {@link TemplateConfigModel} instance will always be created as the the supplied Creates and populates the request specific configuration container objects ( Adds the <{@code}@markup> directive to the container which allows FreeMarker templates to be extended. A simple extensibility {@link org.springframework.extensions.webscripts.Container} for processing WebScripts. This extends the {@link RepositoryContainer} and
+
+ * implements the {@link HandlesExtensibility} interface to provide extensibility capabilities. Opens a new {@link ExtensibilityModel}, defers execution to the extended {@link RepositoryContainer} and
+
+ * then closes the {@link ExtensibilityModel}. This keeps track of whether or not the {@link ExtensibilityModel} for the current thread has been used. The
+
+ * thread local value will only be set to A {@link WebScriptExtensibilityModuleHandler} is required for retrieving information on what
+
+ * {@link BasicExtensionModule} instances have been configured and the extension files that need
+
+ * to be processed. This variable should be set thorugh the Spring application context configuration. Sets the {@link WebScriptExtensibilityModuleHandler} for this {@link org.springframework.extensions.webscripts.Container}. Maintains a list of all the {@link ExtensibilityModel} instances being used across all the
+
+ * available threads. Creates a new {@link ExtensibilityModel} and sets it on the current thread Flushes the {@link ExtensibilityModel} provided and sets its parent as the current {@link ExtensibilityModel}
+
+ * for the current thread. Returns the {@link ExtensibilityModel} for the current thread. This method is implemented to perform no action as it is not necessary for a standalone WebScript
+
+ * container to add dependencies for processing. A thread-safe cache of extended {@link ResourceBundle} instances for the current request. Checks the cache to see if it has cached an extended bundle (that is a basic {@link 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. Adds a new extended bundle to the cache. An extended bundle is a WebScript {@link ResourceBundle} that has had
+
+ * {@link 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. A {@link ThreadLocal} reference to the file currently being processed in the model. 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. 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. Retrieves an files for the evaluated modules that are extending the WebScript files being processed. The list of {@link org.springframework.extensions.surf.types.ExtensionModule} instances that have been evaluated as applicable to
+
+ * this RequestContext. This is set to Retrieve the list of {@link org.springframework.extensions.surf.types.ExtensionModule} instances that have been evaluated as applicable
+
+ * for the current request. If this list has not yet been populated then use the {@link org.springframework.extensions.surf.extensibility.ExtensibilityModuleHandler}
+
+ * configured in the Spring application context to evaluate them. This is a local {@link ConfigImpl} instance that will only be used when extension modules are employed. It will
+
+ * initially be populated with the default "static" global configuration taken from the {@link ConfigService} associated
+
+ * with this {@link org.springframework.extensions.surf.RequestContext} but then updated to include global configuration provided by extension modules that
+
+ * have been evaluated to be applied to the current request. This map represents {@link ConfigSection} instances mapped by area. It will only be used when extension modules are
+
+ * employed. It will initially be populated with the default "static" configuration taken from the {@link ConfigService} associated
+
+ * with this {@link org.springframework.extensions.surf.RequestContext} but then updated to include configuration provided by extension modules that have been evaluated
+
+ * to be applied to the current request. A list of {@link ConfigSection} instances that are only applicable to the current request. It will only be used when extension modules are
+
+ * employed. It will initially be populated with the default "static" configuration taken from the {@link ConfigService} associated
+
+ * with this {@link org.springframework.extensions.surf.RequestContext} but then updated to include configuration provided by extension modules that have been evaluated
+
+ * to be applied to the current request. Creates a new {@link 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 {@link ExtendedScriptConfigModel} instance will always be created as the the supplied Creates a new {@link 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 {@link TemplateConfigModel} instance will always be created as the the supplied Creates and populates the request specific configuration container objects ( Adds the <{@code}@markup> directive to the container which allows FreeMarker templates to be extended.null if the bundle has not previously been cached.
- */
- public ResourceBundle getCachedExtendedBundle(String webScriptId)
- {
- ResourceBundle cachedExtendedBundle = null;
- Mapnull when during instantiation and is only
- * properly set the first time the getEvaluatedModules method is invoked. This ensures
- * that module evaluation only occurs once per request.xmlConfig
- * string could be different for each call (because each WebScript invoked in the request will supply different
- * configuration.xmlConfig
- * string could be different for each call (because each WebScript invoked in the request will supply different
- * configuration.globalConfig, sectionsByArea &
- * sections with a combination of the default static configuration (taken from files accessed by the {@link ConfigService}) and
- * dynamic configuration taken from extension modules evaluated for the current request. true if the getCurrentExtensibilityModel method
+
+ * is called.null if the bundle has not previously been cached.
+
+ */
+
+ public ResourceBundle getCachedExtendedBundle(String webScriptId)
+
+ {
+
+ ResourceBundle cachedExtendedBundle = null;
+
+ Mapnull when during instantiation and is only
+
+ * properly set the first time the getEvaluatedModules method is invoked. This ensures
+
+ * that module evaluation only occurs once per request.xmlConfig
+
+ * string could be different for each call (because each WebScript invoked in the request will supply different
+
+ * configuration.xmlConfig
+
+ * string could be different for each call (because each WebScript invoked in the request will supply different
+
+ * configuration.globalConfig, sectionsByArea &
+
+ * sections with a combination of the default static configuration (taken from files accessed by the {@link ConfigService}) and
+
+ * dynamic configuration taken from extension modules evaluated for the current request.