Package org.apereo.inspektr.audit

Class AuditTrailManagementAspect

java.lang.Object

org.apereo.inspektr.audit.AuditTrailManagementAspect

public class AuditTrailManagementAspect
extends java.lang.Object

A POJO style aspect modularizing management of an audit trail data concern.

Since:

1.0

Author:

Dmitriy Kopylenko, Scott Battaglia

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditTrailManager.AuditFormats	auditFormat

Constructor Summary

Constructors

Constructor	Description
AuditTrailManagementAspect(java.lang.String applicationCode, org.apereo.inspektr.common.spi.PrincipalResolver defaultAuditPrincipalResolver, java.util.List<AuditTrailManager> auditTrailManagers, java.util.Map<java.lang.String,AuditActionResolver> auditActionResolverMap, java.util.Map<java.lang.String,AuditResourceResolver> auditResourceResolverMap)
AuditTrailManagementAspect(java.lang.String applicationCode, org.apereo.inspektr.common.spi.PrincipalResolver defaultAuditPrincipalResolver, java.util.List<AuditTrailManager> auditTrailManagers, java.util.Map<java.lang.String,AuditActionResolver> auditActionResolverMap, java.util.Map<java.lang.String,AuditResourceResolver> auditResourceResolverMap, java.util.Map<java.lang.String,org.apereo.inspektr.common.spi.PrincipalResolver> auditPrincipalResolvers, AuditTrailManager.AuditFormats auditFormat)	Constructs an AuditTrailManagementAspect with the following parameters.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	handleAuditTrail(org.aspectj.lang.ProceedingJoinPoint joinPoint, Audit audit)
java.lang.Object	handleAuditTrail(org.aspectj.lang.ProceedingJoinPoint joinPoint, Audits audits)
void	setClientInfoResolver(org.apereo.inspektr.common.spi.ClientInfoResolver factory)
void	setEnabled(boolean enabled)
void	setFailOnAuditFailures(boolean failOnAuditFailures)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auditFormat

protected AuditTrailManager.AuditFormats auditFormat

Constructor Detail

AuditTrailManagementAspect

public AuditTrailManagementAspect(java.lang.String applicationCode,
                                  org.apereo.inspektr.common.spi.PrincipalResolver defaultAuditPrincipalResolver,
                                  java.util.List<AuditTrailManager> auditTrailManagers,
                                  java.util.Map<java.lang.String,AuditActionResolver> auditActionResolverMap,
                                  java.util.Map<java.lang.String,AuditResourceResolver> auditResourceResolverMap)

AuditTrailManagementAspect

public AuditTrailManagementAspect(java.lang.String applicationCode,
                                  org.apereo.inspektr.common.spi.PrincipalResolver defaultAuditPrincipalResolver,
                                  java.util.List<AuditTrailManager> auditTrailManagers,
                                  java.util.Map<java.lang.String,AuditActionResolver> auditActionResolverMap,
                                  java.util.Map<java.lang.String,AuditResourceResolver> auditResourceResolverMap,
                                  java.util.Map<java.lang.String,org.apereo.inspektr.common.spi.PrincipalResolver> auditPrincipalResolvers,
                                  AuditTrailManager.AuditFormats auditFormat)

Constructs an AuditTrailManagementAspect with the following parameters. Also, registers some default AuditActionResolvers including the DefaultAuditActionResolver, the BooleanAuditActionResolver and the ObjectCreationAuditActionResolver.

Parameters:

applicationCode - the overall code that identifies this application.

defaultAuditPrincipalResolver - the default audit principal resolver

auditTrailManagers - the list of managers to write the audit trail out to.

auditActionResolverMap - the map of resolvers by name provided in the annotation on the method.

auditResourceResolverMap - the map of resolvers by the name provided in the annotation on the method.

auditPrincipalResolvers - the map of resolvers by name provided in the annotation on the method.

auditFormat - the audit format

Method Detail

handleAuditTrail

public java.lang.Object handleAuditTrail(org.aspectj.lang.ProceedingJoinPoint joinPoint,
                                         Audits audits)
                                  throws java.lang.Throwable

Throws:

java.lang.Throwable

handleAuditTrail

public java.lang.Object handleAuditTrail(org.aspectj.lang.ProceedingJoinPoint joinPoint,
                                         Audit audit)
                                  throws java.lang.Throwable

Throws:

java.lang.Throwable

setFailOnAuditFailures

public void setFailOnAuditFailures(boolean failOnAuditFailures)

setClientInfoResolver

public void setClientInfoResolver(org.apereo.inspektr.common.spi.ClientInfoResolver factory)

setEnabled

public void setEnabled(boolean enabled)