org.alfresco.service

Annotation Type Auditable

@Target(value=METHOD)
@Retention(value=RUNTIME)
@Documented
public @interface Auditable

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.

Author:

Andy Hind

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	parameters The names of the parameters
boolean[]	recordable All method parameters are recorded by default.
boolean	recordReturnedObject Return object are recorded by default.

Element Detail

parameters

public abstract String[] parameters

The names of the parameters

Returns:

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

Default:

{}

recordable

public abstract boolean[] recordable

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

Default:

{}

recordReturnedObject

public abstract boolean recordReturnedObject

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

Default:

true