added servlet lister to process configurations in we application scope

Author: janithb

pom.xml

@@ -83,6 +83,12 @@
 			<version>1.2</version>
 			<scope>provided</scope>
 		</dependency>
+		<dependency>
+			<groupId>javax.servlet</groupId>
+			<artifactId>servlet-api</artifactId>
+			<version>2.5</version>
+			<scope>provided</scope>
+		</dependency>
 	</dependencies>
 
 

src/main/java/org/audit4j/core/web/AuditContextListener.java

@@ -0,0 +1,62 @@
+package org.audit4j.core.web;
+
+import javax.servlet.ServletContext;
+import javax.servlet.ServletContextEvent;
+import javax.servlet.ServletContextListener;
+
+import org.audit4j.core.AuditManager;
+
+/**
+ * The listener interface for receiving auditContext events. The class that is
+ * interested in processing a auditContext event implements this interface, and
+ * the object created with that class is registered with a component using the
+ * component's <code>addAuditContextListener<code> method. When
+ * the auditContext event occurs, that object's appropriate
+ * method is invoked.
+ * 
+ * @see AuditContextEvent
+ */
+public class AuditContextListener implements ServletContextListener {
+
+    /** The config support. */
+    private ServletContexConfigSupport configSupport = null;
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * javax.servlet.ServletContextListener#contextInitialized(javax.servlet
+     * .ServletContextEvent)
+     */
+    @Override
+    public void contextInitialized(ServletContextEvent contextEvent) {
+        configSupport = new ServletContexConfigSupport();
+        if (configSupport.hasHandlers(contextEvent.getServletContext())) {
+            AuditManager.startWithConfiguration(configSupport.loadConfig(contextEvent.getServletContext()));
+        } else {
+            AuditManager.startWithConfiguration(getConfFilePath(contextEvent.getServletContext()));
+        }
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.
+     * ServletContextEvent)
+     */
+    @Override
+    public void contextDestroyed(ServletContextEvent contextEvent) {
+        AuditManager.getInstance().shutdown();
+    }
+
+    /**
+     * Gets the conf file path.
+     *
+     * @param context the context
+     * @return the conf file path
+     */
+    private String getConfFilePath(ServletContext context) {
+        return context.getRealPath("/WEB-INF/classes");
+    }
+
+}

src/main/java/org/audit4j/core/web/ContextConfigParams.java

@@ -0,0 +1,27 @@
+package org.audit4j.core.web;
+
+/**
+ * The Class ContextConfigParams.
+ *
+ * @author <a href="mailto:[email protected]">Janith Bandara</a>
+ */
+class ContextConfigParams {
+
+    /** The Constant PARAM_HANDLERS. */
+    static final String PARAM_HANDLERS = "handlers";
+    
+    /** The Constant PARAM_LAYOUT. */
+    static final String PARAM_LAYOUT = "layout";
+    
+    /** The Constant PARAM_FILTERS. */
+    static final String PARAM_FILTERS = "filters";
+    
+    /** The Constant PARAM_OPTIONS. */
+    static final String PARAM_OPTIONS = "options";
+    
+    /** The Constant PARAM_META_DATA. */
+    static final String PARAM_META_DATA = "metaData";
+    
+    /** The Constant PARAM_PROPERTIES. */
+    static final String PARAM_PROPERTIES = "properties";
+}

src/main/java/org/audit4j/core/web/ServletContexConfigSupport.java

@@ -0,0 +1,63 @@
+package org.audit4j.core.web;
+
+import javax.servlet.ServletContext;
+
+import org.audit4j.core.Configuration;
+import org.audit4j.core.MetaData;
+import org.audit4j.core.filter.AuditEventFilter;
+import org.audit4j.core.handler.Handler;
+import org.audit4j.core.layout.Layout;
+import org.audit4j.core.util.ReflectUtil;
+
+/**
+ * The Class ServletContexConfigSupport.
+ * 
+ * @author <a href="mailto:[email protected]">Janith Bandara</a>
+ */
+class ServletContexConfigSupport {
+
+    /**
+     * Load config.
+     * 
+     * @param servletContext
+     *            the servlet context
+     * @return the configuration
+     */
+    Configuration loadConfig(ServletContext servletContext) {
+        String handlers = servletContext.getInitParameter(ContextConfigParams.PARAM_HANDLERS);
+        String layout = servletContext.getInitParameter(ContextConfigParams.PARAM_LAYOUT);
+        String filters = servletContext.getInitParameter(ContextConfigParams.PARAM_FILTERS);
+        String options = servletContext.getInitParameter(ContextConfigParams.PARAM_OPTIONS);
+        String metaData = servletContext.getInitParameter(ContextConfigParams.PARAM_META_DATA);
+        String properties = servletContext.getInitParameter(ContextConfigParams.PARAM_PROPERTIES);
+
+        Configuration config = Configuration.INSTANCE;
+        config.setHandlers(new ReflectUtil<Handler>().getNewInstanceList(handlers.split(";")));
+        config.setLayout(new ReflectUtil<Layout>().getNewInstance(layout));
+        config.setFilters(new ReflectUtil<AuditEventFilter>().getNewInstanceList(filters.split(";")));
+        config.setOptions(options);
+        config.setMetaData(new ReflectUtil<MetaData>().getNewInstance(metaData));
+        String[] propertiesList = properties.split(";");
+        for (String property : propertiesList) {
+            String[] keyValue = property.split(":");
+            config.addProperty(keyValue[0], keyValue[1]);
+        }
+        return config;
+    }
+
+    /**
+     * Checks for handlers.
+     * 
+     * @param servletContext
+     *            the servlet context
+     * @return true, if successful
+     */
+    boolean hasHandlers(ServletContext servletContext) {
+        String handlers = servletContext.getInitParameter("handlers");
+        if (handlers == null || handlers.equals("")) {
+            return false;
+        } else {
+            return true;
+        }
+    }
+}

src/test/java/org/audit4j/core/web/ServletContextConfigSupportTest.java

@@ -0,0 +1,30 @@
+package org.audit4j.core.web;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import javax.servlet.ServletContext;
+
+import org.audit4j.core.Configuration;
+import org.junit.Assert;
+import org.junit.Test;
+
+public class ServletContextConfigSupportTest {
+
+    @Test
+    public void testLoadConfig() {
+        ServletContext context = mock(ServletContext.class);
+        when(context.getInitParameter(ContextConfigParams.PARAM_HANDLERS)).thenReturn("org.audit4j.core.handler.ConsoleAuditHandler;org.audit4j.core.handler.file.FileAuditHandler;");
+        //when(context.getInitParameter(ContextConfigParams.PARAM_FILTERS)).thenReturn("");
+        when(context.getInitParameter(ContextConfigParams.PARAM_LAYOUT)).thenReturn("org.audit4j.core.layout.SimpleLayout");
+        //when(context.getInitParameter(ContextConfigParams.PARAM_OPTIONS)).thenReturn("");
+        when(context.getInitParameter(ContextConfigParams.PARAM_META_DATA)).thenReturn("org.audit4j.core.DummyMetaData");
+        when(context.getInitParameter(ContextConfigParams.PARAM_PROPERTIES)).thenReturn(" log.file.location:user.dir");
+        
+        ServletContexConfigSupport support = new ServletContexConfigSupport();
+       Assert.assertTrue(support.hasHandlers(context));
+        
+        Configuration config = support.loadConfig(context);
+        Assert.assertNotNull(config.getHandlers());
+    }
+}