* The servlet accesses the content repository via a tool's ToolContentHandler - * implementation. It looks for the bean IToolContentHandler.SPRING_BEAN_NAME - * in the web based Spring context. If you do not have a ToolContentHandler - * implementation then this servlet will not work, or if you use a different - * name for the bean in the Spring context, then you should derive a new - * concrete class from the Download servlet. + * implementation. It looks for the bean that implements IToolContentHandler + * in the web based Spring context. The name of the bean is specified + * using the "toolContentHandlerBeanName" parameter in the servlet definition + * in web.xml. + * + * If you do not have a ToolContentHandler implementation then this servlet will not work. + * If you need to set up the content repository access differently to the implementation + * in the Tool Content Handler, then derive a new concrete class from the Download servlet. *
* Sample servlet definition:
* <servlet> - * <description>Instructions Download</description> - * <display-name>Instructions Download</display-name> + * <description>Noticeboard Instructions Download</description> + * <display-name>Noticeboard Instructions Download</display-name> * <servlet-name>download</servlet-name> * <servlet-class>org.lamsfoundation.lams.contentrepository.client.ToolDownload</servlet-class> + * <init-param> + * <param-name>toolContentHandlerBeanName</param-name> + * param-value>nbToolContentHandler</param-value> + * </init-param> * <load-on-startup>3</load-on-startup> * </servlet> *@@ -86,30 +95,39 @@ */ public class ToolDownload extends Download { - protected IToolContentHandler toolContentHandler = null; + /** The name of the servlet parameter used to define the implementation bean name */ + public final static String TOOL_CONTENT_HANDLER_BEAN_NAME = "toolContentHandlerBeanName"; + /* (non-Javadoc) * @see org.lamsfoundation.lams.contentrepository.client.Download#getTicket() */ public ITicket getTicket() throws RepositoryCheckedException { - getToolContentHandler(); // make sure it is set up + IToolContentHandler toolContentHandler = getToolContentHandler(); // make sure it is set up return toolContentHandler != null ? toolContentHandler.getTicket(false):null; } /* (non-Javadoc) * @see org.lamsfoundation.lams.contentrepository.client.Download#getRepositoryService() */ public IRepositoryService getRepositoryService() throws RepositoryCheckedException { - getToolContentHandler(); // make sure it is set up + IToolContentHandler toolContentHandler = getToolContentHandler(); // make sure it is set up return toolContentHandler != null? toolContentHandler.getRepositoryService() : null; } - + protected IToolContentHandler getToolContentHandler() { + log.debug("ToolDownload servlet calling context and getting repository singleton."); + + String toolContentHandlerBeanName = getInitParameter(TOOL_CONTENT_HANDLER_BEAN_NAME); + if ( toolContentHandlerBeanName == null ) { + log.error("Accessing Download servlet but tool content handler bean has not been defined. Please define init parameter" + +TOOL_CONTENT_HANDLER_BEAN_NAME+"."); + return null; + } + WebApplicationContext wac = WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext()); - toolContentHandler = (IToolContentHandler)wac.getBean(IToolContentHandler.SPRING_BEAN_NAME); - - return toolContentHandler; + return (IToolContentHandler)wac.getBean(toolContentHandlerBeanName); } Index: lams_contentrepository/test/java/org/lamsfoundation/lams/contentrepository/testApplicationContext.xml =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/test/java/org/lamsfoundation/lams/contentrepository/Attic/testApplicationContext.xml,v diff -u -r1.1 -r1.2 --- lams_contentrepository/test/java/org/lamsfoundation/lams/contentrepository/testApplicationContext.xml 20 Jul 2005 05:39:47 -0000 1.1 +++ lams_contentrepository/test/java/org/lamsfoundation/lams/contentrepository/testApplicationContext.xml 21 Nov 2005 06:55:18 -0000 1.2 @@ -2,7 +2,7 @@