#include <XML_String_Intf.h>

Inheritance diagram for OpenDDS::DCPS::QOS_XML_String_Handler:

Collaboration diagram for OpenDDS::DCPS::QOS_XML_String_Handler:

Public Member Functions
	QOS_XML_String_Handler (XML::XML_Error_Handler *error_handler=0)

	~QOS_XML_String_Handler ()

DDS::ReturnCode_t	init (const ACE_TCHAR *membuf)

void	add_search_path (const ACE_TCHAR environment, const ACE_TCHAR relpath)

Public Member Functions inherited from OpenDDS::DCPS::QOS_XML_Handler
	QOS_XML_Handler ()

	~QOS_XML_Handler ()

DDS::ReturnCode_t	get_datawriter_qos (::DDS::DataWriterQos &dw_qos, const ACE_TCHAR profile_name, const ACE_TCHAR topic_name)

DDS::ReturnCode_t	get_datareader_qos (::DDS::DataReaderQos &dr_qos, const ACE_TCHAR profile_name, const ACE_TCHAR topic_name)

DDS::ReturnCode_t	get_topic_qos (::DDS::TopicQos &tp_qos, const ACE_TCHAR profile_name, const ACE_TCHAR topic_name)

DDS::ReturnCode_t	get_publisher_qos (::DDS::PublisherQos &pub_qos, const ACE_TCHAR *profile_name)

DDS::ReturnCode_t	get_subscriber_qos (::DDS::SubscriberQos &sub_qos, const ACE_TCHAR *profile_name)

DDS::ReturnCode_t	get_participant_qos (::DDS::DomainParticipantQos &sub_qos, const ACE_TCHAR *profile_name)

DDS::ReturnCode_t	addQoSProfile (const dds::qosProfile &profile)

DDS::ReturnCode_t	addQoSProfileSeq (const dds::qosProfile_seq &profiles)

DDS::ReturnCode_t	delQoSProfile (const ACE_TCHAR *profileName)

size_t	length () const

::dds::qosProfile	getProfile (const ACE_TCHAR *profileName)

const ::dds::qosProfile_seq &	get ()

Private Attributes
XML::XML_Schema_Resolver< XML::Environment_Resolver > *	res_
	Schema resolver. More...

XML::XML_Error_Handler *	eh_
	Error handler. More...

XERCES_CPP_NAMESPACE::XercesDOMParser *	parser_
	Parser. More...

XERCES_CPP_NAMESPACE::DOMDocument *	finalDoc_

Additional Inherited Members
Protected Member Functions inherited from OpenDDS::DCPS::QOS_XML_Handler
::dds::qosProfile *	get_profile (const ACE_TCHAR *profile_name)

Protected Attributes inherited from OpenDDS::DCPS::QOS_XML_Handler
::dds::qosProfile_seq	profiles_

Detailed Description

Definition at line 41 of file XML_String_Intf.h.

Constructor & Destructor Documentation

◆ QOS_XML_String_Handler()

OpenDDS::DCPS::QOS_XML_String_Handler::QOS_XML_String_Handler ( XML::XML_Error_Handler * error_handler = 0 )

explicit

Pass an optional which is called back when there are any errors parsing the input XML. The QOS_XML_String_Handler will assume ownership when a pointer is passed

Definition at line 19 of file XML_String_Intf.cpp.

References ACE_ERROR, ACE_TEXT(), finalDoc_, FACE::TS::Initialize(), LM_ERROR, and parser_.

                                                                                     :
     QOS_XML_Handler(),
     res_(new XML::XML_Schema_Resolver<XML::Environment_Resolver>()),
     eh_(error_handler ? error_handler : new XML::XML_Error_Handler()),
     parser_(0),
     finalDoc_(0)
   {
     try
     {
       // Call Initialize if not already called
       XMLPlatformUtils::Initialize();
 
       ////////////////
       // Create parser
       parser_ =  new XercesDOMParser();
 
       // Create a DomImplementation
       XMLCh* xmlver = XMLString::transcode("XML 1.0");
       DOMImplementation * domImpl = DOMImplementationRegistry::getDOMImplementation(xmlver);
       XMLString::release(&xmlver);
 
       // Create a temporary document with a generic element
       // it shall be replaced in future with final version
       XMLCh* namespaceURI = XMLString::transcode("");
        XMLCh* qualifiedName = XMLString::transcode("temp");
       finalDoc_ = domImpl->createDocument(namespaceURI, qualifiedName,0);
       XMLString::release(&namespaceURI);
       XMLString::release(&qualifiedName);
 
     } catch (const XMLException& toCatch) {
       char* message = XMLString::transcode(toCatch.getMessage());
       ACE_ERROR ((LM_ERROR,
         ACE_TEXT ("QOS_XML_String_Handler::QOS_XML_String_Handler - ")
         ACE_TEXT ("Error during XML initialization! :\n<%C>\n"),
         message));
       XMLString::release(&message);
     }
   }

◆ ~QOS_XML_String_Handler()

OpenDDS::DCPS::QOS_XML_String_Handler::~QOS_XML_String_Handler ( )

