Changeset 54266 in vbox for trunk

Timestamp:

Feb 18, 2015 3:38:34 PM (10 years ago)

Author:

vboxsync

Message:

Main/webservice: change code to support multiple ISession instances per websession, lots of cleanup and wording changes
Main/idl,doc: matching updates

Location:

trunk

Files:

• doc/manual/en_US/SDKRef.xml (modified) (6 diffs)
• src/VBox/Main/glue/tests/TestVBox.java (modified) (2 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (4 diffs)
• src/VBox/Main/webservice/vboxweb.cpp (modified) (42 diffs)
• src/VBox/Main/webservice/vboxweb.h (modified) (22 diffs)

trunk/doc/manual/en_US/SDKRef.xml

@@ -1217 +1217 @@
 
                 <para>Upon logon, the websession manager creates one instance
-                of <xref linkend="IVirtualBox" xreflabel="IVirtualBox" /> and
-                another object of <xref linkend="ISession"
-                xreflabel="ISession" /> representing the web service session.
-                This can be retrieved using <xref
+                of <xref linkend="IVirtualBox" xreflabel="IVirtualBox" />,
+                which can be used for directly performing calls to its
+                methods, or used as a parameter for calling some methods of
+                <xref linkend="IWebsessionManager" xreflabel="IWebsessionManager" />.
+                Creating Main API session objects is performed using <xref
                 linkend="IWebsessionManager__getSessionObject"
                 xreflabel="IWebsessionManager::getSessionObject()" />.</para>
@@ -1226 +1227 @@
                 <para>(Technically, there is always only one <xref
                 linkend="IVirtualBox" xreflabel="IVirtualBox" /> object, which
-                is shared between all sessions and clients, as it is a COM
+                is shared between all websessions and clients, as it is a COM
                 singleton. However, each session receives its own managed
-                object reference to it. The <xref linkend="ISession"
-                xreflabel="ISession" /> object, however, is created and
-                destroyed for each session.)</para>
+                object reference to it.)</para>
               </listitem>
 
@@ -1528 +1527 @@
 name = "Linux"
 mach = vbox.findMachine(name)
-session = mgr.mgr.getSessionObject(vbox)
+session = mgr.getSessionObject(vbox)
 progress = mach.launchVMProcess(session, "gui", "")
 progress.waitForCompletion(-1)
@@ -1549 +1548 @@
         available virtual machines in case of XPCOM), and a mechanism of
         uniform session creation and closing
-        (<computeroutput>mgr.mgr.getSessionObject()</computeroutput>).</para>
+        (<computeroutput>mgr.getSessionObject()</computeroutput>).</para>
 
         <para>In case you want to use the glue layer with a different Python
@@ -2292 +2291 @@
       xreflabel="ISession" /> interface. Each process which talks to
       VirtualBox needs its own instance of ISession. In the web service, you
-      cannot create such an object, but
-      <computeroutput>vboxwebsrv</computeroutput> creates one for you when you
-      log on, which you can obtain by calling <xref
+      can request the creation of such an object by calling <xref
       linkend="IWebsessionManager__getSessionObject"
-      xreflabel="IWebsessionManager::getSessionObject()" />.</para>
+      xreflabel="IWebsessionManager::getSessionObject()" />. More complex
+      management tasks might need multiple instances of ISession, and each call
+      returns a new one.</para>
 
       <para>This session object must then be used like a mutex semaphore in
@@ -3908 +3907 @@
           </itemizedlist></para>
         </listitem>
+
+        <listitem>
+          <para>The method <xref linkend="IWebsessionManager__getSessionObject"
+          xreflabel="IWebsessionManager::getSessionObject()" /> now returns
+          a new <xref linkend="ISession" xreflabel="ISession" /> instance for
+          every invocation. This puts the behavior in line with other binding
+          styles, which never forced the equivalent of establishing another
+          connection and logging in again to get another instance.</para>
+        </listitem>
       </itemizedlist>
     </sect1>

trunk/src/VBox/Main/glue/tests/TestVBox.java

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2010-2013 Oracle Corporation
+ * Copyright (C) 2010-2015 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -15 +15 @@
  * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
  */
-import org.virtualbox_4_3.*;
+import org.virtualbox_4_4.*;
 import java.util.List;
 import java.util.Arrays;

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -3 +3 @@
 <!--
 
-    Copyright (C) 2006-2014 Oracle Corporation
+    Copyright (C) 2006-2015 Oracle Corporation
 
     This file is part of VirtualBox Open Source Edition (OSE), as
@@ -18980 +18980 @@
   <interface
     name="IWebsessionManager" extends="$unknown"
-    uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
+    uuid="930c8fea-453a-4a65-aca9-19ed9a872f88"
     internal="yes"
     wsmap="global"
@@ -19003 +19003 @@
     <method name="getSessionObject">
       <desc>
-        Returns a managed object reference to the internal ISession object that was created
-        for this web service session when the client logged on.
+        Returns a managed object reference to a new ISession object for every
+        call to this method.
 
         <see><link to="ISession"/></see>
@@ -19015 +19015 @@
       <desc>
         Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
-        and destroys all resources associated with the session (most importantly, all
-        managed objects created in the server while the session was active).
+        and destroys all resources associated with the websession (most
+        importantly, all managed objects created in the server while the
+        websession was active).
       </desc>
       <param name="refIVirtualBox" type="IVirtualBox" dir="in"/>

trunk/src/VBox/Main/webservice/vboxweb.cpp

@@ -6 +6 @@
  *      server, to which clients can connect.
  *
- * Copyright (C) 2007-2014 Oracle Corporation
+ * Copyright (C) 2007-2015 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -86 +86 @@
  ****************************************************************************/
 
