Revamping code

Author: janithb

pom.xml

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

src/main/java/org/audit4j/core/AnnotationTransformer.java

@@ -38,7 +38,7 @@
 public class AnnotationTransformer {
 
     /**
-     * Transform to event.
+     * Transform annotation informations to Audit Event object.
      * 
      * @param annotationEvent
      *            the annotation event

src/main/java/org/audit4j/core/AuditProcessor.java

@@ -65,7 +65,6 @@ protected void executeHandlers(AuditEvent event) {
             }
         }
         if (execute) {
-            // event.setActor(getConf().getMetaData().getActor());
             String formattedEvent = configContext.getLayout().format(event);
             for (final Handler handler : configContext.getHandlers()) {
                 handler.setAuditEvent(event);
@@ -79,6 +78,11 @@ protected void executeHandlers(AuditEvent event) {
         }
     }
 
+    /**
+     * Sets the config context.
+     *
+     * @param configContext the new config context
+     */
     public void setConfigContext(ConcurrentConfigurationContext configContext) {
         this.configContext = configContext;
     }

src/main/java/org/audit4j/core/ConcurrentConfigurationContext.java

@@ -46,6 +46,8 @@
  * </ul>
  * 
  * @author <a href="mailto:[email protected]">Janith Bandara</a>
+ * 
+ * @since 2.3.0
  */
 @ThreadSafe
 public final class ConcurrentConfigurationContext {

src/main/java/org/audit4j/core/ConfigUtil.java

@@ -49,17 +49,17 @@ private ConfigUtil() {
 
 	/**
 	 * Generate config from object.
+	 * @throws ConfigurationException 
 	 */
-	static void generateConfigFromObject() {
+	static void generateConfigFromObject() throws ConfigurationException {
 		YamlWriter writer;
 		try {
 			writer = new YamlWriter(new FileWriter("audit4j.conf.yml"));
 			writer.getConfig().setClassTag("Configuration", Configuration.class);
 			writer.write(Configuration.DEFAULT);
 			writer.close();
 		} catch (IOException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
+			throw new ConfigurationException("Configuration Exception", "CONF_002");
 		}
 	}
 

src/main/java/org/audit4j/core/TroubleshootManager.java

@@ -20,6 +20,7 @@
 
 import org.audit4j.core.dto.AuditEvent;
 import org.audit4j.core.exception.ConfigurationException;
+import org.audit4j.core.exception.InitializationException;
 import org.audit4j.core.exception.TroubleshootException;
 import org.audit4j.core.util.Log;
 
@@ -79,22 +80,15 @@ public static void troubleshootConfiguration(ConfigurationException e) {
         if (e.getId().equals("CONF_001")) {
             Log.warn("Initial confguration file not found. Creating a new configuration file - ",
                     CoreConstants.CONFIG_FILE_NAME);
-            ConfigUtil.generateConfigFromObject();
+            try {
+                ConfigUtil.generateConfigFromObject();
+            } catch (ConfigurationException e1) {
+                throw new InitializationException("Initialization Failed.! Unable to create new configuration file.");
+            }
         } else if (e.getId().equals("CONF_002")) {
             Log.error("Configuration file currupted or invalid configuration. ",
                     ErrorGuide.getGuide(ErrorGuide.CONFIG_ERROR));
             throw new TroubleshootException("Configuration error", e);
         }
     }
-
-    /**
-     * Checks if is windows.
-     * 
-     * @return true, if is windows
-     */
-    public static boolean isWindows() {
-        String os = System.getProperty("os.name");
-        return os.startsWith("Windows");
-    }
-
 }

src/main/java/org/audit4j/core/annotation/Audit.java

@@ -26,10 +26,12 @@
 
 import javax.interceptor.InterceptorBinding;
 
-
 /**
- * The Interface Audit.
- *
+ * The Audit annotation.
+ * 
+ * This annotation can be used either in class level or method level. When
+ * applying this annotation, the class or methos is marked as auditable.
+ * 
  * @author <a href="mailto:[email protected]">Janith Bandara</a>
  * 
  * @since 1.0.0
@@ -39,18 +41,18 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target(value = { ElementType.TYPE, ElementType.METHOD })
 public @interface Audit {
-	
-	/**
-	 * Action.
-	 * 
-	 * @return the string
-	 */
-	public String action() default "action";
 
-	/**
-	 * Selection.
-	 * 
-	 * @return the string
-	 */
-	public SelectionType selection() default SelectionType.ALL;
+    /**
+     * Action.
+     * 
+     * @return the string
+     */
+    public String action() default "action";
+
+    /**
+     * Selection.
+     * 
+     * @return the string
+     */
+    public SelectionType selection() default SelectionType.ALL;
 }

src/main/java/org/audit4j/core/annotation/AuditField.java

@@ -25,8 +25,11 @@
 import java.lang.annotation.Target;
 
 /**
- * The Interface AuditField.
- *
+ * The AuditField annotation.
+ * 
+ * This Annotation is used to mark parameters which will include in the audit
+ * event.
+ * 
  * @author <a href="mailto:[email protected]">Janith Bandara</a>
  * 
  * @since 1.0.0
@@ -36,10 +39,10 @@
 @Target(value = { ElementType.PARAMETER })
 public @interface AuditField {
 
-	/**
-	 * Field.
-	 * 
-	 * @return the string
-	 */
-	public String field();
+    /**
+     * Field.
+     * 
+     * @return the string
+     */
+    public String field();
 }

src/main/java/org/audit4j/core/annotation/DeIdentify.java

@@ -25,8 +25,11 @@
 import java.lang.annotation.Target;
 
 /**
- * The Interface DeIdentify.
- *
+ * The DeIdentify annotation.
+ * 
+ * This can be used to deidentify certain fields. This applies a mask for
+ * certain characters with ‘*’ charactor.
+ * 
  * @author <a href="mailto:[email protected]">Janith Bandara</a>
  * 
  * @since 2.0
@@ -36,32 +39,32 @@
 @Target(value = { ElementType.PARAMETER })
 public @interface DeIdentify {
 
-	/**
-	 * Left.
-	 *
-	 * @return the int
-	 */
-	public int left() default 0;
+    /**
+     * Left.
+     * 
+     * @return the int
+     */
+    public int left() default 0;
 
-	/**
-	 * Right.
-	 *
-	 * @return the int
-	 */
-	public int right() default 0;
+    /**
+     * Right.
+     * 
+     * @return the int
+     */
+    public int right() default 0;
 
-	/**
-	 * From left.
-	 *
-	 * @return the int
-	 */
-	public int fromLeft() default 0;
+    /**
+     * From left.
+     * 
+     * @return the int
+     */
+    public int fromLeft() default 0;
 
-	/**
-	 * From right.
-	 *
-	 * @return the int
-	 */
-	public int fromRight() default 0;
+    /**
+     * From right.
+     * 
+     * @return the int
+     */
+    public int fromRight() default 0;
 
 }

src/main/java/org/audit4j/core/annotation/IgnoreAudit.java

@@ -27,6 +27,9 @@
 /**
  * Audit Ignore Annotation.
  * 
+ * When The particular class marked for audit using @Audit annotation but
+ * specific method should not be audited, This annotation can be added.
+ * 
  * @author <a href="mailto:[email protected]">Janith Bandara</a>
  * 
  * @since 2.2.0