vboxweb.h revision e64031e20c39650a7bc902a3e1aba613b9415dee
/*
* vboxweb.h:
* header file for "real" web server code.
*
* Copyright (C) 2006-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
/****************************************************************************
*
* debug macro
*
****************************************************************************/
#define LOG_GROUP LOG_GROUP_WEBSERVICE
#include <string>
/****************************************************************************
*
* global variables
*
****************************************************************************/
extern bool g_fVerbose;
/****************************************************************************
*
* typedefs
*
****************************************************************************/
// type used by gSOAP-generated code
/****************************************************************************
*
* SOAP exceptions
*
****************************************************************************/
/****************************************************************************
*
* conversion helpers
*
****************************************************************************/
/****************************************************************************
*
* managed object reference classes
*
****************************************************************************/
/**
* 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.
*/
{
bool _fDestructing;
// hide the copy constructor because we're not copyable
int authenticate(const char *pcszUsername,
const char *pcszPassword);
{
return _uSessionID;
}
WSDLT_ID getSessionObject() const;
void touch();
time_t getLastObjectLookup() const
{
return _tLastObjectLookup;
}
void DumpRefs();
};
/**
* ManagedObjectRef is used to map COM pointers to object IDs
* within a session. 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.
*
*/
{
// owning session:
// value:
const char *_pcszInterface;
// keys:
// long ID as string
const char *pcszInterface,
~ManagedObjectRef();
{
return _id;
}
{
return _pObj;
}
const char* getInterfaceName() const
{
return _pcszInterface;
}
bool fNullAllowed);
};
/**
* Template function that resolves a managed object reference to a COM pointer
* of the template class T. Gets called from tons of generated code in
*
* This is a template function so that we can support ComPtr's for arbitrary
* interfaces and automatically verify that the managed object reference on
* the internal stack actually is of the expected interface.
*
* @param soap
* @param id in: integer managed object reference, as passed in by web service client
* @param pComPtr out: reference to COM pointer object that receives the com pointer,
* if SOAP_OK is returned
* @param fNullAllowed in: if true, then this func returns a NULL COM pointer if an
* empty MOR is passed in (i.e. NULL pointers are allowed). If false,
* then this fails; this will be false when called for the "this"
* argument of method calls, which really shouldn't be NULL.
* @return error code or SOAP_OK if no error
*/
bool fNullAllowed)
{
// we're only reading the MOR maps, not modifying them, so a readlock is good enough
// (allow concurrency, this code gets called from everywhere in methodmaps.cpp)
int rc;
else
{
{
return 0;
}
// pRef->getComPtr returns a ComPtr<IUnknown>; by casting it to
// ComPtr<T>, we implicitly do a COM queryInterface() call
return 0;
WEBDEBUG((" Interface not supported for object reference %s, which is of class %s\n", id.c_str(), pRef->getInterfaceName()));
}
return rc;
}
/**
* Template function that creates a new managed object for the given COM
* pointer of the template class T. If a reference already exists for the
* given pointer, then that reference's ID is returned instead.
*
* @param idParent managed object reference of calling object; used to extract session ID
* @param pc COM object for which to create a reference
* @return existing or new managed object reference
*/
const char *pcszInterface,
{
// NULL comptr should return NULL MOR
{
WEBDEBUG((" createOrFindRefFromComPtr(): returning empty MOR for NULL COM pointer\n"));
return "";
}
// we might be modifying the MOR maps below, so request write lock now
{
// WEBDEBUG(("\n-- found session for %s\n", idParent.c_str()));
)
}
// session has expired, return an empty MOR instead of allocating a
// new reference which couldn't be used anyway.
return "";
}