jee6-audit-suite

A simple suite for auditing tasks of business methods based in Java EE6.

Abstract

For the auditor, business method represents a "Process" and, in turn, business methods invoked from the "Process" are known as "Activities of the process".
The audit of a process results in the persistence of a "process instance and its related activities." Each activity is stored along with its input, output and stack trace (if exceptions occur at runtime). The input, output and stack trace are serialized to JSON and stored in binary representation.

Features:

This suite provides the following:

• Audit of business methods using simple java annotations.
• Persistence of audit data.
• A simple REST API for access to audit data.

The audit mechanism is based on JEE6 Interceptors, so this suite is intended for use in an Java EE6 compliant application server to audit business methods implemented with technologies such as EJB and CDI.

How to audit processes?

Setting the environment.

JPA Persistence Unit is required with the name "suiteAuditoriaPU" that is bound to a Datasource configured with a user who has permissions to create audit scheme (a few tables).
In the beans.xml file must be enabled Interceptor "ProcessAuditInterceptor".

Defining audit targets.

Example with EJB:

@Stateless
public class MyEJBService {

    @EJB
    MyEJBService s;
    
    @Process(name="Example Name for Process")
    @Interceptors({ProcessAuditInterceptor.class})
    public Output businessMethod(Input i) {
      //This method is a defined process but in this case is, implicitly, an activity
      s.otherBusinessMethod(i);
      
    }
    
    /*Business methods can be Process and Activity while. 
    The auditor detect the entry point of audit task to determine the role of business method*/
    @Process(name="Example Name for another Process")
    @Activity
    @Interceptors({ProcessAuditInterceptor.class})
    public void otherBusinessMethod(Input i) {
      ...
      //here, an activity of this process is called
      s.doSomething(i);
    }
    
    
    @Activity
    @Interceptors({ProcessAuditInterceptor.class})
    public Output doSomething(Input i) {
      ...
    }
}

Example with CDI:

@RequestScoped
public class MyCDIBean {
    
    @Inject
    MyEJBService s;
    
    @Process(name="Example Name for Process")
    @Interceptors({ProcessAuditInterceptor.class})
    public Output callBusinessMethod(Input i) {
      
      //This method is a defined process but in this case is an activity
      s.otherBusinessMethod(i);
      //call of process activity
      s.doSomething(i);
    } 
}

Releases:

This tool is still in development. Soon will come the first release candidate.

License

Apache v2.0