webservices/wsibasicplugin/src/senwsiplugin.cpp
changeset 0 62f9d29f7211
child 1 272b002df977
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/webservices/wsibasicplugin/src/senwsiplugin.cpp	Thu Jan 07 16:19:19 2010 +0200
@@ -0,0 +1,412 @@
+/*
+* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:        
+*
+*/
+
+
+
+
+
+
+
+
+#include "senwsiplugin.h"
+#include "MSenServiceDescription.h"
+#include "SenServiceConnection.h" // framework IDs, error codes
+#include "msencoreservicemanager.h"
+#include "senbasicwebservicesession.h"
+#include "sendebug.h"
+#include "SenFacet.h" 
+#include "senlogger.h"
+
+#include <SenTransportProperties.h>
+#include <SenSoapConstants.h>
+
+namespace
+    {
+    _LIT8(KFrameworkLocalname,   "Framework");
+#ifdef _SENDEBUG
+        const TInt KFLATBUFSIZE = 64;
+#endif // _SENDEBUG
+    }
+
+// Create instance of concrete ECOM interface implementation
+CSenWsiPlugin* CSenWsiPlugin::NewL(TAny* aManager)
+    {
+    MSenCoreServiceManager* manager =
+        reinterpret_cast<MSenCoreServiceManager*>(aManager);
+    
+    CSenWsiPlugin* self = new (ELeave) CSenWsiPlugin(*manager);
+    CleanupStack::PushL (self);
+    self->ConstructL();
+    CleanupStack::Pop();
+    return self;
+    }
+
+// Constructor
+CSenWsiPlugin::CSenWsiPlugin(MSenCoreServiceManager& aManager)
+    : iManager(aManager)
+    {
+    }
+
+CSenWsiPlugin::~CSenWsiPlugin()
+    {
+    TLSLOG(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,(_L("CSenWsiPlugin::~CSenWsiPlugin()")));
+    }
+
+// Second phase construction.
+void CSenWsiPlugin::ConstructL()
+    {
+    TLSLOG(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,(_L("CSenWsiPlugin::ConstructL")));
+    
+    BaseConstructL(KWsiFrameworkXMLNS, KFrameworkLocalname);
+    }
+/*
+RFileLogger* CSenWsiPlugin::Log() const
+    {
+    return iManager.Log();
+    }
+*/
+
+TInt CSenWsiPlugin::RegisterServiceDescriptionL( MSenServiceDescription& aServiceDescription )
+    {
+    TInt retVal(KErrNone);
+    
+#ifdef _SENDEBUG
+    TPtrC8 contract = aServiceDescription.Contract();
+    TPtrC8 endpoint = aServiceDescription.Endpoint();
+    TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,"CSenWsiPlugin::RegisterServiceDescriptionL");
+    TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel," - creating session from description.");
+    TLSLOG_FORMAT((KSenCoreServiceManagerLogChannelBase  , KMinLogLevel, _L8(" - Endpoint: '%S'"), &endpoint));
+    TLSLOG_FORMAT((KSenCoreServiceManagerLogChannelBase  , KMinLogLevel, _L8(" - Contract: '%S'"), &contract));
+#endif // _SENDEBUG
+
+    if( aServiceDescription.Endpoint().Length() == 0 )
+        {
+        TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel," - Endpoint is zero-lenght(!), cannot register such SD.");
+        return KErrSenNoEndpoint;
+        }
+
+
+    // WS-I sessions are matched by consumer id.
+    // This way we can avoid session sharing/multiple consumers
+     
+    CSenBasicWebServiceSession* pSession = CSenBasicWebServiceSession::NewLC(*this);
+    retVal = pSession->InitializeFromL(aServiceDescription);
+    
+    if( retVal == KErrNone )
+        {
+        // Takes the ownership of this session
+        retVal = Manager().AddServiceDescriptionL(pSession);
+        CleanupStack::Pop(pSession);
+        }
+    else
+        {
+        CleanupStack::PopAndDestroy( pSession );
+        TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,"CSenWsiPlugin::RegisterServiceDescriptionL:");
+        TLSLOG_FORMAT((KSenCoreServiceManagerLogChannelBase  , KMinLogLevel, _L8("- Session->InitializeFromL failed: %d"), retVal));
+        }
+    return retVal;
+    }
+
+TInt CSenWsiPlugin::UnregisterServiceDescriptionL( MSenServiceDescription& aServiceDescription )
+    {
+    TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,"CSenWsiPlugin::UnregisterServiceDescriptionL");
+    TInt retVal(KErrNone);
+    
+    if(aServiceDescription.DescriptionClassType() == MSenServiceDescription::EBasicWebServiceSession)
+        {
+        CSenBasicWebServiceSession* pSession = 
+            (CSenBasicWebServiceSession*) &aServiceDescription;
+        retVal = Manager().RemoveServiceDescriptionL(*pSession);
+        }
+        
+    return retVal;
+    }
+
+
+const TDesC8& CSenWsiPlugin::Id()
+    {   
+    return KDefaultBasicWebServicesFrameworkID(); // "WS-I"
+    }
+
+TInt CSenWsiPlugin::AddServiceDescriptionL(MSenServiceDescription& aPattern,
+                                           MSenRemoteServiceConsumer& /* aRemoteConsumer */,
+                                           HBufC8*& /* aErrorMsg */)
+    {
+    // Currently, accept only SDs, which explicitly declare WS-I framework ID.
+    if(aPattern.FrameworkId() != KDefaultBasicWebServicesFrameworkID)
+        {
+        return 0;
+        }
+        
+    TPtrC8 endpoint = aPattern.Endpoint();
+    if( endpoint.Length() > 0 )
+        {
+        CSenBasicWebServiceSession* pNewSession =
+            (CSenBasicWebServiceSession*) NewServiceDescriptionL();
+        CleanupStack::PushL(pNewSession);
+
+        // InitializeFromL call copies the contract and endpoint:
+        TInt retVal = pNewSession->InitializeFromL(aPattern);
+        if( retVal != KErrNone )
+            {
+            CleanupStack::PopAndDestroy();
+            TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,"CSenWsiPlugin::AddServiceDescriptionL:");
+            TLSLOG_FORMAT((KSenCoreServiceManagerLogChannelBase  , KMinLogLevel, _L8("- New session->InitializeFromL failed: %d"), retVal));
+            return 0;
+            }
+        else // init ok
+            {
+            // Core / XML DAO takes ownership of new session:
+            // - if duplicate (equal primary keys) exists, it is deleted
+            Manager().AddServiceDescriptionL( pNewSession ); 
+            CleanupStack::Pop( pNewSession );
+            return 1; // one new session added
+            }
+        }
+    else
+        {
+        TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel," - No endpoint; new session could not be added.");
+        return 0; // zero added
+        }
+    }
+
+TInt CSenWsiPlugin::CreateServiceSessionL( MSenServiceDescription& aServiceDescription,
+                                           MSenServiceDescription& /* aPattern */,
+                                           CSenServiceSession*& aNewSession,
+                                           MSenRemoteServiceConsumer& /* aRemoteConsumer */,
+                                           HBufC8*& /* pErrorMsg */ )
+    {
+    TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,"CSenWsiPlugin::CreateServiceSessionL");
+
+    CSenBasicWebServiceSession* pNewSession = NULL;
+    TInt retVal(KErrNone);
+    if(aServiceDescription.DescriptionClassType() == MSenServiceDescription::EBasicWebServiceSession)
+        {
+        pNewSession = (CSenBasicWebServiceSession*) &aServiceDescription;
+        TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,"- Service description is already a basic web service (WS-I) session");
+        //pNewSession->CopyFacetsFromL(aPattern); // not performed with WS-I
+        retVal = KErrNone;
+        }
+    else
+        {
+        TPtrC8 endpoint = aServiceDescription.Endpoint();
+        if(endpoint.Length()>0)
+            {
+            pNewSession = (CSenBasicWebServiceSession*) NewServiceDescriptionL();
+            CleanupStack::PushL(pNewSession);
+
+            // InitializeFromL call copies the contract and endpoint:
+            retVal = pNewSession->InitializeFromL(aServiceDescription);
+
+#ifdef _SENDEBUG
+            CBufFlat* pBuf = CBufFlat::NewL(KFLATBUFSIZE);
+            CleanupStack::PushL(pBuf);
+            RBufWriteStream writeStream;
+            writeStream.Open(*pBuf);
+            CleanupClosePushL(writeStream);
+            pNewSession->WriteAsXMLToL(writeStream);
+            TPtr8 ptr = pBuf->Ptr(0);
+            TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,"- New WS-I service session as XML:");
+            TLSLOG_ALL(KSenCoreServiceManagerLogChannelBase  , KMaxLogLevel,( ptr ));
+            CleanupStack::PopAndDestroy(2); // writeStream.Close(), pBuf
+#endif // _SENDEBUG        
+        
+            if( retVal == KErrNone ) // initialize from pattern OK
+                {
+                // NOTE: Core ALWAYS takes ownership of new session:
+                // - if some session with equal primary keys exists, it is deleted
+                TInt retVal = Manager().AddServiceDescriptionL(pNewSession);
+                CleanupStack::Pop(pNewSession);
+#ifdef _SENDEBUG
+                if(retVal!=KErrNone)
+                    {
+                    TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,"CSenBasicWsiPlugin::CreateServiceSessionL");
+                    TLSLOG_FORMAT((KSenCoreServiceManagerLogChannelBase  , KNormalLogLevel, _L8(" - CoreServiceMngr::AddServiceDescriptionL returned: %d"), retVal));
+                    }
+#endif // _SENDEBUG
+                }
+            else // initialize from pattern failed!
+                {
+                TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,"CSenWsiPlugin::CreateServiceSessionL:");
+                TLSLOG_FORMAT((KSenCoreServiceManagerLogChannelBase  , KMinLogLevel, _L8("- New session->InitializeFromL failed: %d"), retVal));
+                CleanupStack::PopAndDestroy(pNewSession);
+                }
+            }
+        else
+            {
+            TLSLOG_L(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel," - No endpoint; returning KErrSenNoEndpoint");
+            retVal = KErrSenNoEndpoint; // no endpoint for basic web service session
+            }
+        }
+    aNewSession = pNewSession; 
+    return retVal;
+    }
+
+TInt CSenWsiPlugin::OnEvent(const TInt /* aEvent */, TAny* /* apArgument */) 
+    {
+//    LOG_WRITE_L("CSenBasicWsiPlugin::OnEvent");
+//    LOG_WRITEFORMAT((_L8("-event code: %d"), aEvent));
+    TInt retVal(KErrNone);
+
+    return retVal;
+    }
+
+TAny* CSenWsiPlugin::ExtendedInterface()
+    {
+    // There is no extended interface in Basic WS framework at the moment
+    return NULL;
+    }
+
+CSenWSDescription* CSenWsiPlugin::NewServiceDescriptionL()
+    {
+    CSenBasicWebServiceSession* pSD =
+        CSenBasicWebServiceSession::NewLC(*this);
+    pSD->SetFrameworkIdL(KDefaultBasicWebServicesFrameworkID);
+    CSenFacet* pCompleteOn = CSenFacet::NewL();
+    CleanupStack::PushL(pCompleteOn);
+    pCompleteOn->SetNameL(KCompleteMessagesFacet);
+    pSD->SetFacetL(*pCompleteOn);
+    CleanupStack::PopAndDestroy(pCompleteOn);
+    CleanupStack::Pop(pSD);
+    return pSD;
+    }
+
+/**
+* Return the ServiceManager for which this instance is working.
+* This is used by the ServiceSession instances created by this framework.
+*
+* Note, in Sen, MSenCoreServiceManager so all Frameworks
+* return their "owner" - i.e. - the only service manager in Sen Framework
+*
+* @return (MSenCoreServiceManager)
+*/
+
+MSenCoreServiceManager& CSenWsiPlugin::Manager()
+    {
+    return iManager;
+    }
+
+/**
+* Set the ServiceManager to which this instance reports.
+* The (singleton) ServiceManager calls this method when
+* it instantiates a framework.
+*
+* @param aServiceManager The singleton ServiceManager in the system.
+*/
+void CSenWsiPlugin::SetManager(MSenCoreServiceManager& aServiceManager)
+    {
+    TLSLOG(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,_L("CSenWsiPlugin::SetManager(.)"));
+    iManager = aServiceManager;
+    }
+
+/**
+* Return an object that can do SAX based parsing of a XML fragment
+* that contains framework specific configuration information.
+* The ServiceManager asks for this BaseFragment upon startup
+* in order to give this framework a chance to read its configuration
+* information from the central ServiceManager configuration document.
+*
+* @return (CSenBaseFragment)
+*/
+CSenBaseFragment& CSenWsiPlugin::ConfigParser()
+    {
+    TLSLOG(KSenCoreServiceManagerLogChannelBase  , KMinLogLevel,(_L("CSenWsiPlugin::ConfigParser()")));
+    return *this;
+    }
+
+/**
+* Write the ServiceInvocationFramework configuration as XML to a HBufC8.
+*
+* This method is invoked by the ServiceManager when it saves
+* its state and/or configuration.
+*
+* Upon startup the chunk of XML that is written will be passed back to
+* the configuation parser of the framework.
+*
+* The "schema" that shall be adhered to is:
+* <pre>
+* &lt;element name="Framework"&gt;
+*       &lt;any/&gt;&lt;!-- this is where implementations write additional
+*       information --&gt;
+*       &lt;attribute name="class" type="String"&gt;
+*    &lt;!-- In Symbian the class attribute is used as cue for
+*    the ECOM Resolver --&gt;
+* &lt;/element&gt;
+* </pre>
+*
+* @param aTo - a HBufC8 to which the framework should write its configuration
+*/
+
+
+void CSenWsiPlugin::EndElementL(const TDesC8& aNsUri,
+                                const TDesC8& aLocalName,
+                                const TDesC8& aQName)
+    {
+    TLSLOG_FORMAT((KSenCoreServiceManagerLogChannelBase  , KMinLogLevel, _L8("WS-I plugin @ end of element: %S (xmlns='%S', localname='%S')"),
+        &aQName, &aNsUri, &aLocalName));
+    CSIF::EndElementL(aNsUri,aLocalName,aQName);
+    }
+
+// over-ride CSenBaseFragment
+HBufC* CSenWsiPlugin::AsXmlUnicodeL()
+    {
+    HBufC8* pUtf8 = AsXmlL();
+    CleanupStack::PushL(pUtf8);
+    HBufC* pAsXmlInUnicode = SenXmlUtils::ToUnicodeLC(*pUtf8);
+    CleanupStack::Pop(pAsXmlInUnicode);
+    CleanupStack::PopAndDestroy(pUtf8);
+    return pAsXmlInUnicode;
+    }
+
+HBufC8* CSenWsiPlugin::AsXmlL()
+    {
+    _LIT8(KLessFramework,"<Framework ");//CodeScannerWarning
+    _LIT8(KXmlns,"xmlns=\"");
+    _LIT8(KQuot,"\" ");
+    _LIT8(KClassQuot,"class=\"");
+    _LIT8(KQuotNewLine,"\"/>\n");
+    HBufC8* retVal = HBufC8::NewLC(256);
+    TPtr8 ptr = retVal->Des();
+    ptr.Append(KLessFramework);
+    ptr.Append(KXmlns);
+    ptr.Append(KWsiFrameworkXMLNS);
+    ptr.Append(KQuot);
+
+    ptr.Append(KClassQuot);
+    ptr.Append(KWsiFrameworkCue);
+    ptr.Append(KQuotNewLine);
+    CleanupStack::Pop(); // retVal
+    return retVal;
+    }
+
+// New methods
+
+TInt CSenWsiPlugin::SetTransportPropertiesL(MSenTransport& aTransport)
+    {
+    //CSenHttpTransportProperties* pProps = CSenHttpTransportProperties::NewLC();
+    CSenTransportProperties* pProps = CSenTransportProperties::NewLC();
+    pProps->SetPropertyL(KSenSoapActionHeaderName, KSenSoapActionHeaderValueEmpty, KHttpHeaderType);        
+    HBufC8* pPropsAsXml = pProps->AsUtf8L();
+    CleanupStack::PopAndDestroy(pProps);
+    CleanupStack::PushL( pPropsAsXml );
+    TInt retVal = aTransport.SetPropertiesL( *pPropsAsXml, MSenLayeredProperties::ESenFrameworkLayer, NULL );
+    CleanupStack::PopAndDestroy( pPropsAsXml );
+    return retVal;
+    }
+// END OF FILE
+
+