Definition at line 58 of file XML_String_Intf.cpp.

References eh_, finalDoc_, parser_, and res_.

   {
     if (finalDoc_ != 0)
       finalDoc_->release();
     delete parser_;
     delete res_;
     delete eh_;
 
     XMLPlatformUtils::Terminate();
   }

Member Function Documentation

◆ add_search_path()

void OpenDDS::DCPS::QOS_XML_String_Handler::add_search_path	(	const ACE_TCHAR *	environment,
		const ACE_TCHAR *	relpath
	)

add_search_path will add a relative path to the XML parsing library. The XML parsing library will use this path to search for the schema

Definition at line 246 of file XML_String_Intf.cpp.

References OPENDDS_END_VERSIONED_NAMESPACE_DECL, and res_.

   {
     res_->get_resolver().add_path(environment,relpath);
   }

◆ init()

DDS::ReturnCode_t OpenDDS::DCPS::QOS_XML_String_Handler::init ( const ACE_TCHAR * membuf )

The init method will open the file and will validate it against the schema. It returns RETCODE_ERROR when any error occurs during parsing

Definition at line 70 of file XML_String_Intf.cpp.

References CORBA::Exception::_info(), ACE_DEBUG, ACE_ERROR, ACE_TEXT(), ACE_TEXT_ALWAYS_CHAR, ACE_String_Base< char >::c_str(), OpenDDS::DCPS::DCPS_debug_level, dds::reader::dds(), eh_, finalDoc_, LM_DEBUG, LM_ERROR, parser_, OpenDDS::DCPS::QOS_XML_Handler::profiles_, res_, DDS::RETCODE_ERROR, and DDS::RETCODE_OK.

   {
     DDS::ReturnCode_t retcode = DDS::RETCODE_OK;
     try
     {
       // Create a InputSource to be used in parser with XML string
       XMLCh * conv = XMLString::transcode(ACE_TEXT_ALWAYS_CHAR (membuf));
       TranscodeToStr xmlTranscoded(conv,"utf-8");
       XMLString::release(&conv);
       MemBufInputSource xmlBuf(xmlTranscoded.str(), xmlTranscoded.length() ,"xml (in memory)");
 
       ///////////////////
       // Configure Parser
       //
       // Perform Namespace processing.
       parser_->setDoNamespaces (true);
       // Discard comment nodes in the document
       parser_->setCreateCommentNodes (false);
       // Disable datatype normalization. The XML 1.0 attribute value
       // normalization always occurs though.
       // parser_->setFeature (XMLUni::fgDOMDatatypeNormalization, true);
 
       // Do not create EntityReference nodes in the DOM tree. No
       // EntityReference nodes will be created, only the nodes
       // corresponding to their fully expanded sustitution text will be
       // created.
       parser_->setCreateEntityReferenceNodes (false);
       // Perform Validation
       parser_->setValidationScheme (xercesc::AbstractDOMParser::Val_Always);
       // Do not include ignorable whitespace in the DOM tree.
       parser_->setIncludeIgnorableWhitespace (false);
       // Enable the parser_'s schema support.
       parser_->setDoSchema (true);
       // Enable full schema constraint checking, including checking which
       // may be time-consuming or memory intensive. Currently, particle
       // unique attribution constraint checking and particle derivation
       // restriction checking are controlled by this option.
       parser_->setValidationSchemaFullChecking (true);
       // The parser_ will treat validation error as fatal and will exit.
       parser_->setValidationConstraintFatal (true);
 
       // Set resolver using auxiliary XML_Schema_Resolver
       parser_->setEntityResolver(res_);
 
       // Set XML Error handler
       parser_->setErrorHandler(eh_);
 
       // Parsing buffer
       try {
         parser_->parse(xmlBuf);
       }
       catch (const SAXParseException& toCatch) {
         char* message = XMLString::transcode(toCatch.getMessage());
         ACE_ERROR ((LM_ERROR,
           ACE_TEXT ("QOS_XML_String_Handler::init - ")
           ACE_TEXT ("Exception message is: <%C>\n"),
           message));
         XMLString::release(&message);
         return DDS::RETCODE_ERROR;
       }
       catch (const XMLException& toCatch) {
         char* message = XMLString::transcode(toCatch.getMessage());
         ACE_ERROR ((LM_ERROR,
           ACE_TEXT ("QOS_XML_String_Handler::init - ")
           ACE_TEXT ("Exception message is: <%C>\n"),
           message));
         XMLString::release(&message);
         return DDS::RETCODE_ERROR;
       }
       catch (const DOMException& toCatch) {
         char* message = XMLString::transcode(toCatch.getMessage());
         ACE_ERROR ((LM_ERROR,
           ACE_TEXT ("QOS_XML_String_Handler::init - ")
           ACE_TEXT ("Exception message is: <%C>\n"),
           message));
         XMLString::release(&message);
         return DDS::RETCODE_ERROR;
       }
       catch (...) {
         ACE_ERROR ((LM_ERROR,
           ACE_TEXT ("QOS_XML_String_Handler::init - ")
           ACE_TEXT ("Unexpected exception\n")
           ));
         return DDS::RETCODE_ERROR;
       }
 
       DOMDocument * initialDoc = parser_->getDocument();
       if (initialDoc == 0)
       {
         if (DCPS_debug_level > 1)
         {
           ACE_ERROR ((LM_ERROR,
             ACE_TEXT ("QOS_XML_String_Handler::init - ")
             ACE_TEXT ("Failed to parse string\n")
             ));
         }
         return DDS::RETCODE_ERROR;
       }
 
       // Find "dds" node using the opendds namespace
       XMLCh* ns = XMLString::transcode("http://www.omg.org/dds");
       XMLCh* ddstag = XMLString::transcode("dds");
 
       DOMNodeList * ddsNodeList = initialDoc->getElementsByTagNameNS(ns, ddstag);
       XMLString::release(&ns);
       XMLString::release(&ddstag);
 
       // Check if it could find tag and namespace
       if (ddsNodeList->getLength() == 0)
       {
         if (DCPS_debug_level > 1)
           {
             ACE_ERROR ((LM_ERROR,
               ACE_TEXT ("QOS_XML_String_Handler::init - ")
               ACE_TEXT ("Could not find tag(dds) in namespace(http://www.omg.org/dds)\n")
               ));
           }
         return DDS::RETCODE_ERROR;
       }
 
       // Get the first node. It is expected to have only one
       DOMNode * ddsNode = ddsNodeList->item(0);
       if (DCPS_debug_level > 1)
       {
         char* message = XMLString::transcode(ddsNode->getNodeName());
         ACE_DEBUG ((LM_DEBUG,
           ACE_TEXT ("QOS_XML_String_Handler::init - ")
           ACE_TEXT ("Node name: <%C>\n"),
           message));
         XMLString::release(&message);
       }
 
       DOMNode * clone = finalDoc_->importNode(ddsNode, true);
 
       // Check if import was successful
       if (clone == 0)
       {
         if (DCPS_debug_level > 1)
         {
           ACE_ERROR ((LM_ERROR,
             ACE_TEXT ("QOS_XML_String_Handler::init - ")
             ACE_TEXT ("Failed to get pointer of imported node\n")
             ));
         }
         return DDS::RETCODE_ERROR;
       }
       // Replace root element by the cloned one. Thus the root element
       // shall be "dds" as required by dds::reader::dds function
       finalDoc_->replaceChild(clone,finalDoc_->getDocumentElement());
 
       ID_Map::TSS_ID_Map* TSS_ID_Map (ACE_Singleton<ID_Map::TSS_ID_Map, ACE_Null_Mutex>::instance());
       (*TSS_ID_Map)->reset ();
 
       profiles_ = dds::reader::dds(finalDoc_);
 
     }
     catch (const CORBA::Exception &ex)
     {
       ACE_ERROR ((LM_ERROR,
         ACE_TEXT ("QOS_XML_String_Handler::init - ")
         ACE_TEXT ("Caught CORBA exception whilst parsing XML\n"),
         ex._info ().c_str ()));
       retcode = DDS::RETCODE_ERROR;
     }
     catch (...)
     {
       ACE_ERROR ((LM_ERROR,
         ACE_TEXT ("QOS_XML_String_Handler::init - ")
         ACE_TEXT ("Unexpected exception whilst parsing XML.\n")
         ));
       retcode = DDS::RETCODE_ERROR;
     }
     return retcode;
   }

