org.alfresco.repo.audit

Class AuditMethodInterceptor

java.lang.Object

org.alfresco.repo.audit.AuditMethodInterceptor

All Implemented Interfaces:

org.aopalliance.aop.Advice, org.aopalliance.intercept.Interceptor, org.aopalliance.intercept.MethodInterceptor

public class AuditMethodInterceptor
extends Object
implements org.aopalliance.intercept.MethodInterceptor

A method interceptor to wrap method invocations with auditing.

V3.2 Configuration: As of V3.2, the pre- and post-invocation values are passed to the audit component for processing. Individual applications have to extract the desired audit values. Values are audited before and after the invocation so that applications that desire to extract derived data before the invocation can have a chance to do so; generally, however, the post-invocation values will be the most useful.

The values passed to the audit component (assuming auditing is enabled and the new configuration is being used) are:

 /alfresco-api
    /pre
       /<service>
          /<method>
             /args
                /<arg-name>=<value>
                /<arg-name>=<value>
                ...
       /service
    /post
       /<service>
          /<method>
             /args
                /<arg-name>=<value>
                /<arg-name>=<value>
                ...
             /result=<value>
             /error=<value>
             /no-error=<null>
 
 

Applications can remap the paths onto their configurations as appropriate.

TODO: Audit configuration mapping needs to support conditionals

Author:

Andy Hind, Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUDIT_PATH_API_POST
static String	AUDIT_PATH_API_PRE
static String	AUDIT_PATH_API_ROOT
static String	AUDIT_SNIPPET_ARGS
static String	AUDIT_SNIPPET_ERROR
static String	AUDIT_SNIPPET_NO_ERROR
static String	AUDIT_SNIPPET_PRE_CALL_DATA
static String	AUDIT_SNIPPET_RESULT

Constructor Summary

Constructors

Constructor and Description
AuditMethodInterceptor()

Method Summary

Modifier and Type	Method and Description
Object	invoke(org.aopalliance.intercept.MethodInvocation mi)
void	setAuditComponent(AuditComponent auditComponent)
void	setBeanIdentifier(BeanIdentifier beanIdentifier)
void	setThreadPoolExecutor(ThreadPoolExecutor threadPoolExecutor)
void	setTransactionService(TransactionService transactionService)
void	setUseNewConfig(boolean useNewConfig) Use the new audit configuration (default: false)

Methods inherited from class java.lang.Object

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

Field Detail

AUDIT_PATH_API_ROOT

public static final String AUDIT_PATH_API_ROOT

See Also:

Constant Field Values

AUDIT_PATH_API_PRE

public static final String AUDIT_PATH_API_PRE

See Also:

Constant Field Values

AUDIT_PATH_API_POST

public static final String AUDIT_PATH_API_POST

See Also:

Constant Field Values

AUDIT_SNIPPET_ARGS

public static final String AUDIT_SNIPPET_ARGS

See Also:

Constant Field Values

AUDIT_SNIPPET_PRE_CALL_DATA

public static final String AUDIT_SNIPPET_PRE_CALL_DATA

See Also:

Constant Field Values

AUDIT_SNIPPET_RESULT

public static final String AUDIT_SNIPPET_RESULT

See Also:

Constant Field Values

AUDIT_SNIPPET_ERROR

public static final String AUDIT_SNIPPET_ERROR

See Also:

Constant Field Values

AUDIT_SNIPPET_NO_ERROR

public static final String AUDIT_SNIPPET_NO_ERROR

See Also:

Constant Field Values

Constructor Detail

AuditMethodInterceptor

public AuditMethodInterceptor()

Method Detail

setUseNewConfig

public void setUseNewConfig(boolean useNewConfig)

Use the new audit configuration (default: false)

Parameters:

useNewConfig - true to use the new audit configuration

setBeanIdentifier

public void setBeanIdentifier(BeanIdentifier beanIdentifier)

setAuditComponent

public void setAuditComponent(AuditComponent auditComponent)

setTransactionService

public void setTransactionService(TransactionService transactionService)

setThreadPoolExecutor

public void setThreadPoolExecutor(ThreadPoolExecutor threadPoolExecutor)

invoke

public Object invoke(org.aopalliance.intercept.MethodInvocation mi)
              throws Throwable

Specified by:

invoke in interface org.aopalliance.intercept.MethodInterceptor

Throws:

Throwable