hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-17 06:53:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move DSpace Initialization Code to Share DSpaceContextListener in dspace-api. add deprecation to Existing InitServlets and remove obsolete initialization cases from web.xml.

Browse Source 
git-svn-id: http://scm.dspace.org/svn/repo/branches/dspace-1_5_x@3055 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Mark Diggory
2008-08-29 03:03:15 +00:00
parent 70023eb3dd
commit b7439f253c
12 changed files with 360 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
dspace-api/src/main/java/org/dspace/app/util/DSpaceContextListener.java
View File

@@ -40,18 +40,22 @@
package org.dspace.app.util;
import org.dspace.core.ConfigurationManager;
import org.dspace.storage.rdbms.DatabaseManager;
import org.apache.log4j.Logger;
import javax.servlet.ServletContextListener;
import javax.servlet.ServletContextEvent;
import java.beans.Introspector;
import java.net.URL;
import java.net.URLConnection;
import java.sql.Driver;
import java.sql.DriverManager;
import java.util.Enumeration;
/**
* Class to initialise / cleanup resources used by DSpace when the web application
* Class to initialize / cleanup resources used by DSpace when the web application
* is started or stopped
*/
public class DSpaceContextListener implements ServletContextListener
@@ -59,11 +63,82 @@ public class DSpaceContextListener implements ServletContextListener
private static Logger log = Logger.getLogger(DSpaceContextListener.class);
/**
* Initialise any resources required by the application
* The DSpace config parameter, this is where the path to the DSpace
* configuration file can be obtained
*/
public static final String DSPACE_CONFIG_PARAMETER = "dspace-config";
/**
* Initialize any resources required by the application
* @param event
*/
public void contextInitialized(ServletContextEvent event)
{
// On Windows, URL caches can cause problems, particularly with undeployment
// So, here we attempt to disable them if we detect that we are running on Windows
try
{
String osName = System.getProperty("os.name");
if (osName != null && osName.toLowerCase().contains("windows"))
{
URL url = new URL("http://localhost/");
URLConnection urlConn = url.openConnection();
urlConn.setDefaultUseCaches(false);
}
}
catch (Throwable t)
{
log.error(t.getMessage(), t);
// Any errors thrown in disabling the caches aren't significant to
// the normal execution of the application, so we ignore them
}
// Paths to the various config files
String dspaceConfig = null;
/**
* Stage 1
*
* Locate the dspace config
*/
// first check the local per webapp parameter, then check the global parameter.
dspaceConfig = event.getServletContext().getInitParameter(DSPACE_CONFIG_PARAMETER);
// Finaly, if no config parameter found throw an error
if (dspaceConfig == null || "".equals(dspaceConfig))
{
throw new RuntimeException(
"\n\nDSpace has failed to initialize. This has occurred because it was unable to determine \n" +
"where the dspace.cfg file is located. The path to the configuration file should be stored \n" +
"in a context variable, '"+DSPACE_CONFIG_PARAMETER+"', in the global context. \n" +
"No context variable was found in either location.\n\n");
}
/**
* Stage 2
*
* Load the dspace config. Also may load log4j configuration.
* (Please rely on ConfigurationManager or Log4j to configure logging)
*
*/
try
{
ConfigurationManager.loadConfig(dspaceConfig);
}
catch (Throwable t)
{
throw new RuntimeException(
"\n\nDSpace has failed to initialize, during stage 2. Error while attempting to read the \n" +
"DSpace configuration file (Path: '"+dspaceConfig+"'). \n" +
"This has likely occurred because either the file does not exist, or it's permissions \n" +
"are set incorrectly, or the path to the configuration file is incorrect. The path to \n" +
"the DSpace configuration file is stored in a context variable, 'dspace-config', in \n" +
"either the local servlet or global context.\n\n",t);
}
}
/**
@@ -93,7 +168,7 @@ public class DSpaceContextListener implements ServletContextListener
}
catch (Throwable e)
{
log.error("Failled to cleanup ClassLoader for webapp", e);
log.error("Failed to cleanup ClassLoader for webapp", e);
}
}
}

20
dspace-api/src/main/java/org/dspace/core/ConfigurationManager.java
View File

@@ -79,6 +79,7 @@ import org.apache.log4j.helpers.OptionConverter;
*
* @author Robert Tansley
* @author Larry Stone - Interpolated values.
* @author Mark Diggory - General Improvements to detection, logging and loading.
* @version $Revision$
*/
public class ConfigurationManager
@@ -96,6 +97,15 @@ public class ConfigurationManager
// configuration; anything greater than this is very likely to be a loop.
private final static int RECURSION_LIMIT = 9;
/**
* Identify if DSpace is properly configured
* @return boolean true if configured, false otherwise
*/
public static boolean isConfigured()
{
return properties != null;
}
/**
*
*/
@@ -800,7 +810,7 @@ public class ConfigurationManager
private static void info(String string)
{
if (!isConfigured())
if (!isLog4jConfigured())
{
System.out.println("INFO: " + string);
}
@@ -812,7 +822,7 @@ public class ConfigurationManager
private static void warn(String string)
{
if (!isConfigured())
if (!isLog4jConfigured())
{
System.out.println("WARN: " + string);
}
@@ -824,7 +834,7 @@ public class ConfigurationManager
private static void fatal(String string, Exception e)
{
if (!isConfigured())
if (!isLog4jConfigured())
{
System.out.println("FATAL: " + string);
e.printStackTrace();
@@ -837,7 +847,7 @@ public class ConfigurationManager
private static void fatal(String string)
{
if (!isConfigured())
if (!isLog4jConfigured())
{
System.out.println("FATAL: " + string);
}
@@ -851,7 +861,7 @@ public class ConfigurationManager
* Only current solution available to detect
* if log4j is truly configured.
*/
private static boolean isConfigured()
private static boolean isLog4jConfigured()
{
Enumeration en = org.apache.log4j.LogManager.getRootLogger()
.getAllAppenders();

13
dspace-jspui/dspace-jspui-api/src/main/java/org/dspace/app/webui/servlet/LoadDSpaceConfig.java
View File

@@ -49,6 +49,16 @@ import java.net.URLConnection;
* Simple servlet to load in DSpace and log4j configurations. Should always be
* started up before other servlets (use <loadOnStartup>)
*
* This class holds code to be removed in the next version of the DSpace XMLUI,
* it is now managed by a Shared Context Listener inthe dspace-api project.
*
* It is deprecated, rather than removed to maintain backward compatibility for
* local DSpace 1.5.x customized overlays.
*
* TODO: Remove in trunk
*
* @deprecated Use Servlet Context Listener provided in dspace-api (remove in >
* 1.5.x)
* @author Robert Tansley
* @version $Revision$
*/
@@ -77,11 +87,14 @@ public class LoadDSpaceConfig extends HttpServlet
// the normal execution of the application, so we ignore them
}
if(!ConfigurationManager.isConfigured())
{
// Get config parameter
String config = getServletContext().getInitParameter("dspace-config");
// Load in DSpace config
ConfigurationManager.loadConfig(config);
}
}
}

18
dspace-jspui/dspace-jspui-webapp/src/main/webapp/WEB-INF/web.xml
View File

@@ -126,24 +126,20 @@
<!-- Listener to clean up Commons-FileUpload -->
<listener>
<listener-class>org.apache.commons.fileupload.servlet.FileCleanerCleanup</listener-class>
<listener-class>
org.apache.commons.fileupload.servlet.FileCleanerCleanup
</listener-class>
</listener>
<!-- Listener to initialise / clean up the application -->
<listener>
<listener-class>org.dspace.app.util.DSpaceContextListener</listener-class>
<listener-class>
org.dspace.app.util.DSpaceContextListener
</listener-class>
</listener>
<!-- Servlets -->
<!-- DSpace configuration initialisation. This needs to be loaded before
other servlets. -->
<servlet>
<servlet-name>load-dspace-config</servlet-name>
<servlet-class>org.dspace.app.webui.servlet.LoadDSpaceConfig</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet>
<servlet-name>authorize</servlet-name>
<servlet-class>org.dspace.app.webui.servlet.admin.AuthorizeAdminServlet</servlet-class>

14
dspace-lni/dspace-lni-core/src/main/java/org/dspace/app/dav/LoadDSpaceLNIConfig.java
View File

@@ -47,18 +47,30 @@ import org.dspace.core.ConfigurationManager;
* Simple servlet to load in DSpace and log4j configurations. Should always be
* started up before other servlets (use <loadOnStartup>)
*
* This class holds code to be removed in the next version of the DSpace XMLUI,
* it is now managed by a Shared Context Listener inthe dspace-api project.
*
* It is deprecated, rather than removed to maintain backward compatibility for
* local DSpace 1.5.x customized overlays.
*
* TODO: Remove in trunk
*
* @deprecated Use Servlet Context Listener provided in dspace-api (remove in >
* 1.5.x)
* @author Robert Tansley
* @version $Revision: 1407 $
*/
public class LoadDSpaceLNIConfig extends HttpServlet
{
public void init()
{
if(!ConfigurationManager.isConfigured())
{
// Get config parameter
String config = getServletContext().getInitParameter("dspace-config");
// Load in DSpace config
ConfigurationManager.loadConfig(config);
}
}
}

18
dspace-lni/dspace-lni-webapp/src/main/webapp/WEB-INF/web.xml
View File

@@ -2,7 +2,7 @@
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
<!--
- lni-web.xml
- web.xml
-
- Version: $Revision$
-
@@ -51,18 +51,16 @@
</description>
</context-param>
<!-- Listener to initialise / clean up the application -->
<!--
Listener to initialise DSpace configuration and clean up the application
-->
<listener>
<listener-class>org.dspace.app.util.DSpaceContextListener</listener-class>
<listener-class>
org.dspace.app.util.DSpaceContextListener
</listener-class>
</listener>
<!-- DSpace configuration initialisation. This needs to be loaded before
other servlets. -->
<servlet>
<servlet-name>load-dspace-config</servlet-name>
<servlet-class>org.dspace.app.dav.LoadDSpaceLNIConfig</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<!-- Servlets -->
<servlet>
<servlet-name>LNI-DAV</servlet-name>

15
dspace-oai/dspace-oai-api/src/main/java/org/dspace/app/oai/LoadDSpaceOAIConfig.java
View File

@@ -47,18 +47,31 @@ import org.dspace.core.ConfigurationManager;
* Simple servlet to load in DSpace and log4j configurations. Should always be
* started up before other servlets (use <loadOnStartup>)
*
* This class holds code to be removed in the next version of the DSpace XMLUI,
* it is now managed by a Shared Context Listener inthe dspace-api project.
*
* It is deprecated, rather than removed to maintain backward compatibility for
* local DSpace 1.5.x customized overlays.
*
* TODO: Remove in trunk
*
* @deprecated Use Servlet Context Listener provided in dspace-api (remove in >
* 1.5.x)
*
* @author Robert Tansley
* @version $Revision: 1407 $
*/
public class LoadDSpaceOAIConfig extends HttpServlet
{
public void init()
{
if(!ConfigurationManager.isConfigured())
{
// Get config parameter
String config = getServletContext().getInitParameter("dspace-config");
// Load in DSpace config
ConfigurationManager.loadConfig(config);
}
}
}

16
dspace-oai/dspace-oai-webapp/src/main/webapp/WEB-INF/web.xml
View File

@@ -70,19 +70,15 @@
</description>
</context-param>
<!-- Listener to initialise / clean up the application -->
<!--
Listener to initialise DSpace configuration and clean up the application
-->
<listener>
<listener-class>org.dspace.app.util.DSpaceContextListener</listener-class>
<listener-class>
org.dspace.app.util.DSpaceContextListener
</listener-class>
</listener>
<!-- DSpace configuration initialisation. This needs to be loaded before
other servlets. -->
<servlet>
<servlet-name>load-dspace-config</servlet-name>
<servlet-class>org.dspace.app.oai.LoadDSpaceOAIConfig</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet>
<servlet-name>oai-handler</servlet-name>
<servlet-class>ORG.oclc.oai.server.OAIHandler</servlet-class>

17
dspace-sword/dspace-sword-api/src/main/java/org/dspace/sword/LoadDSpaceConfig.java
View File

@@ -43,21 +43,30 @@ import org.dspace.core.ConfigurationManager;
* Simple servlet to load in DSpace and log4j configurations. Should always be
* started up before other servlets (use <loadOnStartup>)
*
* This class has been duplicated into the DSpace SWORD module from its
* original home in the DSpace JSPUI, but authorship and copyright
* ownership are as dictated in this file.
* This class holds code to be removed in the next version of the DSpace XMLUI,
* it is now managed by a Shared Context Listener inthe dspace-api project.
*
* It is deprecated, rather than removed to maintain backward compatibility for
* local DSpace 1.5.x customized overlays.
*
* TODO: Remove in trunk
*
* @deprecated Use Servlet Context Listener provided in dspace-api (remove in >
* 1.5.x)
*
* @author Robert Tansley
*/
public class LoadDSpaceConfig extends HttpServlet
{
public void init()
{
if(!ConfigurationManager.isConfigured())
{
// Get config parameter
String config = getServletContext().getInitParameter("dspace-config");
// Load in DSpace config
ConfigurationManager.loadConfig(config);
}
}
}

63
dspace-sword/dspace-sword-webapp/src/main/webapp/WEB-INF/web.xml
View File

@@ -1,12 +1,44 @@
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
<!-- web.xml
- This is the web application configuration for the DSpace SWORD
- module. It is not advisable to change the contents of this
- file unless you know exactly what you are doing
<!--
- lni-web.xml
-
- Version: $Revision$
-
- Date: $Date$
-
- Copyright (c) 2002, Hewlett-Packard Company and Massachusetts
- Institute of Technology. All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are
- met:
-
- - Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
-
- - Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in the
- documentation and/or other materials provided with the distribution.
-
- - Neither the name of the Hewlett-Packard Company nor the name of the
- Massachusetts Institute of Technology nor the names of their
- contributors may be used to endorse or promote products derived from
- this software without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
- TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
- USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
- DAMAGE.
-->
<web-app>
<display-name>DSpace SWORD Server</display-name>
@@ -37,21 +69,16 @@
</description>
</context-param>
<!-- Servlets -->
<!-- Listener to initialise / clean up the application -->
<!--
Listener to initialise DSpace configuration and clean up the application
-->
<listener>
<listener-class>org.dspace.app.util.DSpaceContextListener</listener-class>
<listener-class>
org.dspace.app.util.DSpaceContextListener
</listener-class>
</listener>
<!-- DSpace configuration initialisation. This needs to be loaded before
other servlets. -->
<servlet>
<servlet-name>load-dspace-config</servlet-name>
<servlet-class>org.dspace.sword.LoadDSpaceConfig</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<!-- Servlets -->
<servlet>
<servlet-name>servicedocument</servlet-name>
<servlet-class>org.purl.sword.server.ServiceDocumentServlet</servlet-class>

49
dspace-xmlui/dspace-xmlui-api/src/main/java/org/dspace/app/xmlui/cocoon/DSpaceCocoonServlet.java
View File

@@ -75,13 +75,21 @@ public class DSpaceCocoonServlet extends CocoonServlet
*/
public static final String DSPACE_CONFIG_PARAMETER = "dspace-config";
/**
* Before this servlet will become functional replace
* This method holds code to be removed in the next version
* of the DSpace XMLUI, it is now managed by a Shared Context
* Listener inthe dspace-api project.
*
* It is deprecated, rather than removed to maintain backward
* compatibility for local DSpace 1.5.x customized overlays.
*
* TODO: Remove in trunk
*
* @deprecated Use Servlet Context Listener provided
* in dspace-api (remove in > 1.5.x)
* @throws ServletException
*/
public void init() throws ServletException
private void initDSpace() throws ServletException
{
// On Windows, URL caches can cause problems, particularly with undeployment
// So, here we attempt to disable them if we detect that we are running on Windows
@@ -104,14 +112,11 @@ public class DSpaceCocoonServlet extends CocoonServlet
// the normal execution of the application, so we ignore them
}
// Check if cocoon needs to do anything at init time?
super.init();
// Paths to the various config files
/**
* Previous stages moved to shared ServletListener available in dspace-api
*/
String dspaceConfig = null;
String log4jConfig = null;
String webappConfigPath = null;
String installedConfigPath = null;
/**
* Stage 1
@@ -143,8 +148,14 @@ public class DSpaceCocoonServlet extends CocoonServlet
*/
try
{
if(!ConfigurationManager.isConfigured())
{
// Load in DSpace config
ConfigurationManager.loadConfig(dspaceConfig);
}
}
catch (Throwable t)
{
throw new ServletException(
@@ -155,6 +166,22 @@ public class DSpaceCocoonServlet extends CocoonServlet
"the DSpace configuration file is stored in a context variable, 'dspace-config', in \n" +
"either the local servlet or global context.\n\n",t);
}
}
/**
* Before this servlet will become functional replace
*/
public void init() throws ServletException
{
this.initDSpace();
// Check if cocoon needs to do anything at init time?
super.init();
// Paths to the various config files
String webappConfigPath = null;
String installedConfigPath = null;
/**
* Stage 3

53
dspace-xmlui/dspace-xmlui-webapp/src/main/webapp/WEB-INF/web.xml
View File

@@ -2,22 +2,47 @@
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
<!--
Copyright 1999-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- lni-web.xml
-
- Version: $Revision$
-
- Date: $Date$
-
- Copyright (c) 2002, Hewlett-Packard Company and Massachusetts
- Institute of Technology. All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are
- met:
-
- - Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
-
- - Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in the
- documentation and/or other materials provided with the distribution.
-
- - Neither the name of the Hewlett-Packard Company nor the name of the
- Massachusetts Institute of Technology nor the names of their
- contributors may be used to endorse or promote products derived from
- this software without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
- TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
- USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
- DAMAGE.
-->
<web-app>
<display-name>Manakin</display-name>
<description>