Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: REQUIRED | OPTIONAL DETAIL: ELEMENT

org.alfresco.service
Annotation Type Auditable

@Target(value=ElementType.METHOD)
@Retention(value=RetentionPolicy.RUNTIME)
@Documented
@org.alfresco.api.AlfrescoPublicApi
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

Method Summary
parameters()
          The names of the parameters
boolean[]
recordable()
          All method parameters are recorded by default.
boolean
recordReturnedObject()
          Return object are recorded by default.
Optional Element Summary
parameters
          The names of the parameters
boolean[]
recordable
          All method parameters are recorded by default.
boolean
recordReturnedObject
          Return object are recorded by default.
Method Detail
parameters
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.
Element Detail
parameters
public abstract String[] parameters
The names of the parameters
Default:
{}
Returns:
a String[] of parameter names, the default is an empty array.

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

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: REQUIRED | OPTIONAL DETAIL: ELEMENT

Copyright © 2005–2018 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.