org.alfresco.service

Interface Auditable

All Superinterfaces:

java.lang.annotation.Annotation

@Target(value=java.lang.annotation.ElementType.METHOD)
@Retention(value=RUNTIME)
@Documented
public interface Auditable
extends java.lang.annotation.Annotation

Annotation to defined key and parameter names for the auditing API. If this annotation is present on a public service interface it will be considered for auditing. If it is not present the method will never be audited. Note that the service name and method name can be found from the bean definition and the method invocation.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	parameters() The names of the parameters
boolean[]	recordable() All method parameters are recorded by default.
boolean	recordReturnedObject() Return object are recorded by default.

Methods inherited from interface java.lang.annotation.Annotation

annotationType, equals, hashCode, toString

Method Detail

parameters

java.lang.String[] parameters()

The names of the parameters

Returns:

a String[] of parameter names, the default is an empty array.

recordable

boolean[] recordable()

All method parameters are recorded by default. This can be used to stop a parameter being written to the audit log.

recordReturnedObject

boolean recordReturnedObject()

Return object are recorded by default. Setting this means they can never be recorded in the audit.