From 695d8d06eb863852a14c558c815eff9ef68cde84 Mon Sep 17 00:00:00 2001
From: Mark Rogers <mark.rogers@alfresco.com>
Date: Wed, 17 Mar 2010 15:32:44 +0000
Subject: [PATCH] Annotating some of the newer Public Services with the
 PublicService annotation.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@19348 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
---
 .../service/cmr/activities/ActivityService.java        |  7 +++++++
 .../service/cmr/attributes/AttributeService.java       |  2 ++
 .../service/cmr/avm/deploy/DeploymentService.java      |  4 +++-
 .../service/cmr/invitation/InvitationService.java      |  2 ++
 .../service/cmr/rendition/RenditionService.java        |  3 +++
 .../org/alfresco/service/cmr/site/SiteService.java     |  2 ++
 .../alfresco/service/cmr/tagging/TaggingService.java   |  4 +++-
 .../alfresco/service/cmr/transfer/TransferService.java |  2 ++
 source/java/org/alfresco/service/package-info.java     | 10 ++++++++++
 source/java/org/alfresco/wcm/asset/AssetService.java   |  2 ++
 .../java/org/alfresco/wcm/sandbox/SandboxService.java  |  2 ++
 .../org/alfresco/wcm/webproject/WebProjectService.java |  2 ++
 12 files changed, 40 insertions(+), 2 deletions(-)
 create mode 100644 source/java/org/alfresco/service/package-info.java

diff --git a/source/java/org/alfresco/service/cmr/activities/ActivityService.java b/source/java/org/alfresco/service/cmr/activities/ActivityService.java
index 32e79f06df..453c3f99ce 100644
--- a/source/java/org/alfresco/service/cmr/activities/ActivityService.java
+++ b/source/java/org/alfresco/service/cmr/activities/ActivityService.java
@@ -20,6 +20,13 @@ package org.alfresco.service.cmr.activities;
 
 import java.util.List;
 
