org.alfresco.service
Interface Auditable

All Superinterfaces:
java.lang.annotation.Annotation

@Target(value=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.


Nested Class Summary
static class Auditable.Key
           
 
Method Summary
 Auditable.Key key()
          The position of the key argument in the method list.
 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.
 boolean warn()
          If a method as marked as warn, it is potentially an audit hole.
 
Methods inherited from interface java.lang.annotation.Annotation
annotationType, equals, hashCode, toString
 

Method Detail

key

Auditable.Key key()
The position of the key argument in the method list.

Returns:
-1 indicates there is no key

parameters

java.lang.String[] parameters()
The names of the parameters

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

warn

boolean warn()
If a method as marked as warn, it is potentially an audit hole. Typically a method returns an object which allows unaudited access. This is intended to mark things that appear to expose unsafe API calls.

Returns:

recordable

boolean[] recordable()
All method parameters are recorded by default. This can be used to stop a parameter being written to the audit log. It will be entered as "******".

Returns:

recordReturnedObject

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

Returns:


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.