First cut of audit annotations on public services, updated audit schema and first cut of default audit settings

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@3312 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/service/cmr/search/CategoryService.java

@@ -18,6 +18,7 @@ package org.alfresco.service.cmr.search;
 
 import java.util.Collection;
 
+import org.alfresco.service.Auditable;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.StoreRef;
@@ -63,6 +64,7 @@ public interface CategoryService
      * @param depth - the enumeration depth for what level to recover
      * @return a collection of all the nodes found identified by their ChildAssocRef's
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"categoryRef", "mode", "depth"})
     public Collection<ChildAssociationRef> getChildren(NodeRef categoryRef, Mode mode, Depth depth );
 
     /**
@@ -73,6 +75,7 @@ public interface CategoryService
      * @param depth - the enumeration depth for what level to recover
      * @return a collection of all the nodes found identified by their ChildAssocRef's
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"storeRef", "aspectQName", "depth"})
     public Collection<ChildAssociationRef> getCategories(StoreRef storeRef, QName aspectQName, Depth depth );
 
     /**
@@ -80,6 +83,7 @@ public interface CategoryService
      * 
      * @return
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"storeRef"})
     public Collection<ChildAssociationRef> getClassifications(StoreRef storeRef);
 
     /**
@@ -89,6 +93,7 @@ public interface CategoryService
      * @param aspectName
      * @return
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"storeRef", "aspectName"})
     public Collection<ChildAssociationRef> getRootCategories(StoreRef storeRef, QName aspectName);
     
     /**
@@ -96,6 +101,7 @@ public interface CategoryService
      * 
      * @return
      */