-typedef std::map<uint64_t, ManagedObjectRef*>
-            ManagedObjectsMapById;
-typedef std::map<uint64_t, ManagedObjectRef*>::iterator
-            ManagedObjectsIteratorById;
-typedef std::map<uintptr_t, ManagedObjectRef*>
-            ManagedObjectsMapByPtr;
-
-typedef std::map<uint64_t, WebServiceSession*>
-            SessionsMap;
-typedef std::map<uint64_t, WebServiceSession*>::iterator
-            SessionsMapIterator;
-
-int fntWatchdog(RTTHREAD ThreadSelf, void *pvUser);
+typedef std::map<uint64_t, ManagedObjectRef*>   ManagedObjectsMapById;
+typedef ManagedObjectsMapById::iterator         ManagedObjectsIteratorById;
+typedef std::map<uintptr_t, ManagedObjectRef*>  ManagedObjectsMapByPtr;
+typedef ManagedObjectsMapByPtr::iterator        ManagedObjectsIteratorByPtr;
+
+typedef std::map<uint64_t, WebServiceSession*>  WebsessionsMap;
+typedef WebsessionsMap::iterator                WebsessionsMapIterator;
+
+typedef std::map<RTTHREAD, com::Utf8Str> ThreadsMap;
+
+static int fntWatchdog(RTTHREAD ThreadSelf, void *pvUser);
 
 /****************************************************************************
@@ -110 +108 @@
 // generated strings in methodmaps.cpp
 extern const char       *g_pcszISession,
-                        *g_pcszIVirtualBox;
+                        *g_pcszIVirtualBox,
+                        *g_pcszIVirtualBoxErrorInfo;
 
 // globals for vboxweb command-line arguments
 #define DEFAULT_TIMEOUT_SECS 300
 #define DEFAULT_TIMEOUT_SECS_STRING "300"
-int                     g_iWatchdogTimeoutSecs = DEFAULT_TIMEOUT_SECS;
-int                     g_iWatchdogCheckInterval = 5;
-
-const char              *g_pcszBindToHost = NULL;       // host; NULL = localhost
-unsigned int            g_uBindToPort = 18083;          // port
-unsigned int            g_uBacklog = 100;               // backlog = max queue size for requests
+static int              g_iWatchdogTimeoutSecs = DEFAULT_TIMEOUT_SECS;
+static int              g_iWatchdogCheckInterval = 5;
+
+static const char       *g_pcszBindToHost = NULL;       // host; NULL = localhost
+static unsigned int     g_uBindToPort = 18083;          // port
+static unsigned int     g_uBacklog = 100;               // backlog = max queue size for requests
 
 #ifdef WITH_OPENSSL
-bool                    g_fSSL = false;                 // if SSL is enabled
-const char              *g_pcszKeyFile = NULL;          // server key file
-const char              *g_pcszPassword = NULL;         // password for server key
-const char              *g_pcszCACert = NULL;           // file with trusted CA certificates
-const char              *g_pcszCAPath = NULL;           // directory with trusted CA certificates
-const char              *g_pcszDHFile = NULL;           // DH file name or DH key length in bits, NULL=use RSA
-const char              *g_pcszRandFile = NULL;         // file with random data seed
-const char              *g_pcszSID = "vboxwebsrv";      // server ID for SSL session cache
+static bool             g_fSSL = false;                 // if SSL is enabled
+static const char       *g_pcszKeyFile = NULL;          // server key file
+static const char       *g_pcszPassword = NULL;         // password for server key
+static const char       *g_pcszCACert = NULL;           // file with trusted CA certificates
+static const char       *g_pcszCAPath = NULL;           // directory with trusted CA certificates
+static const char       *g_pcszDHFile = NULL;           // DH file name or DH key length in bits, NULL=use RSA
+static const char       *g_pcszRandFile = NULL;         // file with random data seed
+static const char       *g_pcszSID = "vboxwebsrv";      // server ID for SSL session cache
 #endif /* WITH_OPENSSL */
 
-unsigned int            g_cMaxWorkerThreads = 100;      // max. no. of worker threads
-unsigned int            g_cMaxKeepAlive = 100;          // maximum number of soap requests in one connection
-
-const char              *g_pcszAuthentication = NULL;   // web service authentication
-
-uint32_t                g_cHistory = 10;                // enable log rotation, 10 files
-uint32_t                g_uHistoryFileTime = RT_SEC_1DAY; // max 1 day per file
-uint64_t                g_uHistoryFileSize = 100 * _1M; // max 100MB per file
+static unsigned int     g_cMaxWorkerThreads = 100;      // max. no. of worker threads
+static unsigned int     g_cMaxKeepAlive = 100;          // maximum number of soap requests in one connection
+
+static const char       *g_pcszAuthentication = NULL;   // web service authentication
+
+static uint32_t         g_cHistory = 10;                // enable log rotation, 10 files
+static uint32_t         g_uHistoryFileTime = RT_SEC_1DAY; // max 1 day per file
+static uint64_t         g_uHistoryFileSize = 100 * _1M; // max 100MB per file
 bool                    g_fVerbose = false;             // be verbose
 
-bool                    g_fDaemonize = false;           // run in background.
+static bool             g_fDaemonize = false;           // run in background.
 
 const WSDLT_ID          g_EmptyWSDLID;                  // for NULL MORs
@@ -155 +154 @@
 // The one global SOAP queue created by main().
 class SoapQ;
-SoapQ               *g_pSoapQ = NULL;
+static SoapQ                    *g_pSoapQ = NULL;
 
 // this mutex protects the auth lib and authentication
-util::WriteLockHandle  *g_pAuthLibLockHandle;
+static util::WriteLockHandle    *g_pAuthLibLockHandle;
 
 // this mutex protects the global VirtualBox reference below
-static util::RWLockHandle *g_pVirtualBoxLockHandle;
-
-static ComPtr<IVirtualBox> g_pVirtualBox = NULL;
+static util::RWLockHandle       *g_pVirtualBoxLockHandle;
+
+static ComPtr<IVirtualBox>      g_pVirtualBox = NULL;
 
 // this mutex protects all of the below
-util::WriteLockHandle  *g_pSessionsLockHandle;
-
-SessionsMap         g_mapSessions;
-ULONG64             g_iMaxManagedObjectID = 0;
-ULONG64             g_cManagedObjects = 0;
+util::WriteLockHandle           *g_pWebsessionsLockHandle;
+
+static WebsessionsMap           g_mapWebsessions;
+static ULONG64                  g_cManagedObjects = 0;
 
 // this mutex protects g_mapThreads
-util::RWLockHandle  *g_pThreadsLockHandle;
-
-// this mutex synchronizes logging
-util::WriteLockHandle *g_pWebLogLockHandle;
+static util::RWLockHandle       *g_pThreadsLockHandle;
 
 // Threads map, so we can quickly map an RTTHREAD struct to a logger prefix
