Skip to content

simple interface for AuditManager #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 22, 2016
Merged

simple interface for AuditManager #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/main/java/org/audit4j/core/AuditManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
*
* @since 1.0.0
*/
public final class AuditManager {
public final class AuditManager implements IAuditManager {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like we missed getInstance returning IAuditManager?


/**
* Instantiates a new audit manager.
Expand Down Expand Up @@ -121,7 +121,7 @@ public static AuditManager getInstance() {
* @deprecated
*/
@Deprecated
public static AuditManager getConfigurationInstance(Configuration configuration) {
public static IAuditManager getConfigurationInstance(Configuration configuration) {
Context.setConfig(configuration);
return getInstance();
}
Expand All @@ -138,7 +138,7 @@ public static AuditManager getConfigurationInstance(Configuration configuration)
* @since 2.3.0
*/
@Deprecated
public static AuditManager initWithConfiguration(Configuration configuration) {
public static IAuditManager initWithConfiguration(Configuration configuration) {
Context.setConfig(configuration);
return getInstance();
}
Expand All @@ -154,7 +154,7 @@ public static AuditManager initWithConfiguration(Configuration configuration) {
*
* @since 2.3.1
*/
public static AuditManager startWithConfiguration(Configuration configuration) {
public static IAuditManager startWithConfiguration(Configuration configuration) {
Context.setConfig(configuration);
return getInstance();
}
Expand All @@ -171,7 +171,7 @@ public static AuditManager startWithConfiguration(Configuration configuration) {
* @return the audit manager
* @since 2.3.1
*/
public static AuditManager startWithConfiguration(String configFilePath) {
public static IAuditManager startWithConfiguration(String configFilePath) {
Context.setConfigFilePath(configFilePath);
return getInstance();
}
Expand Down
62 changes: 62 additions & 0 deletions src/main/java/org/audit4j/core/IAuditManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
package org.audit4j.core;

import org.audit4j.core.dto.AnnotationAuditEvent;
import org.audit4j.core.dto.AuditEvent;

import java.lang.reflect.Method;

/**
* IAuditManager. This interface describes actions available for AuditManager
* implementations.
*
* @since ?.?.?
*/
public interface IAuditManager {

/**
* Audit.
*
* @param event
* the event
* @return true, if successful
*/
boolean audit(AuditEvent event);

/**
* Audit with annotation.
*
* @param clazz
* the clazz
* @param method
* the method
* @param args
* the args
* @return true, if successful
*
*/
boolean audit(Class<?> clazz, Method method, Object[] args);

/**
* Audit.
*
* @param annotationEvent
* the annotation event
* @return true, if successful
*/
boolean audit(AnnotationAuditEvent annotationEvent);

// /**
// * Enable.
// */
// void enable();
//
// /**
// * Disable.
// */
// void disable();
//
// /**
// * Shutdown.
// */
// void shutdown();
}
5 changes: 3 additions & 2 deletions src/test/java/org/audit4j/core/Int/event/annotation/ClassAnnotationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import org.audit4j.core.AuditManager;
import org.audit4j.core.Configuration;
import org.audit4j.core.IAuditManager;
import org.audit4j.core.Mock.ClassAnnotationMock;
import org.audit4j.core.Mock.TestSuperObjectMock;
import org.audit4j.core.dto.AnnotationAuditEvent;
Expand All @@ -20,7 +21,7 @@ public void setup() {

@Test
public void testAnnotation_selection_all() {
AuditManager manager = AuditManager.startWithConfiguration(Configuration.DEFAULT);
IAuditManager manager = AuditManager.startWithConfiguration(Configuration.DEFAULT);
Method annoMethod = null;
try {
annoMethod = ClassAnnotationMock.class.getMethod("testClassAnnotation_selection_all", String.class);
Expand All @@ -39,7 +40,7 @@ public void testAnnotation_selection_all() {

@Test
public void testAnnotation_complex() {
AuditManager manager = AuditManager.startWithConfiguration(Configuration.DEFAULT);
IAuditManager manager = AuditManager.startWithConfiguration(Configuration.DEFAULT);
Method annoMethod = null;
try {
annoMethod = ClassAnnotationMock.class.getMethod("testClassAnnotation_Complex", String.class,
Expand Down
7 changes: 4 additions & 3 deletions src/test/java/org/audit4j/core/Int/event/annotation/DeIdentifyAnnotationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import java.lang.reflect.Method;

import org.audit4j.core.AuditManager;
import org.audit4j.core.IAuditManager;
import org.audit4j.core.Mock.MethodAnnotationMock;
import org.junit.After;
import org.junit.Before;
Expand All @@ -17,7 +18,7 @@ public void setup() {

@Test
public void testAnnotation_selection_marked_deidentify() {
AuditManager manager = AuditManager.getInstance();
IAuditManager manager = AuditManager.getInstance();
Method annoMethod = null;
try {
annoMethod = MethodAnnotationMock.class.getMethod("testAnnotation_selection_marked_deidentify",
Expand All @@ -38,7 +39,7 @@ public void testAnnotation_selection_marked_deidentify() {

@Test
public void testAnnotation_selection_marked_deidentify_from_left() {
AuditManager manager = AuditManager.getInstance();
IAuditManager manager = AuditManager.getInstance();
Method annoMethod = null;
try {
annoMethod = MethodAnnotationMock.class.getMethod("testAnnotation_selection_marked_deidentify_from_left",
Expand All @@ -59,7 +60,7 @@ public void testAnnotation_selection_marked_deidentify_from_left() {

@Test
public void testAnnotation_selection_marked_deidentify_from_right() {
AuditManager manager = AuditManager.getInstance();
IAuditManager manager = AuditManager.getInstance();
Method annoMethod = null;
try {
annoMethod = MethodAnnotationMock.class.getMethod("testAnnotation_selection_marked_deidentify_from_right",
Expand Down
3 changes: 2 additions & 1 deletion src/test/java/org/audit4j/core/Int/event/annotation/IgnoreAuditAnnotationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import java.lang.reflect.Method;

import org.audit4j.core.AuditManager;
import org.audit4j.core.IAuditManager;
import org.audit4j.core.Mock.ClassAnnotationMock;
import org.audit4j.core.util.Log;
import org.audit4j.core.util.StopWatch;
Expand All @@ -19,7 +20,7 @@ public void setup() {

@Test
public void testIgnoreAuditAnnotation() {
AuditManager manager = AuditManager.getInstance();
IAuditManager manager = AuditManager.getInstance();
Method annoMethod = null;
try {
annoMethod = ClassAnnotationMock.class.getMethod("testClassAnnotation_Ignore", String.class);
Expand Down
5 changes: 3 additions & 2 deletions src/test/java/org/audit4j/core/Int/filter/AuditEventFilterIntTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import org.audit4j.core.AuditManager;
import org.audit4j.core.Configuration;
import org.audit4j.core.IAuditManager;
import org.audit4j.core.Int.IntTestBase;
import org.audit4j.core.Mock.AuditEventFilterMock;
import org.audit4j.core.dto.AuditEvent;
Expand All @@ -21,7 +22,7 @@ public void before() {

@Test
public void testFilter_filter() throws InterruptedException {
AuditManager manager = AuditManager.getInstance();
IAuditManager manager = AuditManager.getInstance();
AuditEvent event = getSampleAuditEvent();
event.setAction("Filter");
manager.audit(event);
Expand All @@ -31,7 +32,7 @@ public void testFilter_filter() throws InterruptedException {

@Test
public void testFilter_not_filter() throws InterruptedException {
AuditManager manager = AuditManager.getInstance();
IAuditManager manager = AuditManager.getInstance();
AuditEvent event = getSampleAuditEvent();
event.setAction("NOTFilter");
manager.audit(event);
Expand Down
7 changes: 4 additions & 3 deletions src/test/java/org/audit4j/core/Int/option/ScanAnnotationOptionIntTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import org.audit4j.core.AuditManager;
import org.audit4j.core.Configuration;
import org.audit4j.core.IAuditManager;
import org.audit4j.core.Int.IntTestBase;
import org.junit.After;
import org.junit.Before;
Expand All @@ -23,7 +24,7 @@ public void before() {
@Test
public void testFilter_filter_accepts() throws InterruptedException {
watchStart("testFilter_filter_accepts");
AuditManager manager = AuditManager.getInstance();
IAuditManager manager = AuditManager.getInstance();
boolean status = manager.audit(getSampleAnnotationEvent());
watchStop();
assertTrue(status);
Expand All @@ -33,7 +34,7 @@ public void testFilter_filter_accepts() throws InterruptedException {
@Test
public void testFilter_filter_denied() throws InterruptedException {
watchStart("testFilter_filter_denied");
AuditManager manager = AuditManager.getInstance();
IAuditManager manager = AuditManager.getInstance();
boolean status = manager.audit(getSampleNullAnnotationEvent());
watchStop();
// assertFalse(status);
Expand All @@ -42,6 +43,6 @@ public void testFilter_filter_denied() throws InterruptedException {

@After
public void after() {
AuditManager.getInstance().shutdown();
AuditManager.shutdown();
}
}
2 changes: 1 addition & 1 deletion src/test/java/org/audit4j/core/TroubleshootManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public void testTroubleshootEvent_Orign() {
public void testTroubleshootEvent_NULL_ACTOR_NULL_METADATA() {
Configuration config = getDefaultConfiguration();
config.setMetaData(null);
AuditManager manager = AuditManager.getConfigurationInstance(config);
IAuditManager manager = AuditManager.getConfigurationInstance(config);
AuditEvent event = getSampleAuditEvent();
// Set Actor as null
event.setActor(null);
Expand Down
5 changes: 3 additions & 2 deletions src/test/java/org/audit4j/core/smoke/SmokeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import java.util.concurrent.TimeUnit;

import org.audit4j.core.AuditManager;
import org.audit4j.core.IAuditManager;
import org.audit4j.core.dto.AuditEvent;
import org.audit4j.core.dto.EventBuilder;
import org.audit4j.core.util.Log;
Expand All @@ -23,7 +24,7 @@ public void smokeTestAuditEvent() throws InterruptedException {
watch.stop();
Log.info(watch.getTotalTime());
watch.start();
AuditManager manager = AuditManager.getInstance();
IAuditManager manager = AuditManager.getInstance();
//manager.audit(event);

watch.stop();
Expand All @@ -37,7 +38,7 @@ public void smokeTestAuditEvent() throws InterruptedException {
}

public static void main(String[] args) {
AuditManager manager = AuditManager.getInstance();
IAuditManager manager = AuditManager.getInstance();
int count = 0;
while (count < 100000) {
EventBuilder builder = new EventBuilder();
Expand Down