+    @Auditable
     public Collection<QName> getClassificationAspects();
 
     /**
@@ -107,6 +113,7 @@ public interface CategoryService
      * @param aspectName
      * @param attributeName
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"storeRef", "aspectName", "attributeName"})
     public NodeRef createClassifiction(StoreRef storeRef, QName aspectName, String attributeName);
     
     /**
@@ -117,6 +124,7 @@ public interface CategoryService
      * @param name
      * @return
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"storeRef", "aspectName", "name"})
     public NodeRef createRootCategory(StoreRef storeRef, QName aspectName, String name);
     
     /**
@@ -126,6 +134,7 @@ public interface CategoryService
      * @param name
      * @return
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"parent", "name"})
     public NodeRef createCategory(NodeRef parent, String name);
     
     /**
@@ -134,6 +143,7 @@ public interface CategoryService
      * @param storeRef
      * @param aspectName
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"storeRef", "aspectName"})
     public void deleteClassification(StoreRef storeRef, QName aspectName);
     
     /**
@@ -141,5 +151,6 @@ public interface CategoryService
      * 
      * @param nodeRef
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
     public void deleteCategory(NodeRef nodeRef);
 }

source/java/org/alfresco/service/cmr/search/SearchService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.search;
 import java.io.Serializable;
 import java.util.List;
 
+import org.alfresco.service.Auditable;
 import org.alfresco.service.cmr.repository.InvalidNodeRefException;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.Path;
@@ -62,6 +63,7 @@ public interface SearchService
      *            the value.
      * @return Returns the query results
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"store", "language", "query", "attributePaths", "queryParameterDefinitions"})
     public ResultSet query(StoreRef store, String language, String query, Path[] attributePaths,
             QueryParameterDefinition[] queryParameterDefinitions);
 
@@ -77,6 +79,7 @@ public interface SearchService
      *            the query string - which may include parameters
      * @return Returns the query results
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"store", "language", "query"})
     public ResultSet query(StoreRef store, String language, String query);
 
     /**
@@ -93,6 +96,7 @@ public interface SearchService
      *            the value.
      * @return Returns the query results
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"store", "language", "query", "queryParameterDefinitions"})
     public ResultSet query(StoreRef store, String language, String query,
             QueryParameterDefinition[] queryParameterDefintions);
 
@@ -110,6 +114,7 @@ public interface SearchService
      *            selected nodes in xpath style syntax
      * @return Returns the query results
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"store", "language", "query", "attributePaths"})
     public ResultSet query(StoreRef store, String language, String query, Path[] attributePaths);
 
     /**
@@ -123,12 +128,14 @@ public interface SearchService
      *            parameterisation for the canned query
      * @return Returns the query results
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"store", "queryId", "queryParameters"})
     public ResultSet query(StoreRef store, QName queryId, QueryParameter[] queryParameters);
 
     /**
      * Search using the given SearchParameters
      */
 
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"searchParameters"})
     public ResultSet query(SearchParameters searchParameters);
 
     /**
@@ -147,6 +154,7 @@ public interface SearchService
      *            it follows all
      * @return a list of all the child assoc relationships to the selected nodes
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"contextNodeRef", "xpath", "parameters", "namespacePrefixResolver", "followAllParentLinks"})
     public List<NodeRef> selectNodes(NodeRef contextNodeRef, String xpath, QueryParameterDefinition[] parameters,
             NamespacePrefixResolver namespacePrefixResolver, boolean followAllParentLinks)
             throws InvalidNodeRefException, XPathException;
@@ -169,6 +177,7 @@ public interface SearchService
      *            the xpath variant
      * @return a list of all the child assoc relationships to the selected nodes
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"contextNodeRef", "xpath", "parameters", "namespacePrefixResolver", "followAllParentLinks", "language"})
     public List<NodeRef> selectNodes(NodeRef contextNodeRef, String xpath, QueryParameterDefinition[] parameters,
             NamespacePrefixResolver namespacePrefixResolver, boolean followAllParentLinks, String language)
             throws InvalidNodeRefException, XPathException;
@@ -189,6 +198,7 @@ public interface SearchService
      *            it follows all
      * @return a list of property values
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"contextNodeRef", "xpath", "parameters", "namespacePrefixResolver", "followAllParentLinks"})
     public List<Serializable> selectProperties(NodeRef contextNodeRef, String xpath,
             QueryParameterDefinition[] parameters, NamespacePrefixResolver namespacePrefixResolver,
             boolean followAllParentLinks) throws InvalidNodeRefException, XPathException;
@@ -211,6 +221,7 @@ public interface SearchService
      *            the xpath variant
      * @return a list of property values
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"contextNodeRef", "xpath", "parameters", "namespacePrefixResolver", "followAllParentLinks", "language"})
     public List<Serializable> selectProperties(NodeRef contextNodeRef, String xpath,
             QueryParameterDefinition[] parameters, NamespacePrefixResolver namespacePrefixResolver,
             boolean followAllParentLinks, String language) throws InvalidNodeRefException, XPathException;
@@ -227,6 +238,7 @@ public interface SearchService
      *            a Google-like pattern to search for in the property value
      * @return Returns true if the pattern could be found - uses the default OR operator
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef", "propertyQName", "googleLikePattern"})
     public boolean contains(NodeRef nodeRef, QName propertyQName, String googleLikePattern)
             throws InvalidNodeRefException;
     
@@ -242,6 +254,7 @@ public interface SearchService
      *            a Google-like pattern to search for in the property value
      * @return Returns true if the pattern could be found
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef", "propertyQName", "googleLikePattern", "defaultOperator"})
     public boolean contains(NodeRef nodeRef, QName propertyQName, String googleLikePattern, SearchParameters.Operator defaultOperator)
             throws InvalidNodeRefException;
 
@@ -259,6 +272,7 @@ public interface SearchService
      *            include full text search matches in the like test
      * @return Returns true if the pattern could be found
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef", "propertyQName", "sqlLikePattern", "includeFTS"})
     public boolean like(NodeRef nodeRef, QName propertyQName, String sqlLikePattern, boolean includeFTS)
             throws InvalidNodeRefException;
 }