+import org.alfresco.service.PublicService;
+
+
+/**
+ * The activity service
+ */
+@PublicService
 public interface ActivityService extends ActivityPostService
 {
     /*
diff --git a/source/java/org/alfresco/service/cmr/attributes/AttributeService.java b/source/java/org/alfresco/service/cmr/attributes/AttributeService.java
index 7416cb3e5a..66c3594c0c 100644
--- a/source/java/org/alfresco/service/cmr/attributes/AttributeService.java
+++ b/source/java/org/alfresco/service/cmr/attributes/AttributeService.java
@@ -23,6 +23,7 @@ import java.util.List;
 import java.util.Map;
 
 import org.alfresco.repo.attributes.Attribute;
+import org.alfresco.service.PublicService;
 import org.alfresco.util.Pair;
 
 /**
@@ -60,6 +61,7 @@ import org.alfresco.util.Pair;
  *
  * @author britt
  */
+@PublicService
 public interface AttributeService 
 {
     /**
diff --git a/source/java/org/alfresco/service/cmr/avm/deploy/DeploymentService.java b/source/java/org/alfresco/service/cmr/avm/deploy/DeploymentService.java
index d4aef58934..15d2873e0c 100644
--- a/source/java/org/alfresco/service/cmr/avm/deploy/DeploymentService.java
+++ b/source/java/org/alfresco/service/cmr/avm/deploy/DeploymentService.java
@@ -21,13 +21,15 @@ package org.alfresco.service.cmr.avm.deploy;
 import java.util.Set;
 import java.util.List;
 
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.action.ActionService;
 import org.alfresco.util.NameMatcher;
 
 /**
- * A service to handle AVM repository to remote AVM repository deployment.
+ * A service to handle WCM AVM repository to remote AVM repository deployment.
  * @author britt
  */
+@PublicService
 public interface DeploymentService
 {
     /**
diff --git a/source/java/org/alfresco/service/cmr/invitation/InvitationService.java b/source/java/org/alfresco/service/cmr/invitation/InvitationService.java
index 93db9ec6e7..0c978d8f95 100644
--- a/source/java/org/alfresco/service/cmr/invitation/InvitationService.java
+++ b/source/java/org/alfresco/service/cmr/invitation/InvitationService.java
@@ -21,6 +21,7 @@ package org.alfresco.service.cmr.invitation;
 import java.util.List;
 
 import org.alfresco.service.Auditable;
+import org.alfresco.service.PublicService;
 
 /**
  * The invitation service provides the ability to invite
@@ -32,6 +33,7 @@ import org.alfresco.service.Auditable;
  *    
  * @author mrogers
  */
+@PublicService
 public interface InvitationService 
 {
 	/**
diff --git a/source/java/org/alfresco/service/cmr/rendition/RenditionService.java b/source/java/org/alfresco/service/cmr/rendition/RenditionService.java
index 86bffa65c9..537a040113 100644
--- a/source/java/org/alfresco/service/cmr/rendition/RenditionService.java
+++ b/source/java/org/alfresco/service/cmr/rendition/RenditionService.java
@@ -22,14 +22,17 @@ package org.alfresco.service.cmr.rendition;
 import java.util.List;
 
 import org.alfresco.repo.rendition.RenditionDefinitionPersister;
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
 
 /**
+ * The Rendition service.
  * @author Nick Smith
  * @author Neil McErlean
  */
+@PublicService
 public interface RenditionService extends RenditionDefinitionPersister
 {
     /**
diff --git a/source/java/org/alfresco/service/cmr/site/SiteService.java b/source/java/org/alfresco/service/cmr/site/SiteService.java
index e2ff3ee14d..f0ff598cc1 100644
--- a/source/java/org/alfresco/service/cmr/site/SiteService.java
+++ b/source/java/org/alfresco/service/cmr/site/SiteService.java
@@ -22,6 +22,7 @@ import java.io.Serializable;
 import java.util.List;
 import java.util.Map;
 
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
 
@@ -32,6 +33,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author Roy Wetherall
  */
+@PublicService
 public interface SiteService
 {
     /**
diff --git a/source/java/org/alfresco/service/cmr/tagging/TaggingService.java b/source/java/org/alfresco/service/cmr/tagging/TaggingService.java
index da03f7d9b7..edfe41bd0e 100644
--- a/source/java/org/alfresco/service/cmr/tagging/TaggingService.java
+++ b/source/java/org/alfresco/service/cmr/tagging/TaggingService.java
@@ -20,14 +20,16 @@ package org.alfresco.service.cmr.tagging;
 
 import java.util.List;
 
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.StoreRef;
 
 /**
- * Taggin Service Interface
+ * Tagging Service Interface
  * 
  * @author Roy Wetherall
  */
+@PublicService
 public interface TaggingService
 {
     /**
diff --git a/source/java/org/alfresco/service/cmr/transfer/TransferService.java b/source/java/org/alfresco/service/cmr/transfer/TransferService.java
index b15d8f1103..50bfffa202 100644
--- a/source/java/org/alfresco/service/cmr/transfer/TransferService.java
+++ b/source/java/org/alfresco/service/cmr/transfer/TransferService.java
@@ -22,6 +22,7 @@ package org.alfresco.service.cmr.transfer;
 import java.util.Collection;
 import java.util.Set;
 
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 
 /**
@@ -30,6 +31,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
  * 
  * @author Mark Rogers
  */
+@PublicService
 public interface TransferService
 {
 
diff --git a/source/java/org/alfresco/service/package-info.java b/source/java/org/alfresco/service/package-info.java
new file mode 100644
index 0000000000..48d6b9c7e7
--- /dev/null
+++ b/source/java/org/alfresco/service/package-info.java
@@ -0,0 +1,10 @@
+/**
+ * Provides the public facing interfaces of the Services of the Alfresco Repository.
+ * <p>
+ * The PublicService is a marker interface for those services which are intended to be 
+ * public entry points to the Alfresco Repository.   Those interfaces marked as PublicService 
+ * are audited.
+ * <p>
+ * The ServiceRegistry provides access to the Alfresco Repository Services for the cases where the spring context is not available.
+ */
+package org.alfresco.service;
diff --git a/source/java/org/alfresco/wcm/asset/AssetService.java b/source/java/org/alfresco/wcm/asset/AssetService.java
index 9170b114c2..e8df02dd9b 100644
--- a/source/java/org/alfresco/wcm/asset/AssetService.java
+++ b/source/java/org/alfresco/wcm/asset/AssetService.java
@@ -24,6 +24,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.ContentReader;
 import org.alfresco.service.cmr.repository.ContentWriter;
 import org.alfresco.service.namespace.QName;
@@ -37,6 +38,7 @@ import org.alfresco.service.namespace.QName;
  * 
  * @author janv
  */
+@PublicService
 public interface AssetService
 {
     /**
diff --git a/source/java/org/alfresco/wcm/sandbox/SandboxService.java b/source/java/org/alfresco/wcm/sandbox/SandboxService.java
index 8a1264e45a..121f32db1f 100644
--- a/source/java/org/alfresco/wcm/sandbox/SandboxService.java
+++ b/source/java/org/alfresco/wcm/sandbox/SandboxService.java
@@ -23,6 +23,7 @@ import java.util.Date;
 import java.util.List;
 import java.util.Map;
 
+import org.alfresco.service.PublicService;
 import org.alfresco.service.namespace.QName;
 import org.alfresco.wcm.asset.AssetInfo;
 
@@ -34,6 +35,7 @@ import org.alfresco.wcm.asset.AssetInfo;
  * 
  * @author janv
  */
+@PublicService
 public interface SandboxService
 {
     /**
diff --git a/source/java/org/alfresco/wcm/webproject/WebProjectService.java b/source/java/org/alfresco/wcm/webproject/WebProjectService.java
index 2fd98d81cd..cdff4f6254 100644
--- a/source/java/org/alfresco/wcm/webproject/WebProjectService.java
+++ b/source/java/org/alfresco/wcm/webproject/WebProjectService.java
@@ -21,6 +21,7 @@ package org.alfresco.wcm.webproject;
 import java.util.List;
 import java.util.Map;
 
+import org.alfresco.service.PublicService;
 import org.alfresco.service.cmr.repository.NodeRef;
 
 
@@ -31,6 +32,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
  * 
  * @author janv
  */
+@PublicService
 public interface WebProjectService
 {
     //