* DB4o Storage provider is now well documented

* Added try/catch over user creation (should allow multiple logins on Db4o)

1 files changed, 54 insertions, 0 deletions

diff --git a/OpenGridServices/OpenGrid.Framework.Data.DB4o/DB4oManager.cs b/OpenGridServices/OpenGrid.Framework.Data.DB4o/DB4oManager.cs
index b30f889..408b213 100644
--- a/OpenGridServices/OpenGrid.Framework.Data.DB4o/DB4oManager.cs
+++ b/OpenGridServices/OpenGrid.Framework.Data.DB4o/DB4oManager.cs
@@ -1,3 +1,29 @@
+/*

+* Copyright (c) OpenSim project, http://sim.opensecondlife.org/

+*

+* Redistribution and use in source and binary forms, with or without

+* modification, are permitted provided that the following conditions are met:

+*     * Redistributions of source code must retain the above copyright

+*       notice, this list of conditions and the following disclaimer.

+*     * Redistributions in binary form must reproduce the above copyright

+*       notice, this list of conditions and the following disclaimer in the

+*       documentation and/or other materials provided with the distribution.

+*     * Neither the name of the <organization> nor the

+*       names of its contributors may be used to endorse or promote products

+*       derived from this software without specific prior written permission.

+*

+* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY

+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

+* DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY

+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+* 

+*/

 using System;

 using System.Collections.Generic;

 using System.Text;

@@ -7,17 +33,31 @@ using libsecondlife;
 

 namespace OpenGrid.Framework.Data.DB4o

 {

+    /// <summary>

+    /// A Database manager for Db4o

+    /// </summary>

     class DB4oGridManager

     {

+        /// <summary>

+        /// A list of the current regions connected (in-memory cache)

+        /// </summary>

         public Dictionary<LLUUID, SimProfileData> simProfiles = new Dictionary<LLUUID, SimProfileData>();

+        /// <summary>

+        /// Database File Name

+        /// </summary>

         string dbfl;

 

+        /// <summary>

+        /// Creates a new grid storage manager

+        /// </summary>

+        /// <param name="db4odb">Filename to the database file</param>

         public DB4oGridManager(string db4odb)

         {

             dbfl = db4odb;

             IObjectContainer database;

             database = Db4oFactory.OpenFile(dbfl);

             IObjectSet result = database.Get(typeof(SimProfileData));

+            // Loads the file into the in-memory cache

             foreach(SimProfileData row in result) {

                 simProfiles.Add(row.UUID, row);

             }

@@ -57,16 +97,30 @@ namespace OpenGrid.Framework.Data.DB4o
 

     }

 

+    /// <summary>

+    /// A manager for the DB4o database (user profiles)

+    /// </summary>

     class DB4oUserManager

     {

+        /// <summary>

+        /// A list of the user profiles (in memory cache)

+        /// </summary>

         public Dictionary<LLUUID, UserProfileData> userProfiles = new Dictionary<LLUUID, UserProfileData>();

+        /// <summary>

+        /// Database filename

+        /// </summary>

         string dbfl;

 

+        /// <summary>

+        /// Initialises a new DB manager

+        /// </summary>

+        /// <param name="db4odb">The filename to the database</param>

         public DB4oUserManager(string db4odb)

         {

             dbfl = db4odb;

             IObjectContainer database;

             database = Db4oFactory.OpenFile(dbfl);

+            // Load to cache

             IObjectSet result = database.Get(typeof(UserProfileData));

             foreach (UserProfileData row in result)

             {