Member Data Documentation

◆ eh_

XML::XML_Error_Handler* OpenDDS::DCPS::QOS_XML_String_Handler::eh_

private

Error handler.

Definition at line 74 of file XML_String_Intf.h.

Referenced by init(), and ~QOS_XML_String_Handler().

◆ finalDoc_

XERCES_CPP_NAMESPACE::DOMDocument* OpenDDS::DCPS::QOS_XML_String_Handler::finalDoc_

private

Final DOMDocument that should be passed to dds::reader::dds method

Definition at line 81 of file XML_String_Intf.h.

Referenced by init(), QOS_XML_String_Handler(), and ~QOS_XML_String_Handler().

◆ parser_

XERCES_CPP_NAMESPACE::XercesDOMParser* OpenDDS::DCPS::QOS_XML_String_Handler::parser_

private

Parser.

Definition at line 77 of file XML_String_Intf.h.

Referenced by init(), QOS_XML_String_Handler(), and ~QOS_XML_String_Handler().

◆ res_

XML::XML_Schema_Resolver<XML::Environment_Resolver>* OpenDDS::DCPS::QOS_XML_String_Handler::res_

private

Schema resolver.

Definition at line 71 of file XML_String_Intf.h.

Referenced by add_search_path(), init(), and ~QOS_XML_String_Handler().

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QOS_XML_String_Handler()

◆ ~QOS_XML_String_Handler()

Member Function Documentation

◆ add_search_path()

◆ init()

Member Data Documentation

◆ eh_

◆ finalDoc_

◆ parser_

◆ res_