-typedef std::map<RTTHREAD, com::Utf8Str> ThreadsMap;
-ThreadsMap          g_mapThreads;
+static ThreadsMap               g_mapThreads;
 
 /****************************************************************************
@@ -218 +212 @@
     };
 
-void DisplayHelp()
+static void DisplayHelp()
 {
     RTStrmPrintf(g_pStdErr, "\nUsage: vboxwebsrv [options]\n\nSupported options (default values in brackets):\n");
@@ -640 +634 @@
                     }
                     {
-                        // we're messing with sessions, so lock them
-                        util::AutoWriteLock lock(g_pSessionsLockHandle COMMA_LOCKVAL_SRC_POS);
-                        WEBDEBUG(("SVC unavailable: deleting %d sessions\n", g_mapSessions.size()));
-
-                        SessionsMap::iterator it = g_mapSessions.begin(),
-                                              itEnd = g_mapSessions.end();
+                        // we're messing with websessions, so lock them
+                        util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
+                        WEBDEBUG(("SVC unavailable: deleting %d websessions\n", g_mapWebsessions.size()));
+
+                        WebsessionsMapIterator it = g_mapWebsessions.begin(),
+                                               itEnd = g_mapWebsessions.end();
                         while (it != itEnd)
                         {
-                            WebServiceSession *pSession = it->second;
-                            WEBDEBUG(("SVC unavailable: Session %llX stale, deleting\n", pSession->getID()));
-                            delete pSession;
-                            it = g_mapSessions.begin();
+                            WebServiceSession *pWebsession = it->second;
+                            WEBDEBUG(("SVC unavailable: websession %#llx stale, deleting\n", pWebsession->getID()));
+                            delete pWebsession;
+                            it = g_mapWebsessions.begin();
                         }
                     }
@@ -829 +823 @@
  ****************************************************************************/
 
