Added spring metadata implementations

Author: janithb

src/main/java/org/audit4j/integration/spring/SpringAudit4jConfig.java

@@ -54,6 +54,8 @@ public class SpringAudit4jConfig implements InitializingBean, DisposableBean {
 
     /** The jmx. */
     private JMXConfig jmx;
+    
+    private String actorSessionAttributeName;
 
     /**
      * {@inheritDoc}
@@ -66,10 +68,20 @@ public void afterPropertiesSet() throws Exception {
         Configuration configuration = Configuration.INSTANCE;
         configuration.setLayout(layout);
         configuration.setHandlers(handlers);
-        configuration.setMetaData(metaData);
+        
         configuration.setFilters(filters);
         configuration.setCommands(commands);
         configuration.setJmx(jmx);
+        
+        if (metaData == null) {
+            if (actorSessionAttributeName == null) {
+                configuration.setMetaData(new SpringSecurityWebAuditMetaData());
+            } else {
+                configuration.setMetaData(new WebSessionAuditMetaData());
+            }
+        } else {
+            configuration.setMetaData(metaData);
+        }
         AuditManager.startWithConfiguration(configuration);
     }
 
@@ -143,4 +155,7 @@ public void setJmx(JMXConfig jmx) {
         this.jmx = jmx;
     }
 
+    public void setActorSessionAttributeName(String actorSessionAttributeName) {
+        this.actorSessionAttributeName = actorSessionAttributeName;
+    }
 }

src/main/java/org/audit4j/integration/spring/SpringSecurityWebAuditMetaData.java

@@ -0,0 +1,34 @@
+package org.audit4j.integration.spring;
+
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.core.userdetails.UserDetails;
+
+/**
+ * Default Metadata class to capture actor and origin information from spring
+ * application context using Spring security and servlet requests.
+ * 
+ * @author <a href="mailto:[email protected]">Janith Bandara</a>
+ * 
+ * @since 2.4.1
+ */
+public class SpringSecurityWebAuditMetaData extends SpringWebAuditMetadata {
+
+    /** The Constant serialVersionUID. */
+    private static final long serialVersionUID = 7243065407615627372L;
+
+    /**
+     * {@inheritDoc}
+     * 
+     * @see org.audit4j.core.MetaData#getActor()
+     * 
+     */
+    @Override
+    public String getActor() {
+        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+        if (authentication != null && authentication.getPrincipal() instanceof UserDetails) {
+            return ((UserDetails) authentication.getPrincipal()).getUsername();
+        }
+        return undefienedActorName;
+    }
+}

src/main/java/org/audit4j/integration/spring/SpringWebAuditMetadata.java

@@ -0,0 +1,61 @@
+package org.audit4j.integration.spring;
+
+import javax.servlet.ServletRequest;
+
+import org.audit4j.core.MetaData;
+import org.audit4j.core.util.annotation.Beeta;
+import org.springframework.web.context.request.RequestContextHolder;
+import org.springframework.web.context.request.ServletRequestAttributes;
+
+/**
+ * Abstraction for Spring metadata implementations.
+ * 
+ * @author <a href="mailto:[email protected]">Janith Bandara</a>
+ * @since 2.4.1
+ */
+@Beeta
+public abstract class SpringWebAuditMetadata implements MetaData {
+
+    /** default actor name for unidentified actor. */
+    String undefienedActorName = "unedentified";
+
+    /** Default name for unidentified origin. */
+    String undefienedOriginName = "unedentified";
+
+    /**
+     * {@inheritDoc}
+     * 
+     * @see org.audit4j.core.MetaData#getOrigin()
+     * 
+     */
+    @Override
+    public String getOrigin() {
+        try {
+            return ((ServletRequest) ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes())
+                    .getRequest()).getRemoteAddr();
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+        return undefienedOriginName;
+    }
+
+    /**
+     * Allows to set the undefined actor name.
+     * 
+     * @param undefinedActorName
+     *            the new undefined actor name
+     */
+    public void setUndefienedActorName(String undefinedActorName) {
+        this.undefienedActorName = undefinedActorName;
+    }
+
+    /**
+     * Allows to set the undefined origin name.
+     * 
+     * @param undefinedOriginName
+     *            the new undefined origin name
+     */
+    public void setUndefienedOriginName(String undefinedOriginName) {
+        this.undefienedOriginName = undefinedOriginName;
+    }
+}

src/main/java/org/audit4j/integration/spring/WebSessionAuditMetaData.java

@@ -0,0 +1,50 @@
+package org.audit4j.integration.spring;
+
+import org.audit4j.core.util.annotation.Beeta;
+import org.springframework.web.context.request.RequestAttributes;
+import org.springframework.web.context.request.RequestContextHolder;
+
+/**
+ * Default Metadata class to capture actor and origin information from spring
+ * application context using session attributes and servlet requests.
+ * 
+ * @author <a href="mailto:[email protected]">Janith Bandara</a>
+ * 
+ * @since 2.4.1
+ */
+@Beeta
+public class WebSessionAuditMetaData extends SpringWebAuditMetadata {
+
+    /** The Constant serialVersionUID. */
+    private static final long serialVersionUID = -8565254148203328955L;
+
+    /** default session attribute name. */
+    private String actorSessionAttribute = "userName";
+
+    /**
+     * {@inheritDoc}
+     * 
+     * @see org.audit4j.core.MetaData#getActor()
+     * 
+     */
+    @Override
+    public String getActor() {
+        String actor = (String) RequestContextHolder.currentRequestAttributes().getAttribute(actorSessionAttribute,
+                RequestAttributes.SCOPE_SESSION);
+        if (actor != null) {
+            return actor;
+        }
+        return undefienedActorName;
+    }
+
+    /**
+     * Sets the actor session attribute.
+     * 
+     * @param actorSessionAttribute
+     *            the new actor session attribute
+     */
+    public void setActorSessionAttribute(String actorSessionAttribute) {
+        this.actorSessionAttribute = actorSessionAttribute;
+    }
+
+}