Merge from HEAD to WCM-DEV2.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@3659 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/service/cmr/action/ActionService.java

@@ -21,6 +21,7 @@ import java.util.List;
 import java.util.Map;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 
 /**
@@ -28,6 +29,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
  * 
  * @author Roy Wetherall
  */
+@PublicService
 public interface ActionService
 {
 	/**

source/java/org/alfresco/service/cmr/admin/AdminService.java

@@ -18,12 +18,15 @@ package org.alfresco.service.cmr.admin;
 
 import java.util.List;
 
+import org.alfresco.service.PublicService;
+
 /**
  * General administration tasks and system information.
  * 
  * @since 1.2
  * @author Derek Hulley
  */
+@PublicService
 public interface AdminService
 {
 //    public List<PatchInfo> getPatches();

source/java/org/alfresco/service/cmr/audit/AuditService.java

@@ -0,0 +1,85 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.service.cmr.audit;
+
+import org.alfresco.service.NotAuditable;
+import org.alfresco.service.PublicService;
+import org.alfresco.service.cmr.repository.NodeRef;
+
+/**
+ * The public API by which applications can create audit entries.
+ * This does not affect auditing using method interceptors.
+ * The information recorded can not be confused between the two.
+ * 
+ * This API could be used by an audit action.
+ * 
+ * @author Andy Hind
+ */
+@PublicService
+public interface AuditService
+{
+
+    /**
+     * Add an application audit entry.
+     * 
+     * @param source -
+     *            a string that represents the application
+     * @param description -
+     *            the audit entry
+     */
+    @NotAuditable
+    public void audit(String source, String description);
+
+    /**
+     * 
+     * @param source -
+     *            a string that represents the application
+     * @param description -
+     *            the audit entry
+     * @param key -
+     *            a node ref to use as the key for filtering etc
+     */
+    @NotAuditable
+    public void audit(String source, String description, NodeRef key);
+
+    /**
+     * 
+     * @param source -
+     *            a string that represents the application
+     * @param description -
+     *            the audit entry
+     * @param args -
+     *            an arbitrary list of parameters
+     */
+    @NotAuditable
+    public void audit(String source, String description, Object... args);
+
+    /**
+     * 
+     * @param source -
+     *            a string that represents the application
+     * @param description -
+     *            the audit entry *
+     * @param key -
+     *            a node ref to use as the key for filtering etc
+     * @param args -
+     *            an arbitrary list of parameters
+     */
+    @NotAuditable
+    public void audit(String source, String description, NodeRef key, Object... args);
+
+}

source/java/org/alfresco/service/cmr/coci/CheckOutCheckInService.java

@@ -20,6 +20,7 @@ import java.io.Serializable;
 import java.util.Map;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
 
@@ -29,6 +30,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author Roy Wetherall
  */
+@PublicService
 public interface CheckOutCheckInService 
 {
 	/**

source/java/org/alfresco/service/cmr/dictionary/DictionaryService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.dictionary;
 import java.util.Collection;
 
 import org.alfresco.service.NotAuditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.namespace.QName;
 
 
@@ -35,6 +36,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author David Caruana
  */
+@PublicService
 public interface DictionaryService
 {
 

source/java/org/alfresco/service/cmr/lock/LockService.java

@@ -20,6 +20,7 @@ import java.util.Collection;
 import java.util.List;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.StoreRef;
 
@@ -29,6 +30,7 @@ import org.alfresco.service.cmr.repository.StoreRef;
  * 
  * @author Roy Wetherall
  */
+@PublicService
 public interface LockService
 {
    /**

source/java/org/alfresco/service/cmr/model/FileFolderService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.model;
 import java.util.List;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.ContentReader;
 import org.alfresco.service.cmr.repository.ContentWriter;
 import org.alfresco.service.cmr.repository.NodeRef;
@@ -32,6 +33,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author Derek Hulley
  */
+@PublicService
 public interface FileFolderService
 {
     /**

source/java/org/alfresco/service/cmr/repository/ContentService.java

@@ -18,6 +18,7 @@ package org.alfresco.service.cmr.repository;
 
 import org.alfresco.repo.content.transform.ContentTransformer;
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.dictionary.InvalidTypeException;
 import org.alfresco.service.namespace.QName;
 
@@ -42,6 +43,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author Derek Hulley
  */
+@PublicService
 public interface ContentService
 {
     /**

source/java/org/alfresco/service/cmr/repository/CopyService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.repository;
 import java.util.List;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.namespace.QName;
 
 /**
@@ -29,6 +30,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author Roy Wetherall
  */
+@PublicService
 public interface CopyService
 {
     /**

source/java/org/alfresco/service/cmr/repository/MimetypeService.java

@@ -21,6 +21,7 @@ import java.util.Map;
 
 import org.alfresco.error.AlfrescoRuntimeException;
 import org.alfresco.service.NotAuditable;
+import org.alfresco.service.PublicService;
 
 
 /**
@@ -29,6 +30,7 @@ import org.alfresco.service.NotAuditable;
  * @author Derek Hulley
  *
  */
+@PublicService
 public interface MimetypeService
 {
     /**

source/java/org/alfresco/service/cmr/repository/NodeService.java

@@ -22,6 +22,7 @@ import java.util.Map;
 import java.util.Set;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.dictionary.InvalidAspectException;
 import org.alfresco.service.cmr.dictionary.InvalidTypeException;
 import org.alfresco.service.namespace.QName;
@@ -32,6 +33,7 @@ import org.alfresco.service.namespace.QNamePattern;
  * 
  * @author Derek Hulley
  */
+@PublicService
 public interface NodeService
 {
     /**

source/java/org/alfresco/service/cmr/repository/ScriptService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.repository;
 import java.util.Map;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.namespace.QName;
 
 /**
@@ -36,6 +37,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author Kevin Roast
  */
+@PublicService
 public interface ScriptService
 {
     /**

source/java/org/alfresco/service/cmr/repository/TemplateNode.java

@@ -671,8 +671,7 @@ public final class TemplateNode implements Serializable
         if (this.services.getNodeService().exists(nodeRef))
         {
             return "Node Type: " + getType() + 
-                   "\nNode Properties: " + this.getProperties().toString() + 
-                   "\nNode Aspects: " + this.getAspects().toString();
+                   "\tNode Ref: " + this.nodeRef.toString();
         }
         else
         {

source/java/org/alfresco/service/cmr/repository/TemplateService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.repository;
 import java.io.Writer;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 
 /**
  * Template Service.
@@ -34,6 +35,7 @@ import org.alfresco.service.Auditable;
  * 
  * @author Kevin Roast
  */
+@PublicService
 public interface TemplateService
 {
     /**

source/java/org/alfresco/service/cmr/rule/RuleService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.rule;
 import java.util.List;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.action.Action;
 import org.alfresco.service.cmr.repository.NodeRef;
 
@@ -27,6 +28,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
  * 
  * @author Roy Wetherall
  */
+@PublicService
 public interface RuleService
 {
     /**

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

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.search;
 import java.util.Collection;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.StoreRef;
@@ -37,6 +38,7 @@ import org.alfresco.service.namespace.QName;
  * @author Andy Hind
  *
  */
+@PublicService
 public interface CategoryService
 {
     /**

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

@@ -20,6 +20,7 @@ import java.io.Serializable;
 import java.util.List;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.InvalidNodeRefException;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.Path;
@@ -38,6 +39,7 @@ import org.alfresco.service.namespace.QName;
  * @author Andy hind
  * 
  */
+@PublicService
 public interface SearchService
 {
     public static final String LANGUAGE_LUCENE = "lucene";

source/java/org/alfresco/service/cmr/security/AuthenticationService.java

@@ -20,6 +20,7 @@ import java.util.Set;
 
 import org.alfresco.repo.security.authentication.AuthenticationException;
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 
 /**
  * The authentication service defines the API for managing authentication information 
@@ -28,6 +29,7 @@ import org.alfresco.service.Auditable;
  * @author Andy Hind
  *
  */
+@PublicService
 public interface AuthenticationService
 {
     /**

source/java/org/alfresco/service/cmr/security/AuthorityService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.security;
 import java.util.Set;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 
 /**
  * The service that encapsulates authorities granted to users.
@@ -34,6 +35,7 @@ import org.alfresco.service.Auditable;
  * 
  * @author Andy Hind
  */
+@PublicService
 public interface AuthorityService
 {
     /**

source/java/org/alfresco/service/cmr/security/OwnableService.java

@@ -17,6 +17,7 @@
 package org.alfresco.service.cmr.security;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 
 /**
@@ -24,6 +25,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
  * 
  * @author Andy Hind
  */
+@PublicService
 public interface OwnableService
 {
     /**

source/java/org/alfresco/service/cmr/security/PermissionService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.security;
 import java.util.Set;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
 
@@ -29,6 +30,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author Andy Hind
  */
+@PublicService
 public interface PermissionService
 {
     public static final String ROLE_PREFIX = "ROLE_";

source/java/org/alfresco/service/cmr/security/PersonService.java

@@ -21,6 +21,7 @@ import java.util.Map;
 import java.util.Set;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
 
@@ -36,6 +37,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author Andy Hind
  */
+@PublicService
 public interface PersonService
 {
     /**

source/java/org/alfresco/service/cmr/version/VersionService.java

@@ -21,6 +21,7 @@ import java.util.Collection;
 import java.util.Map;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.AspectMissingException;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.StoreRef;
@@ -31,6 +32,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author Roy Wetherall
  */
+@PublicService
 public interface VersionService
 {
     /**

source/java/org/alfresco/service/cmr/view/ExporterService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.view;
 import java.io.OutputStream;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 
 
 /**
@@ -26,6 +27,7 @@ import org.alfresco.service.Auditable;
  * 
  * @author David Caruana
  */
+@PublicService
 public interface ExporterService
 {
     /**

source/java/org/alfresco/service/cmr/view/ImporterService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.view;
 import java.io.Reader;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 
 
 /**
@@ -27,6 +28,7 @@ import org.alfresco.service.Auditable;
  * @author David Caruana
  *
  */
+@PublicService
 public interface ImporterService
 {
 

source/java/org/alfresco/service/cmr/view/RepositoryExporterService.java

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.view;
 import java.io.File;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.StoreRef;
 
@@ -28,6 +29,7 @@ import org.alfresco.service.cmr.repository.StoreRef;
  * 
  * @author davidc
  */
+@PublicService
 public interface RepositoryExporterService
 {
 

source/java/org/alfresco/service/cmr/workflow/WorkflowService.java

@@ -21,6 +21,8 @@ import java.io.Serializable;
 import java.util.List;
 import java.util.Map;
 
+import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
 
@@ -32,6 +34,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author davidc
  */
+@PublicService
 public interface WorkflowService
 {
     //
@@ -46,6 +49,7 @@ public interface WorkflowService
      * @param  mimetype  the mimetype of the workflow definition
      * @return  workflow deployment descriptor
      */
+    @Auditable(parameters = {"engineId", "workflowDefinition", "mimetype"})
     public WorkflowDeployment deployDefinition(String engineId, InputStream workflowDefinition, String mimetype);
     
     /**
@@ -57,6 +61,7 @@ public interface WorkflowService
      * @param workflowDefinition  the content object containing the definition
      * @return  workflow deployment descriptor
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"workflowDefinition"})
     public WorkflowDeployment deployDefinition(NodeRef workflowDefinition);
 
     /**
@@ -70,6 +75,7 @@ public interface WorkflowService
      * @param  mimetype  the mimetype of the definition
      * @return  true => already deployed
      */
+    @Auditable(parameters = {"engineId", "workflowDefinition", "mimetype"})
     public boolean isDefinitionDeployed(String engineId, InputStream workflowDefinition, String mimetype);
     
     /**
@@ -79,6 +85,7 @@ public interface WorkflowService
      *  
      * @param workflowDefinitionId  the id of the definition to undeploy
      */
+    @Auditable(parameters = {"workflowDefinitionId"})
     public void undeployDefinition(String workflowDefinitionId);
 
     /**
@@ -86,6 +93,7 @@ public interface WorkflowService
      * 
      * @return  the deployed workflow definitions
      */
+    @Auditable
     public List<WorkflowDefinition> getDefinitions();
     
     /**
@@ -94,6 +102,7 @@ public interface WorkflowService
      * @param workflowDefinitionId  the workflow definition id
      * @return  the deployed workflow definition
      */
+    @Auditable(parameters = {"workflowDefinitionId"})
     public WorkflowDefinition getDefinitionById(String workflowDefinitionId);
 
     /**
@@ -117,6 +126,7 @@ public interface WorkflowService
      * @param parameters  the initial set of parameters used to populate the "Start Task" properties
      * @return  the initial workflow path
      */
+    @Auditable(parameters = {"workflowDefinitionId", "parameters"})
     public WorkflowPath startWorkflow(String workflowDefinitionId, Map<QName, Serializable> parameters);
 
     /**
@@ -126,6 +136,7 @@ public interface WorkflowService
      * @param templateDefinition  the node representing the Start Task properties
      * @return  the initial workflow path
      */
+    @Auditable(parameters = {"templateDefinition"})
     public WorkflowPath startWorkflowFromTemplate(NodeRef templateDefinition);
     
     /**
@@ -134,6 +145,7 @@ public interface WorkflowService
      * @param workflowDefinitionId  the workflow definition id
      * @return  the list of "in-fligth" workflow instances
      */
+    @Auditable(parameters = {"workflowDefinitionId"})
     public List<WorkflowInstance> getActiveWorkflows(String workflowDefinitionId);
     
     /**
@@ -142,6 +154,7 @@ public interface WorkflowService
      * @param workflowId  workflow instance id
      * @return  the list of workflow paths
      */
+    @Auditable(parameters = {"workflowId"})
     public List<WorkflowPath> getWorkflowPaths(String workflowId);
     
     /**
@@ -150,6 +163,7 @@ public interface WorkflowService
      * @param workflowId  the workflow instance to cancel
      * @return  an updated representation of the workflow instance
      */
+    @Auditable(parameters = {"workflowId"})
     public WorkflowInstance cancelWorkflow(String workflowId);
 
     /**
@@ -159,6 +173,7 @@ public interface WorkflowService
      * @param transition  the transition to follow (or null, for the default transition)
      * @return  the updated workflow path
      */
+    @Auditable(parameters = {"pathId", "transitionId"})
     public WorkflowPath signal(String pathId, String transitionId);
 
     /**
@@ -167,6 +182,7 @@ public interface WorkflowService
      * @param pathId  the path id
      * @return  the list of associated tasks
      */
+    @Auditable(parameters = {"pathId"})
     public List<WorkflowTask> getTasksForWorkflowPath(String pathId);
     
 
@@ -180,6 +196,7 @@ public interface WorkflowService
      * @param taskId  the task id
      * @return  the task
      */
+    @Auditable(parameters = {"taskId"})
     public WorkflowTask getTaskById(String taskId);
     
     /**
@@ -189,6 +206,7 @@ public interface WorkflowService
      * @param state  filter by specified workflow task state
      * @return  the list of assigned tasks
      */
+    @Auditable(parameters = {"authority", "state"})
     public List<WorkflowTask> getAssignedTasks(String authority, WorkflowTaskState state);
     
     /**
@@ -197,6 +215,7 @@ public interface WorkflowService
      * @param authority   the authority
      * @return  the list of pooled tasks
      */
+    @Auditable(parameters = {"authority"})
     public List<WorkflowTask> getPooledTasks(String authority);
     
     /**
@@ -208,6 +227,7 @@ public interface WorkflowService
      * @param remove  the map of items to dis-associate with the task (or null, if none to remove)
      * @return  the update task
      */
+    @Auditable(parameters = {"taskId", "properties", "add", "remove"})
     public WorkflowTask updateTask(String taskId, Map<QName, Serializable> properties, Map<QName, List<NodeRef>> add, Map<QName, List<NodeRef>> remove);
     
     /**
@@ -217,6 +237,7 @@ public interface WorkflowService
      * @param transition  the task transition to take on completion (or null, for the default transition)
      * @return  the updated task
      */
+    @Auditable(parameters = {"taskId", "transitionId"})
     public WorkflowTask endTask(String taskId, String transitionId);
     
     /**
@@ -227,6 +248,7 @@ public interface WorkflowService
      * @param container  (optional) a pre-created container (e.g. folder, versioned folder or layered folder)
      * @return  the workflow package
      */
+    @Auditable(key = Auditable.Key.ARG_0, parameters = {"container"})
     public NodeRef createPackage(NodeRef container);
     
 }