Return to wsmanIndicationHandler.cpp CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Handler / wsmanIndicationHandler

BUG#: 9637
TITLE: Adding support of PUSH_WTH_ACK delivery mode for WSMAN indications..
DESCRIPTION: Added PUSH_WTH_ACK delivery mode support for WSMAN indications.

//%LICENSE////////////////////////////////////////////////////////////////
//
// Licensed to The Open Group (TOG) under one or more contributor license
// agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
// this work for additional information regarding copyright ownership.
// Each contributor licenses this file to you under the OpenPegasus Open
// Source License; you may not use this file except in compliance with the
// License.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//////////////////////////////////////////////////////////////////////////
//
//%/////////////////////////////////////////////////////////////////////////////

#include <Pegasus/ExportClient/WSMANExportClient.h>
#include <Pegasus/Handler/CIMHandler.h>
#include <Pegasus/Repository/CIMRepository.h>
#include <Pegasus/Config/ConfigManager.h>
#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/PegasusVersion.h>
#include <Pegasus/Common/Constants.h>
#include <Pegasus/Common/SSLContext.h>
#include <Pegasus/Common/System.h>
#include <Pegasus/Common/Tracer.h>
#include <Pegasus/Common/HostLocator.h>

PEGASUS_NAMESPACE_BEGIN

PEGASUS_USING_STD;

class Tracer;
static Boolean verifyListenerCertificate(SSLCertificateInfo& certInfo)
{
    // ATTN: Add code to handle listener certificate verification.
    //
    return true;
}


class PEGASUS_HANDLER_LINKAGE wsmanIndicationHandler: public CIMHandler
{
public:
      
    wsmanIndicationHandler()
    {
        PEG_METHOD_ENTER(TRC_IND_HANDLER,
            "wsmanIndicationHandler::wsmanIndicationHandler");
        PEG_METHOD_EXIT();
    }
      
    virtual ~wsmanIndicationHandler()
    {
        PEG_METHOD_ENTER(TRC_IND_HANDLER,
            "wsmanIndicationHandler::~wsmanIndicationHandler");
        PEG_METHOD_EXIT();
    }
     
    void initialize(CIMRepository* repository)
    {

    }

    void terminate()
    {

    }

    void handleIndication(
    const OperationContext& context,
    const String nameSpace,
    CIMInstance& indicationInstance,
    CIMInstance& indicationHandlerInstance,
    CIMInstance& indicationSubscriptionInstance,
    ContentLanguageList& contentLanguages)
    {
        PEG_METHOD_ENTER(TRC_IND_HANDLER,
            "wsmanIndicationHandler::handleIndication()");

        //get destination for the indication
        Uint32 pos = indicationHandlerInstance.findProperty(
                CIMName (PEGASUS_PROPERTYNAME_LSTNRDST_DESTINATION));
        if (pos == PEG_NOT_FOUND)
        {
            MessageLoaderParms param(
                "Handler.wsmanIndicationHandler.wsmanIndicationHandler."
                    "MALFORMED_HANDLER_INSTANCE",
                "Malformed wsman handler instance, "
                    "\'Destination\' property is not found.");

            PEG_TRACE_CSTRING(TRC_DISCARDED_DATA, Tracer::LEVEL1,
                "Malformed wsman handler instance,"
                "\'Destination\' property is not found.");

            PEG_METHOD_EXIT();
            throw PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED,
                      MessageLoader::getMessage(param));
        }
        
        CIMProperty prop = indicationHandlerInstance.getProperty(pos);

