LisfmwrkUtils.hxx

Go to the documentation of this file.

// Copyright 2022 Siemens Digital Industries Software
// ==================================================
// Copyright 2017.
// Siemens Product Lifecycle Management Software Inc.
// All Rights Reserved.
// ==================================================
// Copyright 2022 Siemens Digital Industries Software

#ifndef LIS0LISFMWRK_LISFMWRKUTILS_HXX
#define LIS0LISFMWRK_LISFMWRKUTILS_HXX

#include <string>
#include <vector>

#include <unidefs.h>

#include <base_utils/TcBaseTypes.hxx>
#include <Lis0lisfmwrk/Lis0ServiceDef.hxx>
#include <Lis0lisfmwrk/libLis0lisfmwrk_exports.h>


namespace lis0lisfmwrk
{
    class LisfmwrkUtils;
}

enum RequestMethod
{
    GET,    
    POST,   
    PUT     
};  
enum ResponseFormat
{
    XML,                       
    RDF_XML,                   
    OSLC_COMPACT_XML,          
    JSON                       
};

typedef struct UserOAuthTokens
{
    std::string lis0AccessToken;            
    std::string lis0AccessTokenSecret;      
    std::string lis0RequestToken;           
    std::string lis0RequestTokenSecret;     
} UserTokens;

typedef struct HttpRequestInput
{
    std::string url;                               
    RequestMethod method;                          
    std::string postData;                          
    bool isAuthRequired;                           
    std::string consumerKey;                       
    std::string consumerSecret;                    
    std::string tokenKey;                          
    std::string tokenSecret;                       
    std::string cookieStr;                         
    std::map<std::string, std::string> headers;    
} HttpRequestInputS;

typedef struct ServiceProviderInfo
{
    std::string providerUrl;            
    std::string providerName;           
    std::string description;            
    std::vector<std::string> domain;    
} ServiceProviderInfoS;

typedef struct ServiceProviderCatalogInfoExtend : ServiceProviderCatalogInfo
{
    std::vector <std::string> catalogDomain;     
} LIS_service_catalog_info_extend_t;

typedef struct RootServiceResponseExtend : RootServiceResponseInfo
{
    std::vector<LIS_service_catalog_info_t> catalogList;    
    LIS_Oauth_info_s oauthInfo;                             
} LIS_rootservice_response_extend_t;

typedef struct LIS_delegated_dialog_info_extend_s:LIS_delegated_dialog_info_s
{
    std::string domain;                 
} LIS_delegated_dialog_info_extend_t;

typedef struct LIS_factory_service_info_extend_s:LIS_factory_service_info_s
{
    std::string domain;          
} LIS_factory_service_info_extend_t;

typedef struct ServiceResponseInfoExtend 
{
    std::vector<LIS_delegated_dialog_info_extend_t> dialogList;             
    std::vector<LIS_factory_service_info_extend_t> factoryServiceList;      
} LIS_service_info_extend_t;


class LIS0LISFMWRK_API lis0lisfmwrk::LisfmwrkUtils
{
    public:
    static int createHttpRequestInput( const std::string &url,               
                                       const RequestMethod method,           
                                       const std::string &postData,          
                                       const tag_t userAuthentication,       
                                       const ResponseFormat &format,         
                                       HttpRequestInputS *requestInput       
                                       );
    static int requestHttps( const bool isRequestTokenUrl,                 
                             const HttpRequestInputS &requestInput,        
                             std::string& responseString,                  
                             long &responseCode,                           
                             std::string& eTagString,                      
                             int getResponseHeader=0                       
                             );
    static int requestHttps( const HttpRequestInputS &requestInput,     
                             std::string& responseString                
                             );
    static int requestHttps( const HttpRequestInputS &requestInput,     
                             std::string& responseString,               
                             long &responseCode,                        
                             std::string& eTagString,                   
                             int getResponseHeader=0                    
                             );
    static int parseRootServiceContent( const std::string& responseContent,                     
                                        LIS_rootservice_response_extend_t &responseInfo         
                                        );
    static int parseCatalogContent( const std::string& responseContent,                     
                                    std::vector<ServiceProviderInfo> &providerInfoList      
                                    );
    static int parseServiceContent( const std::string& responseContent,         
                                    LIS_service_info_extend_t &serviceInfo      
                                    );
    static int parseResourceContent( const std::string& responseContent,    
                                     LIS_resource_info_t &resourceInfo      
                                     );
    static int validateLicense( const char* licensePackage    
                                );
    static int getOAuthAuthorizationURL( const tag_t serviceProvider,   
                                         char** userAuthorizationUrl    
                                         );
    static int getRelationTypes( const std::string& uidContextObj,          
                                 const std::string& remoteObjType,          
                                 const std::string& uidServiceProvider,     
                                 std::vector<std::string>&relationNames     
                                 );
    static int getRelationTypesTags( const std::string& uidContextObj,       
                                     const std::string& remoteObjType,       
                                     const std::string& uidServiceProvider,  
                                     std::vector< tag_t >&relationNames      
                                     );
    static int queryAllRelationTypeRevise2( const tag_t serviceProviderType,       
                                            const tag_t primaryObjType,            
                                            const std::string& remoteObjectType,   
                                            std::vector<tag_t>&relationNames       
                                            );
    static int queryAllRelationTypeRevise( const tag_t serviceProviderType,      
                                           const tag_t primaryObjType,           
                                           const std::string &remoteObjectType,  
                                           std::vector<tag_t>&relationNames,     
                                           bool& isRelTypeExist                  
                                           );
    static int findAllPrimaryObjForRemoteObj( const tag_t serviceProviderType,                   
                                              const std::string& remoteObjectType,               
                                              std::vector<tag_t> &supportedPrimaryObjTypes       
                                              );
    static int findExactMatchOfPrimaryObjectList( const tag_t primaryObjType,                              
                                                  const std::vector<tag_t > &supportedPrimaryObjTypes,     
                                                  std::vector<tag_t>& exactListOfprimaryObjTypes           
                                                  );

    static int getSSOParamsFromRootsvc(  const std::string &responseString, 
                                          std::string &ssoAppId, 
                                          std::string &ssoSvcUrl  );
    static int getAuthorizationURLFromRootServices( const std::string& responseString,      
                                                    std::string&accessTokenUrl,             
                                                    std::string& requestTokenUrl,           
                                                    std::string& userAuthorizaitonUrl,      
                                                    std::string &consumerKeyUrl);           
private:

};
#include <Lis0lisfmwrk/libLis0lisfmwrk_undef.h>
#endif