-void doQueuesLoop()
+static void doQueuesLoop()
 {
 #ifdef WITH_OPENSSL
@@ -909 +903 @@
  * SOAP queue worker threads.
  */
-int fntQPumper(RTTHREAD ThreadSelf, void *pvUser)
+static int fntQPumper(RTTHREAD ThreadSelf, void *pvUser)
 {
     // store a log prefix for this thread
@@ -1202 +1196 @@
     g_pAuthLibLockHandle = new util::WriteLockHandle(util::LOCKCLASS_WEBSERVICE);
     g_pVirtualBoxLockHandle = new util::RWLockHandle(util::LOCKCLASS_WEBSERVICE);
-    g_pSessionsLockHandle = new util::WriteLockHandle(util::LOCKCLASS_WEBSERVICE);
+    g_pWebsessionsLockHandle = new util::WriteLockHandle(util::LOCKCLASS_WEBSERVICE);
     g_pThreadsLockHandle = new util::RWLockHandle(util::LOCKCLASS_OBJECTSTATE);
-    g_pWebLogLockHandle = new util::WriteLockHandle(util::LOCKCLASS_WEBSERVICE);
 
     // SOAP queue pumper thread
@@ -1266 +1259 @@
  * Watchdog thread, runs in the background while the webservice is alive.
  *
- * This gets started by main() and runs in the background to check all sessions
+ * This gets started by main() and runs in the background to check all websessions
  * for whether they have been no requests in a configurable timeout period. In
- * that case, the session is automatically logged off.
- */
+ * that case, the websession is automatically logged off.
+ */
+/* static */
 int fntWatchdog(RTTHREAD ThreadSelf, void *pvUser)
 {
@@ -1287 +1281 @@
         time(&tNow);
 
-        // we're messing with sessions, so lock them
-        util::AutoWriteLock lock(g_pSessionsLockHandle COMMA_LOCKVAL_SRC_POS);
-        WEBDEBUG(("Watchdog: checking %d sessions\n", g_mapSessions.size()));
-
-        SessionsMap::iterator it = g_mapSessions.begin(),
-                              itEnd = g_mapSessions.end();
+        // we're messing with websessions, so lock them
+        util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
+        WEBDEBUG(("Watchdog: checking %d websessions\n", g_mapWebsessions.size()));
+
+        WebsessionsMapIterator it = g_mapWebsessions.begin(),
+                               itEnd = g_mapWebsessions.end();
         while (it != itEnd)
         {
-            WebServiceSession *pSession = it->second;
-            WEBDEBUG(("Watchdog: tNow: %d, session timestamp: %d\n", tNow, pSession->getLastObjectLookup()));
-            if (   tNow
-                 > pSession->getLastObjectLookup() + g_iWatchdogTimeoutSecs
-               )
+            WebServiceSession *pWebsession = it->second;
+            WEBDEBUG(("Watchdog: tNow: %d, websession timestamp: %d\n", tNow, pWebsession->getLastObjectLookup()));
+            if (tNow > pWebsession->getLastObjectLookup() + g_iWatchdogTimeoutSecs)
             {
-                WEBDEBUG(("Watchdog: Session %llX timed out, deleting\n", pSession->getID()));
-                delete pSession;
-                it = g_mapSessions.begin();
+                WEBDEBUG(("Watchdog: websession %#llx timed out, deleting\n", pWebsession->getID()));
+                delete pWebsession;
+                it = g_mapWebsessions.begin();
             }
             else
@@ -1338 +1330 @@
  * @param ex
  */
-void RaiseSoapFault(struct soap *soap,
-                    const char *pcsz,
-                    int extype,
-                    void *ex)
+static void RaiseSoapFault(struct soap *soap,
+                           const char *pcsz,
+                           int extype,
+                           void *ex)
 {
     // raise the fault
@@ -1515 +1507 @@
     info.getVirtualBoxErrorInfo(pVirtualBoxErrorInfo);
     ex->resultCode = apirc;
-    ex->returnval = createOrFindRefFromComPtr(idThis, "IVirtualBoxErrorInfo", pVirtualBoxErrorInfo);
+    ex->returnval = createOrFindRefFromComPtr(idThis, g_pcszIVirtualBoxErrorInfo, pVirtualBoxErrorInfo);
 
     RaiseSoapFault(soap,
@@ -1529 +1521 @@
  ****************************************************************************/
 
-uint64_t str2ulonglong(const char *pcsz)
-{
-    uint64_t u = 0;
-    RTStrToUInt64Full(pcsz, 16, &u);
-    return u;
-}
-
-/**
- * Splits a managed object reference (in string form, as
- * passed in from a SOAP method call) into two integers for
- * session and object IDs, respectively.
+/**
+ * Splits a managed object reference (in string form, as passed in from a SOAP
+ * method call) into two integers for websession and object IDs, respectively.
  *
  * @param id
- * @param sessid
- * @param objid
+ * @param pWebsessId
+ * @param pObjId
  * @return
  */
-bool SplitManagedObjectRef(const WSDLT_ID &id,
-                           uint64_t *pSessid,
-                           uint64_t *pObjid)
+static bool SplitManagedObjectRef(const WSDLT_ID &id,
+                                  uint64_t *pWebsessId,
+                                  uint64_t *pObjId)
 {
     // 64-bit numbers in hex have 16 digits; hence
@@ -1560 +1544 @@
         memcpy(psz, id.c_str(), 34);
         psz[16] = '\0';
-        if (pSessid)
-            *pSessid = str2ulonglong(psz);
-        if (pObjid)
-            *pObjid = str2ulonglong(psz + 17);
+        if (pWebsessId)
+            RTStrToUInt64Full(psz, 16, pWebsessId);
+        if (pObjId)
+            RTStrToUInt64Full(psz + 17, 16, pObjId);
         return true;
     }
@@ -1572 +1556 @@
 /**
  * Creates a managed object reference (in string form) from
- * two integers representing a session and object ID, respectively.
+ * two integers representing a websession and object ID, respectively.
  *
  * @param sz Buffer with at least 34 bytes space to receive MOR string.
- * @param sessid
- * @param objid
+ * @param websessId
+ * @param objId
  * @return
  */
-void MakeManagedObjectRef(char *sz,
-                          uint64_t &sessid,
-                          uint64_t &objid)
-{
-    RTStrFormatNumber(sz, sessid, 16, 16, 0, RTSTR_F_64BIT | RTSTR_F_ZEROPAD);
+static void MakeManagedObjectRef(char *sz,
+                                 uint64_t websessId,
+                                 uint64_t objId)
+{
+    RTStrFormatNumber(sz, websessId, 16, 16, 0, RTSTR_F_64BIT | RTSTR_F_ZEROPAD);
     sz[16] = '-';
-    RTStrFormatNumber(sz + 17, objid, 16, 16, 0, RTSTR_F_64BIT | RTSTR_F_ZEROPAD);
+    RTStrFormatNumber(sz + 17, objId, 16, 16, 0, RTSTR_F_64BIT | RTSTR_F_ZEROPAD);
 }
 
@@ -1602 +1586 @@
 
 /**
- * Constructor for the session object.
- *
- * Preconditions: Caller must have locked g_pSessionsLockHandle.
+ * Constructor for the websession object.
+ *
+ * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
  *
  * @param username
@@ -1610 +1594 @@
  */
 WebServiceSession::WebServiceSession()
-    : _fDestructing(false),
-      _pISession(NULL),
+    : _uNextObjectID(1),        // avoid 0 for no real reason
+      _fDestructing(false),
       _tLastObjectLookup(0)
 {
     _pp = new WebServiceSessionPrivate;
-    _uSessionID = RTRandU64();
-
-    // register this session globally
-    Assert(g_pSessionsLockHandle->isWriteLockOnCurrentThread());
-    g_mapSessions[_uSessionID] = this;
+    _uWebsessionID = RTRandU64();
+
+    // register this websession globally
+    Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
+    g_mapWebsessions[_uWebsessionID] = this;
 }
 
@@ -1625 +1609 @@
  * Destructor. Cleans up and destroys all contained managed object references on the way.
  *
- * Preconditions: Caller must have locked g_pSessionsLockHandle.
+ * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
  */
 WebServiceSession::~WebServiceSession()
@@ -1631 +1615 @@
     // delete us from global map first so we can't be found
     // any more while we're cleaning up
-    Assert(g_pSessionsLockHandle->isWriteLockOnCurrentThread());
-    g_mapSessions.erase(_uSessionID);
+    Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
+    g_mapWebsessions.erase(_uWebsessionID);
 
     // notify ManagedObjectRef destructor so it won't
@@ -1639 +1623 @@
     _fDestructing = true;
 
-    // if (_pISession)
-    // {
-    //     delete _pISession;
-    //     _pISession = NULL;
-    // }
-
-    ManagedObjectsMapById::iterator it,
-                                    end = _pp->_mapManagedObjectsById.end();
+    ManagedObjectsIteratorById it,
+                               end = _pp->_mapManagedObjectsById.end();
     for (it = _pp->_mapManagedObjectsById.begin();
          it != end;
@@ -1771 +1749 @@
     lock.release();
 
-    if (!rc)
-    {
-        do
-        {
-            // now create the ISession object that this webservice session can use
-            // (and of which IWebsessionManager::getSessionObject returns a managed object reference)
-            ComPtr<ISession> session;
-            rc = g_pVirtualBoxClient->COMGETTER(Session)(session.asOutParam());
-            if (FAILED(rc))
-            {
-                WEBDEBUG(("ERROR: cannot create session object!"));
-                break;
-            }
-
-            ComPtr<IUnknown> p2 = session;
-            _pISession = new ManagedObjectRef(*this,
-                                              p2,                               // IUnknown *pobjUnknown
-                                              session,                          // void *pobjInterface
-                                              com::Guid(COM_IIDOF(ISession)),
-                                              g_pcszISession);
-
-            if (g_fVerbose)
-            {
-                ISession *p = session;
-                WEBDEBUG(("   * %s: created session object with comptr %#p, MOR = %s\n", __FUNCTION__, p, _pISession->getWSDLID().c_str()));
-            }
-        } while (0);
-    }
-
     return rc;
 }
 
 /**
- *  Look up, in this session, whether a ManagedObjectRef has already been
+ *  Look up, in this websession, whether a ManagedObjectRef has already been
  *  created for the given COM pointer.
  *
@@ -1813 +1762 @@
  *  our private hash table, we must search for one too.
  *
- * Preconditions: Caller must have locked g_pSessionsLockHandle.
+ * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
  *
  * @param pcu pointer to a COM object.
@@ -1820 +1769 @@
 ManagedObjectRef* WebServiceSession::findRefFromPtr(const IUnknown *pObject)
 {
-    Assert(g_pSessionsLockHandle->isWriteLockOnCurrentThread());
+    Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
 
     uintptr_t ulp = (uintptr_t)pObject;
     // WEBDEBUG(("   %s: looking up %#lx\n", __FUNCTION__, ulp));
-    ManagedObjectsMapByPtr::iterator it = _pp->_mapManagedObjectsByPtr.find(ulp);
+    ManagedObjectsIteratorByPtr it = _pp->_mapManagedObjectsByPtr.find(ulp);
     if (it != _pp->_mapManagedObjectsByPtr.end())
     {
@@ -1836 +1785 @@
 
 /**
- * Static method which attempts to find the session for which the given managed
- * object reference was created, by splitting the reference into the session and
- * object IDs and then looking up the session object for that session ID.
- *
- * Preconditions: Caller must have locked g_pSessionsLockHandle in read mode.
- *
- * @param id Managed object reference (with combined session and object IDs).
+ * Static method which attempts to find the websession for which the given
+ * managed object reference was created, by splitting the reference into the
+ * websession and object IDs and then looking up the websession object.
+ *
+ * Preconditions: Caller must have locked g_pWebsessionsLockHandle in read mode.
+ *
+ * @param id Managed object reference (with combined websession and object IDs).
  * @return
  */
-WebServiceSession* WebServiceSession::findSessionFromRef(const WSDLT_ID &id)
-{
-    Assert(g_pSessionsLockHandle->isWriteLockOnCurrentThread());
-
-    WebServiceSession *pSession = NULL;
-    uint64_t sessid;
+WebServiceSession *WebServiceSession::findWebsessionFromRef(const WSDLT_ID &id)
+{
+    Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
+
+    WebServiceSession *pWebsession = NULL;
+    uint64_t websessId;
     if (SplitManagedObjectRef(id,
-                              &sessid,
+                              &websessId,
                               NULL))
     {
-        SessionsMapIterator it = g_mapSessions.find(sessid);
-        if (it != g_mapSessions.end())
-            pSession = it->second;
-    }
-    return pSession;
-}
-
-/**
- *
- */
-const WSDLT_ID& WebServiceSession::getSessionWSDLID() const
-{
-    return _pISession->getWSDLID();
-}
-
-/**
- * Touches the webservice session to prevent it from timing out.
- *
- * Each webservice session has an internal timestamp that records
- * the last request made to it from the client that started it.
- * If no request was made within a configurable timeframe, then
- * the client is logged off automatically,
+        WebsessionsMapIterator it = g_mapWebsessions.find(websessId);
+        if (it != g_mapWebsessions.end())
+            pWebsession = it->second;
+    }
+    return pWebsession;
+}
+
+/**
+ * Touches the websession to prevent it from timing out.
+ *
+ * Each websession has an internal timestamp that records the last request made
+ * to it from the client that started it. If no request was made within a
+ * configurable timeframe, then the client is logged off automatically,
  * by calling IWebsessionManager::logoff()
  */
@@ -1893 +1833 @@
 /**
  *  Constructor, which assigns a unique ID to this managed object
- *  reference and stores it two global hashes:
- *
- *   a) G_mapManagedObjectsById, which maps ManagedObjectID's to
+ *  reference and stores it in two hashes (living in the associated
+ *  WebServiceSession object):
+ *
+ *   a) _mapManagedObjectsById, which maps ManagedObjectID's to
  *      instances of this class; this hash is then used by the
  *      findObjectFromRef() template function in vboxweb.h
@@ -1903 +1844 @@
  *      a managed object ID);
  *
- *   b) G_mapManagedObjectsByComPtr, which maps COM pointers to
+ *   b) _mapManagedObjectsByPtr, which maps COM pointers to
  *      instances of this class; this hash is used by
  *      createRefFromObject() to quickly figure out whether an
@@ -1922 +1863 @@
  *  does perform that check.
  *
- * Preconditions: Caller must have locked g_pSessionsLockHandle.
- *
- * @param session Session to which the MOR will be added.
+ * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
+ *
+ * @param websession Websession to which the MOR will be added.
  * @param pobjUnknown Pointer to IUnknown* interface for the COM object; this will be used in the hashes.
  * @param pobjInterface Pointer to a specific interface for the COM object, described by guidInterface.
@@ -1930 +1871 @@
  * @param pcszInterface String representation of that interface (e.g. "IMachine") for readability and logging.
  */
-ManagedObjectRef::ManagedObjectRef(WebServiceSession &session,
+ManagedObjectRef::ManagedObjectRef(WebServiceSession &websession,
                                    IUnknown *pobjUnknown,
                                    void *pobjInterface,
                                    const com::Guid &guidInterface,
                                    const char *pcszInterface)
-    : _session(session),
+    : _websession(websession),
       _pobjUnknown(pobjUnknown),
       _pobjInterface(pobjInterface),
@@ -1949 +1890 @@
     _ulp = (uintptr_t)pobjUnknown;
 
-    Assert(g_pSessionsLockHandle->isWriteLockOnCurrentThread());
-    _id = ++g_iMaxManagedObjectID;
+    Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
+    _id = websession.createObjectID();
     // and count globally
     ULONG64 cTotal = ++g_cManagedObjects;           // raise global count and make a copy for the debug message below
 
     char sz[34];
-    MakeManagedObjectRef(sz, session._uSessionID, _id);
+    MakeManagedObjectRef(sz, websession._uWebsessionID, _id);
     _strID = sz;
 
-    session._pp->_mapManagedObjectsById[_id] = this;
-    session._pp->_mapManagedObjectsByPtr[_ulp] = this;
-
-    session.touch();
-
-    WEBDEBUG(("   * %s: MOR created for %s*=%#p (IUnknown*=%#p; COM refcount now %RI32/%RI32), new ID is %llX; now %lld objects total\n",
+    websession._pp->_mapManagedObjectsById[_id] = this;
+    websession._pp->_mapManagedObjectsByPtr[_ulp] = this;
+
+    websession.touch();
+
+    WEBDEBUG(("   * %s: MOR created for %s*=%#p (IUnknown*=%#p; COM refcount now %RI32/%RI32), new ID is %#llx; now %lld objects total\n",
               __FUNCTION__,
               pcszInterface,
@@ -1978 +1919 @@
  * managed objects. Calls Release() on the contained COM object.
  *
- * Preconditions: Caller must have locked g_pSessionsLockHandle.
+ * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
  */
 ManagedObjectRef::~ManagedObjectRef()
 {
-    Assert(g_pSessionsLockHandle->isWriteLockOnCurrentThread());
+    Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
     ULONG64 cTotal = --g_cManagedObjects;
 
@@ -1992 +1933 @@
     uint32_t cRefs2 = ((IUnknown*)_pobjInterface)->Release();
     uint32_t cRefs1 = _pobjUnknown->Release();
-    WEBDEBUG(("   * %s: deleting MOR for ID %llX (%s; COM refcount now %RI32/%RI32); now %lld objects total\n", __FUNCTION__, _id, _pcszInterface, cRefs1, cRefs2, cTotal));
-
-    // if we're being destroyed from the session's destructor,
+    WEBDEBUG(("   * %s: deleting MOR for ID %#llx (%s; COM refcount now %RI32/%RI32); now %lld objects total\n", __FUNCTION__, _id, _pcszInterface, cRefs1, cRefs2, cTotal));
+
+    // if we're being destroyed from the websession's destructor,
     // then that destructor is iterating over the maps, so
     // don't remove us there! (data integrity + speed)
-    if (!_session._fDestructing)
-    {
-        WEBDEBUG(("   * %s: removing from session maps\n", __FUNCTION__));
-        _session._pp->_mapManagedObjectsById.erase(_id);
-        if (_session._pp->_mapManagedObjectsByPtr.erase(_ulp) != 1)
-            WEBDEBUG(("   WARNING: could not find %llX in _mapManagedObjectsByPtr\n", _ulp));
+    if (!_websession._fDestructing)
+    {
+        WEBDEBUG(("   * %s: removing from websession maps\n", __FUNCTION__));
+        _websession._pp->_mapManagedObjectsById.erase(_id);
+        if (_websession._pp->_mapManagedObjectsByPtr.erase(_ulp) != 1)
+            WEBDEBUG(("   WARNING: could not find %#llx in _mapManagedObjectsByPtr\n", _ulp));
     }
 }
@@ -2013 +1954 @@
  * code bloat as we have the actual STL map lookup only in this function.
  *
- * This also "touches" the timestamp in the session whose ID is encoded
- * in the given integer ID, in order to prevent the session from timing
+ * This also "touches" the timestamp in the websession whose ID is encoded
+ * in the given integer ID, in order to prevent the websession from timing
  * out.
  *
- * Preconditions: Caller must have locked g_mutexSessions.
+ * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
  *
  * @param strId
@@ -2038 +1979 @@
         }
 
-        uint64_t sessid;
-        uint64_t objid;
+        uint64_t websessId;
+        uint64_t objId;
         WEBDEBUG(("   %s(): looking up objref %s\n", __FUNCTION__, id.c_str()));
         if (!SplitManagedObjectRef(id,
-                                   &sessid,
-                                   &objid))
+                                   &websessId,
+                                   &objId))
         {
             rc = VERR_WEB_INVALID_MANAGED_OBJECT_REFERENCE;
@@ -2049 +1990 @@
         }
 
-        SessionsMapIterator it = g_mapSessions.find(sessid);
-        if (it == g_mapSessions.end())
+        WebsessionsMapIterator it = g_mapWebsessions.find(websessId);
+        if (it == g_mapWebsessions.end())
         {
-            WEBDEBUG(("   %s: cannot find session for objref %s\n", __FUNCTION__, id.c_str()));
+            WEBDEBUG(("   %s: cannot find websession for objref %s\n", __FUNCTION__, id.c_str()));
             rc = VERR_WEB_INVALID_SESSION_ID;
             break;
         }
 
-        WebServiceSession *pSess = it->second;
-        // "touch" session to prevent it from timing out
-        pSess->touch();
-
-        ManagedObjectsIteratorById iter = pSess->_pp->_mapManagedObjectsById.find(objid);
-        if (iter == pSess->_pp->_mapManagedObjectsById.end())
+        WebServiceSession *pWebsession = it->second;
+        // "touch" websession to prevent it from timing out
+        pWebsession->touch();
+
+        ManagedObjectsIteratorById iter = pWebsession->_pp->_mapManagedObjectsById.find(objId);
+        if (iter == pWebsession->_pp->_mapManagedObjectsById.end())
         {
             WEBDEBUG(("   %s: cannot find comobj for objref %s\n", __FUNCTION__, id.c_str()));
@@ -2104 +2045 @@
     {
         // findRefFromId require the lock
-        util::AutoWriteLock lock(g_pSessionsLockHandle COMMA_LOCKVAL_SRC_POS);
+        util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
 
         ManagedObjectRef *pRef;
@@ -2139 +2080 @@
     {
         // findRefFromId and the delete call below require the lock
-        util::AutoWriteLock lock(g_pSessionsLockHandle COMMA_LOCKVAL_SRC_POS);
+        util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
 
         ManagedObjectRef *pRef;
@@ -2174 +2115 @@
  *
  * This returns a managed object reference to the global IVirtualBox object; into this
- * reference a session ID is encoded which remains constant with all managed object
+ * reference a websession ID is encoded which remains constant with all managed object
  * references returned by other methods.
- *
- * This also creates an instance of ISession, which is stored internally with the
- * webservice session and can be retrieved with IWebsessionManager::getSessionObject
- * (__vbox__IWebsessionManager_USCOREgetSessionObject). In order for the
- * VirtualBox web service to do anything useful, one usually needs both a
- * VirtualBox and an ISession object, for which these two methods are designed.
  *
  * When the webservice client is done, it should call IWebsessionManager::logoff. This
@@ -2210 +2145 @@
     {
         // WebServiceSession constructor tinkers with global MOR map and requires a write lock
-        util::AutoWriteLock lock(g_pSessionsLockHandle COMMA_LOCKVAL_SRC_POS);
-
-        // create new session; the constructor stores the new session
+        util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
+
+        // create new websession; the constructor stores the new websession
         // in the global map automatically
-        WebServiceSession *pSession = new WebServiceSession();
+        WebServiceSession *pWebsession = new WebServiceSession();
         ComPtr<IVirtualBox> pVirtualBox;
 
         // authenticate the user
-        if (!(pSession->authenticate(req->username.c_str(),
-                                     req->password.c_str(),
-                                     pVirtualBox.asOutParam())))
+        if (!(pWebsession->authenticate(req->username.c_str(),
+                                        req->password.c_str(),
+                                        pVirtualBox.asOutParam())))
         {
-            // in the new session, create a managed object reference (MOR) for the
-            // global VirtualBox object; this encodes the session ID in the MOR so
+            // fake up a "root" MOR for this websession
+            char sz[34];
+            MakeManagedObjectRef(sz, pWebsession->getID(), 0ULL);
+            WSDLT_ID id = sz;
+
+            // in the new websession, create a managed object reference (MOR) for the
+            // global VirtualBox object; this encodes the websession ID in the MOR so
             // that it will be implicitly be included in all future requests of this
             // webservice client
-            ComPtr<IUnknown> p2 = pVirtualBox;
-            if (pVirtualBox.isNull() || p2.isNull())
-            {
-                rc = E_FAIL;
-                break;
-            }
-            ManagedObjectRef *pRef = new ManagedObjectRef(*pSession,
-                                                          p2,                       // IUnknown *pobjUnknown
-                                                          pVirtualBox,              // void *pobjInterface
-                                                          COM_IIDOF(IVirtualBox),
-                                                          g_pcszIVirtualBox);
-            resp->returnval = pRef->getWSDLID();
+            resp->returnval = createOrFindRefFromComPtr(id, g_pcszIVirtualBox, pVirtualBox);
             WEBDEBUG(("VirtualBox object ref is %s\n", resp->returnval.c_str()));
         }
@@ -2251 +2180 @@
 
 /**
- * Returns the ISession object that was created for the webservice client
- * on logon.
+ * Returns a new ISession object every time.
+ *
+ * No longer connected in any way to logons, one websession can easily
+ * handle multiple sessions.
  */
 int __vbox__IWebsessionManager_USCOREgetSessionObject(
@@ -2264 +2195 @@
     do
     {
-        // findSessionFromRef needs lock
-        util::AutoWriteLock lock(g_pSessionsLockHandle COMMA_LOCKVAL_SRC_POS);
-
-        WebServiceSession* pSession;
-        if ((pSession = WebServiceSession::findSessionFromRef(req->refIVirtualBox)))
-            resp->returnval = pSession->getSessionWSDLID();
-
+        // create a new ISession object
+        ComPtr<ISession> pSession;
+        rc = g_pVirtualBoxClient->COMGETTER(Session)(pSession.asOutParam());
+        if (FAILED(rc))
+        {
+            WEBDEBUG(("ERROR: cannot create session object!"));
+            break;
+        }
+
+        // return its MOR
+        resp->returnval = createOrFindRefFromComPtr(req->refIVirtualBox, g_pcszISession, pSession);
+        WEBDEBUG(("Session object ref is %s\n", resp->returnval.c_str()));
     } while (0);
 
@@ -2297 +2233 @@
     do
     {
-        // findSessionFromRef and the session destructor require the lock
-        util::AutoWriteLock lock(g_pSessionsLockHandle COMMA_LOCKVAL_SRC_POS);
-
-        WebServiceSession* pSession;
-        if ((pSession = WebServiceSession::findSessionFromRef(req->refIVirtualBox)))
+        // findWebsessionFromRef and the websession destructor require the lock
+        util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
+
+        WebServiceSession* pWebsession;
+        if ((pWebsession = WebServiceSession::findWebsessionFromRef(req->refIVirtualBox)))
         {
-            delete pSession;
+            WEBDEBUG(("websession logoff, deleting websession %#llx\n", pWebsession->getID()));
+            delete pWebsession;
                 // destructor cleans up
 
-            WEBDEBUG(("session destroyed, %d sessions left open\n", g_mapSessions.size()));
+            WEBDEBUG(("websession destroyed, %d websessions left open\n", g_mapWebsessions.size()));
         }
     } while (0);

trunk/src/VBox/Main/webservice/vboxweb.h

@@ -3 +3 @@
  *      header file for "real" web server code.
  *
- * Copyright (C) 2006-2013 Oracle Corporation
+ * Copyright (C) 2006-2015 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -14 +14 @@
  */
 
-/****************************************************************************
- *
- * debug macro
- *
- ****************************************************************************/
-
-void WebLog(const char *pszFormat, ...);
-
-#define WEBDEBUG(a) do { if (g_fVerbose) { WebLog a; } } while (0)
-
 #ifdef DEBUG
 #define LOG_GROUP LOG_GROUP_WEBSERVICE
@@ -35 +25 @@
 #include <VBox/err.h>
 
-#include <iprt/stream.h>
+#include <iprt/asm.h>
 
 #include <string>
@@ -41 +31 @@
 /****************************************************************************
  *
+ * debug macro
+ *
+ ****************************************************************************/
+
+RT_C_DECLS_BEGIN
+extern void WebLog(const char *pszFormat, ...);
+RT_C_DECLS_END
+
+#define WEBDEBUG(a) do { if (g_fVerbose) { WebLog a; } } while (0)
+
+/****************************************************************************
+ *
  * typedefs
  *
@@ -46 +48 @@
 
 // type used by gSOAP-generated code
-typedef std::string WSDLT_ID;               // combined managed object ref (session ID plus object ID)
+typedef std::string WSDLT_ID;               // combined managed object ref (websession ID plus object ID)
 typedef std::string vbox__uuid;
 
@@ -57 +59 @@
 extern bool g_fVerbose;
 
-extern PRTSTREAM g_pstrLog;
-
-extern util::WriteLockHandle  *g_pAuthLibLockHandle;
-extern util::WriteLockHandle  *g_pSessionsLockHandle;
+extern util::WriteLockHandle  *g_pWebsessionsLockHandle;
 
 extern const WSDLT_ID          g_EmptyWSDLID;
@@ -70 +69 @@
  ****************************************************************************/
 
-void RaiseSoapInvalidObjectFault(struct soap *soap, WSDLT_ID obj);
-
-void RaiseSoapRuntimeFault(struct soap *soap, const WSDLT_ID &idThis, const char *pcszMethodName, HRESULT apirc, IUnknown *pObj, const com::Guid &iid);
+extern void RaiseSoapInvalidObjectFault(struct soap *soap, WSDLT_ID obj);
+
+extern void RaiseSoapRuntimeFault(struct soap *soap, const WSDLT_ID &idThis, const char *pcszMethodName, HRESULT apirc, IUnknown *pObj, const com::Guid &iid);
 
 /****************************************************************************
@@ -80 +79 @@
  ****************************************************************************/
 
-std::string ConvertComString(const com::Bstr &bstr);
-
-std::string ConvertComString(const com::Guid &bstr);
-
-std::string Base64EncodeByteArray(ComSafeArrayIn(BYTE, aData));
-
-void Base64DecodeByteArray(struct soap *soap, const std::string& aStr, ComSafeArrayOut(BYTE, aData), const WSDLT_ID &idThis, const char *pszMethodName, IUnknown *pObj, const com::Guid &iid);
+extern std::string ConvertComString(const com::Bstr &bstr);
+
+extern std::string ConvertComString(const com::Guid &bstr);
+
+extern std::string Base64EncodeByteArray(ComSafeArrayIn(BYTE, aData));
+
+extern void Base64DecodeByteArray(struct soap *soap, const std::string& aStr, ComSafeArrayOut(BYTE, aData), const WSDLT_ID &idThis, const char *pszMethodName, IUnknown *pObj, const com::Guid &iid);
+
 /****************************************************************************
  *
@@ -99 +99 @@
  *  An instance of this gets created for every client that logs onto the
  *  webservice (via the special IWebsessionManager::logon() SOAP API) and
- *  maintains the managed object references for that session.
+ *  maintains the managed object references for that websession.
  */
 class WebServiceSession
@@ -106 +106 @@
 
     private:
-        uint64_t                    _uSessionID;
+        uint64_t                    _uWebsessionID;
+        uint64_t                    _uNextObjectID;
         WebServiceSessionPrivate    *_pp;               // opaque data struct (defined in vboxweb.cpp)
         bool                        _fDestructing;
-
-        ManagedObjectRef            *_pISession;
 
         time_t                      _tLastObjectLookup;
@@ -130 +129 @@
         uint64_t getID() const
         {
-            return _uSessionID;
-        }
-
-        const WSDLT_ID& getSessionWSDLID() const;
+            return _uWebsessionID;
+        }
+
+        uint64_t createObjectID()
+        {
+            uint64_t id = ASMAtomicIncU64(&_uNextObjectID);
+            return id - 1;
+        }
 
         void touch();
@@ -142 +145 @@
         }
 
-        static WebServiceSession* findSessionFromRef(const WSDLT_ID &id);
+        static WebServiceSession* findWebsessionFromRef(const WSDLT_ID &id);
 
         void DumpRefs();
@@ -149 +152 @@
 /**
  *  ManagedObjectRef is used to map COM pointers to object IDs
- *  within a session. Such object IDs are 64-bit integers.
+ *  within a websession. Such object IDs are 64-bit integers.
  *
  *  When a webservice method call is invoked on an object, it
  *  has an opaque string called a "managed object reference". Such
- *  a string consists of a session ID combined with an object ID.
+ *  a string consists of a websession ID combined with an object ID.
  *
  */
@@ -159 +162 @@
 {
     protected:
-        // owning session:
-        WebServiceSession           &_session;
+        // owning websession:
+        WebServiceSession           &_websession;
 
 
@@ -179 +182 @@
 
     public:
-        ManagedObjectRef(WebServiceSession &session,
+        ManagedObjectRef(WebServiceSession &websession,
                          IUnknown *pobjUnknown,
                          void *pobjInterface,
@@ -224 +227 @@
                                  ManagedObjectRef **pRef,
                                  bool fNullAllowed);
-
-        static ManagedObjectRef* findFromPtr(ComPtr<IUnknown> pcu);
-        static ManagedObjectRef* create(const WSDLT_ID &idParent,
-                                        ComPtr<IUnknown> pcu);
-
 };
 
@@ -263 +261 @@
 {
     // findRefFromId requires thelock
-    util::AutoWriteLock lock(g_pSessionsLockHandle COMMA_LOCKVAL_SRC_POS);
+    util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
 
     int rc;
@@ -314 +312 @@
 
 /**
- * Creates a new managed object for the given COM pointer. If a reference already exists
- * for the given pointer, then that reference's ID is returned instead.
- *
- * This gets called from tons of generated code in methodmaps.cpp to
- * resolve objects *returned* from COM methods (i.e. create MOR strings from COM objects
- * which might have been newly created).
- *
- * @param idParent managed object reference of calling object; used to extract session ID
+ * Creates a new managed object reference for the given COM pointer. If one
+ * already exists for the given pointer, then that reference's ID is returned.
+ *
+ * This gets called from tons of generated code in methodmaps.cpp to resolve
+ * objects *returned* from COM methods (i.e. create MOR strings from COM
+ * objects which might have been newly created).
+ *
+ * @param idParent managed object reference of calling object; used to extract
+ *              websession ID
  * @param pc COM object for which to create a reference
  * @return existing or new managed object reference
@@ -328 +327 @@
 const WSDLT_ID& createOrFindRefFromComPtr(const WSDLT_ID &idParent,
                                           const char *pcszInterface,
-                                          ComPtr<T> &pc)
+                                          const ComPtr<T> &pc)
 {
     // NULL comptr should return NULL MOR
@@ -337 +336 @@
     }
 
-    util::AutoWriteLock lock(g_pSessionsLockHandle COMMA_LOCKVAL_SRC_POS);
-    WebServiceSession *pSession;
-    if ((pSession = WebServiceSession::findSessionFromRef(idParent)))
+    util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
+    WebServiceSession *pWebsession;
+    if ((pWebsession = WebServiceSession::findWebsessionFromRef(idParent)))
     {
         ManagedObjectRef *pRef;
@@ -346 +345 @@
         ComPtr<IUnknown> pobjUnknown = pc;
 
-        if (    ((pRef = pSession->findRefFromPtr(pobjUnknown)))
-             || ((pRef = new ManagedObjectRef(*pSession,
+        if (    ((pRef = pWebsession->findRefFromPtr(pobjUnknown)))
+             || ((pRef = new ManagedObjectRef(*pWebsession,
                                               pobjUnknown,          // IUnknown *pobjUnknown
                                               pc,                   // void *pobjInterface
@@ -356 +355 @@
     }
 
-    // session has expired, return an empty MOR instead of allocating a
+    // websession has expired, return an empty MOR instead of allocating a
     // new reference which couldn't be used anyway.
     return g_EmptyWSDLID;