        String dest;
        try
        {
            prop.getValue().get(dest);
        }
        catch (TypeMismatchException&)
        {
            MessageLoaderParms param(
                "Handler.wsmanIndicationHandler.wsmanIndicationHandler."
                    "DESTINATION_TYPE_MISMATCH",
                "Malformed wsman handler instance, "
                    "\'Destination\' property type mismatch.");

            PEG_TRACE_CSTRING(TRC_DISCARDED_DATA, Tracer::LEVEL1,
                "Malformed wsman handler instance, "
                "\'Destination\' property type mismatch.");

            PEG_METHOD_EXIT();
            throw PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED,
                      MessageLoader::getMessage(param));
        }

        PEG_TRACE ((TRC_INDICATION_GENERATION, Tracer::LEVEL4,
            "PG_IndicationHandlerWSMANMapper %s:%s.%s processing %s Indication "
            "for destination %s",
           (const char*)(nameSpace.getCString()),
           (const char*)(indicationHandlerInstance.getClassName().getString().
           getCString()),
           (const char*)(indicationHandlerInstance.getProperty(
           indicationHandlerInstance.findProperty(PEGASUS_PROPERTYNAME_NAME)).
           getValue().toString().getCString()),
           (const char*)(indicationInstance.getClassName().getString().
           getCString()), (const char*)(dest.getCString())));

        Uint16 delMode;
        pos = indicationHandlerInstance.findProperty(
            CIMName (PEGASUS_PROPERTYNAME_WSM_DELIVERY_MODE));
        if ( pos == PEG_NOT_FOUND)
        {
            MessageLoaderParms param(
                "Handler.wsmanIndicationHandler.wsmanIndicationHandler."
                    "MALFORMED_HANDLER_INSTANCE",
                "Malformed wsman handler instance, "
                    "\'DeliveryMode\' property is not found.");

            PEG_TRACE_CSTRING(TRC_DISCARDED_DATA, Tracer::LEVEL1,
                "Malformed wsman handler instance,"
                "\'DeliveryMode\' property is not found.");

            PEG_METHOD_EXIT();
            throw PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED,
                      MessageLoader::getMessage(param));
        }
        prop = indicationHandlerInstance.getProperty(pos);

        try
        {
            prop.getValue().get(delMode);
        }
        catch (TypeMismatchException&)
        {
            MessageLoaderParms param(
                "Handler.wsmanIndicationHandler.wsmanIndicationHandler."
                    "DELIVERYMODE_TYPE_MISMATCH",
                "Malformed wsman handler instance, "
                    "\'DeliveryMode\' property type mismatch.");

            PEG_TRACE_CSTRING(TRC_DISCARDED_DATA, Tracer::LEVEL1,
                "Malformed wsman handler instance, "
                "\'DeliveryMode\' property type mismatch.");

            PEG_METHOD_EXIT();
            throw PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED,
                MessageLoader::getMessage(param));
        }

        _exportIndication(dest,delMode,indicationInstance,contentLanguages); 
    }

