move SpingWebContextInitialisation into an appropriate jar to use moa-id-lib in other Spring based web applications

4 files changed, 263 insertions, 0 deletions

diff --git a/id/server/moa-id-spring-initializer/pom.xml b/id/server/moa-id-spring-initializer/pom.xml
new file mode 100644
index 000000000..d838bbe53
--- /dev/null
+++ b/id/server/moa-id-spring-initializer/pom.xml
@@ -0,0 +1,45 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>MOA.id</groupId>
+    <artifactId>moa-id</artifactId>
+    <version>3.x</version>
+  </parent>
+  
+  <groupId>MOA.id.server</groupId>
+  <artifactId>moa-id-spring-initializer</artifactId>
+  <version>${moa-id-version}</version>
+  
+  <packaging>jar</packaging>
+	<name>MOA-ID Spring Initializer</name>
+	
+  <properties>
+		<repositoryPath>${basedir}/../../../repository</repositoryPath>
+	</properties>
+	
+	<dependencies>
+		<dependency>
+			<groupId>MOA.id.server</groupId>
+			<artifactId>moa-id-lib</artifactId>
+		</dependency>
+		
+		<dependency>
+    	<groupId>at.gv.egiz.components</groupId>
+    	<artifactId>egiz-spring-api</artifactId>
+    	<version>0.1</version>
+    </dependency>
+    
+    <dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-webmvc</artifactId>
+		</dependency>
+		
+		<dependency>
+			<groupId>javax.servlet</groupId>
+			<artifactId>javax.servlet-api</artifactId>
+			<scope>provided</scope>
+		</dependency>
+		
+		
+	</dependencies>
+</project>
\ No newline at end of file
diff --git a/id/server/moa-id-spring-initializer/src/main/java/at/gv/egovernment/moa/id/auth/MOAIDAuthSpringInitializer.java b/id/server/moa-id-spring-initializer/src/main/java/at/gv/egovernment/moa/id/auth/MOAIDAuthSpringInitializer.java
new file mode 100644
index 000000000..75e076d84
--- /dev/null
+++ b/id/server/moa-id-spring-initializer/src/main/java/at/gv/egovernment/moa/id/auth/MOAIDAuthSpringInitializer.java
@@ -0,0 +1,151 @@
+package at.gv.egovernment.moa.id.auth;
+
+import javax.servlet.ServletContext;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRegistration;
+
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
+import org.springframework.context.support.GenericApplicationContext;
+import org.springframework.web.WebApplicationInitializer;
+import org.springframework.web.context.ContextLoaderListener;
+import org.springframework.web.context.request.RequestContextListener;
+import org.springframework.web.context.support.GenericWebApplicationContext;
+import org.springframework.web.context.support.ServletContextResource;
+import org.springframework.web.servlet.DispatcherServlet;
+
+import at.gv.egiz.components.spring.api.SpringLoader;
+import at.gv.egovernment.moa.id.util.MOAIDMessageProvider;
+import at.gv.egovernment.moa.logging.Logger;
+
+/**
+ * Web application initializer
+ * 
+ * @author Paul Ivancsics
+ * @version $Id$
+ */
+public class MOAIDAuthSpringInitializer implements WebApplicationInitializer {
+
+    private String[] rootServletContexts = null;
+
+	private String[] servletContexts = null;
+
+	private String[] activeProfiles = null;
+
+	public MOAIDAuthSpringInitializer() {
+		this.rootServletContexts = null;
+		this.servletContexts = new String[] {
+				"/WEB-INF/applicationContext.xml",
+				
+		};
+		this.activeProfiles = null;
+	}
+    
+    
+	/* (non-Javadoc)
+	 * @see org.springframework.web.WebApplicationInitializer#onStartup(javax.servlet.ServletContext)
+	 */
+	@Override
+	public void onStartup(ServletContext servletContext) throws ServletException {
+		try {
+			Logger.info("=============== Loading Root Context! ===============");
+			GenericWebApplicationContext rootContext = new GenericWebApplicationContext();
+			rootContext.setServletContext(servletContext);
+
+			Logger.info("=============== Setting active profiles! ===============");
+			if (this.activeProfiles != null) {
+				for (String profile : this.activeProfiles) {
+					rootContext.getEnvironment().addActiveProfile(profile);
+				}
+			}
+
+			Logger.info("=============== Loading Local Contexts! ===============");
+			XmlBeanDefinitionReader xmlReader = new XmlBeanDefinitionReader(
+					rootContext);
+			if (rootServletContexts != null) {
+				for (String rootServletContext : rootServletContexts) {
+					Logger.debug("Loading: "+ rootServletContext);
+					xmlReader.loadBeanDefinitions(new ServletContextResource(
+							servletContext, rootServletContext));
+				}
+			}
+			// Manage the lifecycle of the root application context
+			servletContext.addListener(new ContextLoaderListener(rootContext));
+
+			// logger.debug("Beans after logAMQP in {}", rootContext);
+			// dumpBeanDefinitions(rootContext);
+
+			Logger.info("=============== Loading SPI Context! ===============");
+			// logger.debug("Startup with context {}", rootContext);
+			if (rootContext instanceof BeanDefinitionRegistry) {
+				Logger.debug("Loading EGIZ components");
+				SpringLoader
+						.loadSpringServices(rootContext);
+			} else {
+				Logger.warn("Failed to load external Spring since no BeanDefinitionRegistry");
+			}
+			
+			Logger.trace("Beans after SPI in "+ rootContext);
+			dumpBeanDefinitions(rootContext);
+
+			Logger.debug("Loading servlet config in "+ rootContext);
+			if (servletContexts != null) {
+				for (String servletContextString : servletContexts) {
+					xmlReader.loadBeanDefinitions(new ServletContextResource(
+							servletContext, servletContextString));
+				}
+			}
+			Logger.debug("Refreshing context "+ rootContext);
+			rootContext.refresh();
+
+			Logger.info("=============== Register Dispatcher Servlet! ===============");
+
+			Logger.trace("Final Beans in "+ rootContext);
+			dumpBeanDefinitions(rootContext);
+			
+			
+			Logger.info("Registering dispatcher configuration");
+			ServletRegistration.Dynamic dispatcher = servletContext.addServlet(
+					"dispatcher", new DispatcherServlet(rootContext));
+			if (dispatcher != null) {  
+				dispatcher.setLoadOnStartup(1);
+				dispatcher.addMapping("/");
+				dispatcher.setAsyncSupported(true);
+			} else {
+				Logger.error("Failed to register dispatcher server in servlet context!");
+			}
+			
+			Logger.info("=============== Register RequestContextListener! ===============");
+			servletContext.addListener(new RequestContextListener());
+
+			Logger.info("Basic Context initalisation finished --> Start MOA-ID-Auth initialisation process ...");
+			MOAIDAuthInitializer.initialize(rootContext);
+			Logger.info(MOAIDMessageProvider.getInstance().getMessage(
+					"init.00", null));			
+			Logger.info("MOA-ID-Auth initialization finished.");
+				
+						
+		} catch (Throwable e) {
+			Logger.fatal(
+					MOAIDMessageProvider.getInstance().getMessage("init.02",
+							null), e);
+			
+		}
+				
+	}
+	
+	private void dumpBeanDefinitions(GenericApplicationContext context) {
+		Logger.trace("Registered Bean in context " + context.toString());
+		
+		String[] registeredBeans = context.getBeanDefinitionNames();
+		for (String registeredBean : registeredBeans) {
+			BeanDefinition beanDefinition = context
+					.getBeanDefinition(registeredBean);
+			Logger.trace(registeredBean + " -> " + 	beanDefinition.getBeanClassName());
+			
+		}
+		
+		Logger.trace("Registered Bean in context --"+ context);
+	}
+}
diff --git a/id/server/moa-id-spring-initializer/src/main/java/at/gv/egovernment/moa/id/auth/MOAIDAuthSpringResourceProvider.java b/id/server/moa-id-spring-initializer/src/main/java/at/gv/egovernment/moa/id/auth/MOAIDAuthSpringResourceProvider.java
new file mode 100644
index 000000000..def32e144
--- /dev/null
+++ b/id/server/moa-id-spring-initializer/src/main/java/at/gv/egovernment/moa/id/auth/MOAIDAuthSpringResourceProvider.java
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2014 Federal Chancellery Austria
+ * MOA-ID has been developed in a cooperation between BRZ, the Federal
+ * Chancellery Austria - ICT staff unit, and Graz University of Technology.
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://www.osor.eu/eupl/
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ *
+ * This product combines work with different licenses. See the "NOTICE" text
+ * file for details on the various modules and licenses.
+ * The "NOTICE" text file is part of the distribution. Any derivative works
+ * that you distribute must include a readable copy of the "NOTICE" text file.
+ */
+package at.gv.egovernment.moa.id.auth;
+
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.core.io.Resource;
+
+import at.gv.egiz.components.spring.api.SpringResourceProvider;
+
+/**
+ * @author tlenz
+ *
+ */
+public class MOAIDAuthSpringResourceProvider implements SpringResourceProvider {
+
+	/* (non-Javadoc)
+	 * @see at.gv.egiz.components.spring.api.SpringResourceProvider#getResourcesToLoad()
+	 */
+	@Override
+	public Resource[] getResourcesToLoad() {
+		ClassPathResource moaidauthConfig = new ClassPathResource("/moaid.configuration.beans.xml", MOAIDAuthInitializer.class);
+		ClassPathResource configurationDBConfig = new ClassPathResource("/configuration.beans.xml", MOAIDAuthInitializer.class);
+		ClassPathResource moaIdAuthBeans = new ClassPathResource("/moaid.authentication.beans.xml", MOAIDAuthInitializer.class);					
+		
+		return new Resource[] {configurationDBConfig, moaidauthConfig, moaIdAuthBeans};	
+		
+	}
+
+	/* (non-Javadoc)
+	 * @see at.gv.egiz.components.spring.api.SpringResourceProvider#getPackagesToScan()
+	 */
+	@Override
+	public String[] getPackagesToScan() {
+		// TODO Auto-generated method stub
+		return null;
+	}
+
+	/* (non-Javadoc)
+	 * @see at.gv.egiz.components.spring.api.SpringResourceProvider#getName()
+	 */
+	@Override
+	public String getName() {
+		return "MOA-ID-Auth SpringResourceProvider";
+	}
+
+}
diff --git a/id/server/moa-id-spring-initializer/src/main/resources/META-INF/services/at.gv.egiz.components.spring.api.SpringResourceProvider b/id/server/moa-id-spring-initializer/src/main/resources/META-INF/services/at.gv.egiz.components.spring.api.SpringResourceProvider
new file mode 100644
index 000000000..caaad10ca
--- /dev/null
+++ b/id/server/moa-id-spring-initializer/src/main/resources/META-INF/services/at.gv.egiz.components.spring.api.SpringResourceProvider
@@ -0,0 +1 @@
+at.gv.egovernment.moa.id.auth.MOAIDAuthSpringResourceProvider
\ No newline at end of file