Tidy up:

1) Comments
2) Facebook exception handling (would of been useful yesterday)
3) Addition of Facebook.getAppFriends to javascript API (more useful than existing all friends method)
4) Fixes to Document Library sample

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

source/java/org/alfresco/web/scripts/facebook/FacebookService.java

@@ -1,3 +1,27 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
 package org.alfresco.web.scripts.facebook;
 
 import java.util.HashMap;
@@ -12,6 +36,11 @@ import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
 
+/**
+ * Facebook Service
+ * 
+ * @author davidc
+ */
 public class FacebookService
 {
     // Logger
@@ -21,17 +50,25 @@ public class FacebookService
     private Map<String, FacebookAppModel> apps = new HashMap<String, FacebookAppModel>();    
     private ReentrantReadWriteLock appsLock = new ReentrantReadWriteLock(); 
 
+    // Component dependencies
     private WebScriptRegistry registry;
     private WebScriptContext context;
     
-    
+
+    /**
+     * @param registry  Web Script Registry
+     */
     public void setRegistry(WebScriptRegistry registry)
     {
         this.registry = registry;
     }
 
-
-
+    /**
+     * Gets the application model for the given application api key
+     * 
+     * @param apiKey  api key
+     * @return  application model
+     */
     FacebookAppModel getAppModel(String apiKey)
     {
         FacebookAppModel facebookApp = null;
@@ -98,11 +135,19 @@ public class FacebookService
         }
     }
 
+    /**
+     * Gets currently known Facebook Applications
+     * 
+     * @return  map (name, application) of known applications
+     */
     public Map<String, FacebookAppModel> getAppModels()
     {
         return apps;
     }
- 
+
+    /**
+     * Reset Facebook Service
+     */
     public void reset()
     {
         appsLock.writeLock().lock();
@@ -115,4 +160,5 @@ public class FacebookService
             appsLock.writeLock().unlock();
         }
     }
+
 }