private:
    void _exportIndication(
        String & dest,
        Uint16 & delMode,
        CIMInstance& indicationInstance,
        ContentLanguageList& contentLanguages)
    {
        PEG_METHOD_ENTER(TRC_IND_HANDLER,
            "wsmanIndicationHandle::_exportIndication()");
        try
        {
            static String PROPERTY_NAME__SSLCERT_FILEPATH =
                "sslCertificateFilePath";
            static String PROPERTY_NAME__SSLKEY_FILEPATH  = "sslKeyFilePath";

            //
            // Get the sslCertificateFilePath property from the Config Manager.
            //
            ConfigManager* configManager = ConfigManager::getInstance();

            String certPath;
            certPath = ConfigManager::getHomedPath(
                configManager->getCurrentValue(
                    PROPERTY_NAME__SSLCERT_FILEPATH));

            //
            // Get the sslKeyFilePath property from the Config Manager.
            //
            String keyPath;
            keyPath = ConfigManager::getHomedPath(
                configManager->getCurrentValue(
                    PROPERTY_NAME__SSLKEY_FILEPATH));

            String trustPath;
            String randFile;

#ifdef PEGASUS_SSL_RANDOMFILE
            randFile =
                ConfigManager::getHomedPath(PEGASUS_SSLSERVER_RANDOMFILE);
#endif

            Monitor monitor;
            HTTPConnector httpConnector(&monitor);
            
            WSMANExportClient exportclient(&httpConnector,&monitor);
            deliveryMode mode = _maptodeliveryModeEnum(delMode); 
            exportclient.setDeliveryMode(mode);            
            Uint32 portNumber = 0;
            Boolean useHttps = false;
            String hostStr;
            String destStr = dest;
            char hostName[PEGASUS_MAXHOSTNAMELEN];
            _decodeDestination(
                dest,
                portNumber,
                useHttps,
                hostStr,
                hostName,
                destStr);
            
#ifndef PEGASUS_OS_ZOS

            if (useHttps)
            {
#ifdef PEGASUS_HAS_SSL
                PEG_TRACE_CSTRING(TRC_IND_HANDLER, Tracer::LEVEL4,
                    "Build SSL Context...");

                SSLContext sslcontext(trustPath,
                    certPath, keyPath, verifyListenerCertificate, randFile);
                exportclient.connect (hostName, portNumber, sslcontext);
#else
                PEG_TRACE((
                    TRC_DISCARDED_DATA, Tracer::LEVEL1,
                    "wsmanIndicationHandler::handleIndication failed to "
                    "deliver indication: "
                    "https not supported "
                    "in Destination %s",
                    (const char*) dest.getCString()));

                MessageLoaderParms param(
                    "Handler.wsmanIndicationHandler.wsmanIndicationHandler."
                        "CANNOT_DO_HTTPS_CONNECTION",
                    "SSL is not available. "
                        "Cannot support an HTTPS connection.");

                PEG_METHOD_EXIT();
                throw PEGASUS_CIM_EXCEPTION(
                    CIM_ERR_FAILED,
                    MessageLoader::getMessage(param));
#endif
            }
            else
            {
                exportclient.connect (hostName,portNumber );
            }
#else
            // On zOS the ATTLS facility is using the port number(s) defined
            // of the outbound policy to decide if the indication is
            // delivered through a SSL secured socket. This is totally
            // transparent to the CIM Server.
            exportclient.connect (hostName, portNumber);

#endif
            // check destStr, if no path is specified, use "/" for the URI
            Uint32 slash = destStr.find ("/");
            if (slash != PEG_NOT_FOUND)
            {
                exportclient.exportIndication(
                    destStr.subString(slash), indicationInstance,
                    contentLanguages, dest);
            }
            else
            {
                exportclient.exportIndication(
                    "/", indicationInstance, contentLanguages, dest);
            }

        }
        catch(Exception& e)
        {
            //ATTN: Catch specific exceptions and log the error message
            // as Indication delivery failed.
            String msg = e.getMessage();

            PEG_TRACE((TRC_DISCARDED_DATA, Tracer::LEVEL1,
                "wsmanIndicationHandler::handleIndication failed to deliver "
                "indication due to Exception: %s",
                (const char*)e.getMessage().getCString()));

            PEG_METHOD_EXIT();
            throw PEGASUS_CIM_EXCEPTION(CIM_ERR_FAILED, msg);
        }

        PEG_METHOD_EXIT();
    }
    
    void _decodeDestination(
    String & dest,
    Uint32 & portNumber,
    Boolean & useHttps,
    String & hostStr,
    char  hostName[PEGASUS_MAXHOSTNAMELEN],
    String & destStr)
    {
        PEG_METHOD_ENTER(TRC_IND_HANDLER,
            "wsmanIndicationHandler::_decodeDestination()");
        Uint32 colon = dest.find (":");
        // If the URL has https (https://hostname:port/... or
        // https://hostname/...) then use SSL for Indication delivery.
        // If it has http (http://hostname:port/...
        // or http://hostname/...) then do not use SSL.
        if (colon != PEG_NOT_FOUND)
        {
            String httpStr = dest.subString(0, colon);
            if (String::equalNoCase(httpStr, "https"))
            {
                useHttps = true;
            }
            else if (String::equalNoCase(httpStr, "http"))
            {
                useHttps = false;
            }  
            else
            {
                String msg = _getMalformedExceptionMsg(dest);

                PEG_TRACE((TRC_DISCARDED_DATA,Tracer::LEVEL1,"%s%s",
                    (const char*)msg.getCString(),
                    (const char*)dest.getCString()));

                PEG_METHOD_EXIT();
                throw PEGASUS_CIM_EXCEPTION(CIM_ERR_NOT_SUPPORTED,
                    msg);
            }
        }
        else
        {
            String msg = _getMalformedExceptionMsg(dest);

            PEG_TRACE((TRC_DISCARDED_DATA,Tracer::LEVEL1,"%s%s",
                (const char*)msg.getCString(),
                (const char*)dest.getCString()));

            PEG_METHOD_EXIT();
            throw PEGASUS_CIM_EXCEPTION(CIM_ERR_NOT_SUPPORTED, msg);
        }
        String doubleSlash = dest.subString(colon + 1, 2);
        if (String::equalNoCase(doubleSlash, "//"))
        {
            destStr = dest.subString(colon + 3, PEG_NOT_FOUND);
        }
        else
        {
            String msg = _getMalformedExceptionMsg(dest);

            PEG_TRACE((TRC_DISCARDED_DATA, Tracer::LEVEL1,"%s%s",
                (const char*)msg.getCString(),
                (const char*)dest.getCString()));

            PEG_METHOD_EXIT();
            throw PEGASUS_CIM_EXCEPTION(CIM_ERR_NOT_SUPPORTED, msg);
        }   

        HostLocator addr(destStr.subString(0, destStr.find("/")));
        if (addr.isValid())
        {
            strcpy(hostName, addr.getHost().getCString());
            if (addr.isPortSpecified())
            {
                portNumber = addr.getPort();
            }
            else if (useHttps)
            {
                portNumber = System::lookupPort(
                    WBEM_HTTPS_SERVICE_NAME,
                    WBEM_DEFAULT_HTTPS_PORT);
            }  
            else
            {
                portNumber = System::lookupPort(
                    WBEM_HTTP_SERVICE_NAME,
                    WBEM_DEFAULT_HTTP_PORT);
            }
        }
        else
        {
            String msg = _getMalformedExceptionMsg(dest);

            PEG_TRACE((TRC_DISCARDED_DATA, Tracer::LEVEL1,"%s%s",
                (const char*)msg.getCString(),
                (const char*)dest.getCString()));

            PEG_METHOD_EXIT();
            throw PEGASUS_CIM_EXCEPTION(CIM_ERR_NOT_SUPPORTED, msg);
        }  
    }

    String _getMalformedExceptionMsg(
        String destinationValue)
    {
        MessageLoaderParms param(
            "Handler.wsmanIndicationHandler.wsmanIndicationHandler."
                "DESTINATION_NOT_VALID",
            "Malformed wsman handler instance, "
                "\'Destination\' property \"$0\" is not valid.",
                destinationValue);
        return (String(MessageLoader::getMessage(param)));
    }

    deliveryMode _maptodeliveryModeEnum(Uint16 & delMode)
    {
        deliveryMode mode;
        switch(delMode)
        {
            case 2: mode = Push;
                break;
            case 3: mode = PushWithAck;
                break;
            case 4: mode = Events;
                break;
            case 5: mode = Pull;
                break;
            case 6: mode = DMTF_Reserved;
                break;
            case 7:mode = Vendor_Reserved;
                break;

            default:mode = Push;
                break;

        }
        return mode;
    }

};

PEGASUS_NAMESPACE_END

PEGASUS_USING_PEGASUS;

// This is the entry point into this dynamic module.

#ifdef PEGASUS_ENABLE_PROTOCOL_WSMAN
extern "C" PEGASUS_EXPORT CIMHandler* PegasusCreateHandler(
    const String& handlerName)
{
    if (handlerName == "wsmanIndicationHandler")
    {
        return new wsmanIndicationHandler;
    }

    return 0;
}
#endif