xmltooling Namespace Reference

Public namespace of XML Tooling library. More...

Classes
class	xmltooling::AbstractAttributeExtensibleXMLObject
	AbstractXMLObject mixin that implements AttributeExtensibleXMLObject. More...
class	xmltooling::AbstractComplexElement
	AbstractXMLObject mixin that implements children. More...
class	xmltooling::AbstractDOMCachingXMLObject
	AbstractXMLObject mixin that implements DOM caching. More...
class	xmltooling::AbstractSimpleElement
	AbstractXMLObject mixin that implements a simple string-based content model. More...
class	xmltooling::AbstractXMLObject
	An abstract implementation of XMLObject. More...
class	xmltooling::AttributeExtensibleXMLObject
	An XMLObject that supports arbitrary attributes. More...
struct	xmltooling::cleanup< T >
	Functor for cleaning up heap objects in containers. More...
struct	xmltooling::cleanup_pair< A, B >
	Functor for cleaning up heap objects in key/value containers. More...
struct	xmltooling::cleanup_const_pair< A, B >
	Functor for cleaning up const heap objects in key/value containers. More...
struct	xmltooling::_Char_types< _CharT >
	OFF More...
struct	xmltooling::char_traits< _CharT >
class	xmltooling::ConcreteXMLObjectBuilder
	A factory interface for obtaining XMLObjects. More...
class	xmltooling::ElementExtensibleXMLObject
	An XMLObject that exposes arbitrary children via a mutable vector. More...
class	xmltooling::ElementProxy
	An XMLObject with an open content model. More...
class	xmltooling::params
	Wrapper around a variable number of arguments. More...
class	xmltooling::namedparams
	Wrapper around a variable number of name/value pairs. More...
class	xmltooling::XMLToolingException
	Base exception class, supports parametrized messages and XML serialization. More...
class	xmltooling::XMLParserException
	Exceptions related to XML parsing. More...
class	xmltooling::XMLObjectException
	Exceptions in basic object usage. More...
class	xmltooling::MarshallingException
	Exceptions during object marshalling. More...
class	xmltooling::UnmarshallingException
	Exceptions during object unmarshalling. More...
class	xmltooling::UnknownElementException
	Exceptions due to processing of unknown element content. More...
class	xmltooling::UnknownAttributeException
	Exceptions due to processing of unknown attributes. More...
class	xmltooling::UnknownExtensionException
	Exceptions from use of an unrecognized extension/plugin. More...
class	xmltooling::ValidationException
	Exceptions during object validation. More...
class	xmltooling::IOException
	Exceptions related to physical input/output errors. More...
class	xmltooling::XMLSecurityException
	Exceptions related to the XML security layer. More...
class	xmltooling::AnyElementImpl
	Implements a smart wrapper around unknown or arbitrary DOM content. More...
class	xmltooling::AnyElementBuilder
	Builder for AnyElementImpl objects. More...
class	xmltooling::UnknownElementImpl
	off More...
class	xmltooling::UnknownElementBuilder
	Builder for UnknownElementImpl objects. More...
class	xmltooling::XMLToolingInternalConfig
	OFF More...
class	xmltooling::AbstractXMLObjectMarshaller
	A mix-in to implement object marshalling with DOM reuse. More...
class	xmltooling::AbstractXMLObjectUnmarshaller
	A mix-in to implement object unmarshalling. More...
class	xmltooling::GenericRequest
	Interface to generic protocol requests that transport XML messages. More...
class	xmltooling::GenericResponse
	Interface to generic protocol responses that transport XML messages. More...
class	xmltooling::HTTPRequest
	Interface to HTTP requests. More...
class	xmltooling::HTTPResponse
	Interface to HTTP response. More...
struct	xmltooling::Lockable
	Abstract mixin interface for interfaces that support locking. More...
class	xmltooling::Locker
	RAII wrapper for lockable objects to ensure lock release. More...
class	xmltooling::Namespace
	A data structure for encapsulating XML Namespace attributes. More...
class	xmltooling::PluginManager< T, Key, Params >
	Template for management/access to plugins constructed based on a Key type and arbitrary parameters. More...
class	xmltooling::QName
	A data structure for encapsulating XML QNames. More...
class	xmltooling::AbstractPKIXTrustEngine
	A trust engine that uses X.509 trust anchors and CRLs associated with a peer to perform PKIX validation of signatures and credentials. More...
class	xmltooling::AbstractPKIXTrustEngine::PKIXValidationInfoIterator
	Stateful interface that supplies PKIX validation data to the trust engine. More...
class	xmltooling::BasicX509Credential
	Wraps an X.509-based Credential by storing key/cert objects inside. More...
class	xmltooling::ChainingTrustEngine
	OpenSSLTrustEngine that uses multiple engines in sequence. More...
class	xmltooling::Credential
	Wraps keys and related functionality. More...
class	xmltooling::CredentialContext
	Marker interface for implementations which hold information specific to a particular context within which a CredentialResolver resolves a Credential. More...
class	xmltooling::CredentialCriteria
	Class for specifying criteria by which a CredentialResolver should resolve credentials. More...
class	xmltooling::CredentialResolver
	An API for resolving keys and certificates based on application criteria. More...
class	xmltooling::KeyInfoCredentialContext
	Context for credentials resolved out of a KeyInfo. More...
class	xmltooling::KeyInfoResolver
	Resolves credentials from KeyInfo information. More...
class	xmltooling::OpenSSLCredential
	An OpenSSL-specific credential. More...
class	xmltooling::OpenSSLCryptoX509CRL
	OpenSSL-based class for handling X.509 CRLs. More...
class	xmltooling::OpenSSLTrustEngine
	Extended TrustEngine interface that adds validation of X.509 credentials using OpenSSL data types directly for efficiency. More...
class	xmltooling::SecurityHelper
	A helper class for working with keys, certificates, etc. More...
class	xmltooling::SignatureTrustEngine
	TrustEngine interface that adds validation of digital signatures. More...
class	xmltooling::TrustEngine
	Evaluates the trustworthiness and validity of security information against implementation-specific requirements. More...
class	xmltooling::X509Credential
	Wraps an X.509-based Credential. More...
class	xmltooling::X509TrustEngine
	TrustEngine interface that adds validation of X.509 credentials. More...
class	xmltooling::XSECCryptoX509CRL
	Interface class for X.509 CRLs The library uses classes derived from this to process X.509 CRLs. More...
class	xmltooling::HTTPSOAPTransport
	Encapsulates HTTP SOAP transport layer. More...
class	xmltooling::OpenSSLSOAPTransport
	Encapsulates OpenSSL-capable SOAP transport layer. More...
class	xmltooling::SOAPTransport
	Encapsulates a transport layer protocol for sending/receiving messages. More...
struct	xmltooling::SOAPTransport::Address
	A simple structure to capture SOAP addressing information. More...
class	xmltooling::auto_ptr_char
	A minimal auto_ptr-like class that can copy or transcode a buffer into the local code page and free the result automatically. More...
class	xmltooling::auto_ptr_XMLCh
	A minimal auto_ptr-like class that can copy or transcode a buffer into 16-bit Unicode and free the result automatically. More...
class	xmltooling::auto_arrayptr< T >
	An auto_ptr that uses array delete on its contents. More...
class	xmltooling::CurlURLInputStream
	Adapted from Xerces-C as a more advanced input stream implementation for subsequent use in parsing remote documents. More...
class	xmltooling::DateTime
	Class for manipulating XML date/time information. More...
class	xmltooling::NDC
	A portable stack-based context for diagnostic logging. More...
class	xmltooling::ParserPool
	A thread-safe pool of DOMBuilders that share characteristics. More...
class	xmltooling::StreamInputSource
	A parser source that wraps a C++ input stream. More...
class	xmltooling::StreamInputSource::StreamBinInputStream
	A Xerces input stream that wraps a C++ input stream. More...
class	xmltooling::URLInputSource
	A URL-based parser source that supports a more advanced input stream. More...
class	xmltooling::PathResolver
	Resolves local filenames into absolute pathnames. More...
class	xmltooling::hasQName
	Predicate that checks the QName of an XMLObject. More...
class	xmltooling::hasSchemaType
	Predicate that checks the xsi:type of an XMLObject. More...
class	xmltooling::ReloadableXMLFile
	Base class for file-based XML configuration. More...
class	xmltooling::ReplayCache
	Helper class on top of StorageService for detecting message replay. More...
class	xmltooling::StorageService
	Generic data storage facility for use by services that require some degree of persistence. More...
class	xmltooling::TemplateEngine
	Simple template replacement engine. More...
class	xmltooling::TemplateEngine::TemplateParameters
	Interface to parameters to plug into templates. More...
class	xmltooling::ThreadingException
	Exceptions during threading/locking operations. More...
class	xmltooling::Thread
	A class for manual thread creation and synchronization. More...
class	xmltooling::ThreadKey
	A class for managing Thread Local Storage values. More...
class	xmltooling::Mutex
	A class for managing exclusive access to resources. More...
class	xmltooling::RWLock
	A class for managing shared and exclusive access to resources. More...
class	xmltooling::CondWait
	A class for establishing queues on a mutex based on a periodic condition. More...
class	xmltooling::Lock
	RAII wrapper for a mutex lock. More...
class	xmltooling::SharedLock
	RAII wrapper for a shared lock. More...
class	xmltooling::URLEncoder
	Interface to a URL-encoding mechanism along with a default implementation. More...
class	xmltooling::XercesJanitor< T >
	RAII wrapper for Xerces resources. More...
class	xmltooling::XMLHelper
	A helper class for working with W3C DOM objects. More...
class	xmltooling::XMLObjectChildrenIterator< Container, _Ty >
	STL iterator that mediates access to an iterator over typed XML children. More...
class	xmltooling::XMLObjectChildrenList< Container, _Ty >
	STL-compatible container that mediates access to underlying lists of typed XML children. More...
class	xmltooling::XMLObjectPairList< Container, _Ty >
	STL-compatible container that mediates access to underlying lists of typed XML children that come in pairs. More...
class	xmltooling::Validator
	An interface for classes that implement rules for checking the validity of XMLObjects. More...
class	xmltooling::ValidatorSuite
	A collection of validators that can be applied to an XMLObject and its children. More...
class	xmltooling::XMLObject
	Object that represents an XML Element that has been unmarshalled into this C++ object. More...
class	xmltooling::XMLObjectBuilder
	A factory interface for obtaining XMLObjects. More...
class	xmltooling::XMLToolingConfig
	Singleton object that manages library startup/shutdown.configuration. More...
Typedefs
typedef std::basic_string< XMLCh >	xstring
	An STL string type that supports 16-bit Unicode.
Functions
template<class InputSequence, class OutputSequence>
void	clone (const InputSequence &in, OutputSequence &out)
	Template function for cloning a sequence of XMLObjects.
void	log_openssl ()
bool	operator< (const Namespace &op1, const Namespace &op2)
	Returns true iff op1's namespace lexically compares less than op2's namespace, or if equal, iff op1's prefix lexically compares less than op2's prefix.
bool	operator< (const QName &op1, const QName &op2)
	Returns true iff op1's namespace lexically compares less than op2's namespace, or if equal, iff op1's prefix lexically compares less than op2's prefix.
bool	operator== (const QName &op1, const QName &op2)
	Returns true iff op1's components are equal to op2's components, excluding prefix.
bool	operator!= (const QName &op1, const QName &op2)
	Returns true iff op1's components are not equal to op2's components, excluding prefix.
void	registerCredentialResolvers ()
	Registers CredentialResolver classes into the runtime.
void	registerKeyInfoResolvers ()
	Registers KeyInfoResolver classes into the runtime.
void	registerTrustEngines ()
	Registers TrustEngine classes into the runtime.
void	registerSOAPTransports ()
	Registers SOAPTransport classes into the runtime.
void	initSOAPTransports ()
	Notifies transport infrastructure to initialize.
void	termSOAPTransports ()
	Notifies transport infrastructure to shutdown.
char *	toUTF8 (const XMLCh *src, bool use_malloc=false)
	Transcodes a 16-bit Unicode string into UTF-8.
XMLCh *	fromUTF8 (const char *src, bool use_malloc=false)
	Transcodes a UTF-8 string into 16-bit Unicode.
std::ostream &	operator<< (std::ostream &ostr, const XMLCh *s)
	Writes a Unicode string to an ASCII stream by transcoding to UTF8.
std::ostream &	operator<< (std::ostream &ostr, const xstring &s)
	Writes a Unicode string to an ASCII stream by transcoding to UTF8.
template<typename Container, typename Predicate>
Container::value_type	find_if (const Container &c, const Predicate &p)
	Template algorithm returns first pointer element from a container that matches a predicate.
template<typename Container, typename Predicate>
Container::value_type	find_if (Container &c, const Predicate &p)
	Template algorithm returns first pointer element from a container that matches a predicate.
void	registerStorageServices ()
	Registers StorageService classes into the runtime.
std::ostream &	operator<< (std::ostream &ostr, const xercesc::DOMNode &n)
	Serializes the DOM node provided to a stream using UTF-8 encoding and the default XML serializer available.
std::ostream &	operator<< (std::ostream &ostr, const XMLObject &obj)
	Marshalls and serializes the XMLObject provided to a stream using UTF-8 encoding and the default XML serializer available.
Variables
xmltooling::ValidatorSuite	SchemaValidators
	Validator suite for schema-style structural validation.

---

Detailed Description

Public namespace of XML Tooling library.

---

Function Documentation

template<class InputSequence, class OutputSequence> void clone (  const InputSequence &  in, OutputSequence &  out )

Template function for cloning a sequence of XMLObjects. Invokes the clone() member on each element of the input sequence and adds the copy to the output sequence. Order is preserved. Parameters: in  input sequence to clone out  output sequence to copy cloned pointers into

template<typename Container, typename Predicate> Container::value_type find_if (  Container &  c, const Predicate &  p )

Template algorithm returns first pointer element from a container that matches a predicate. Parameters: c  read-only container of pointer-based objects p  a predicate function Returns: the first object in the container matching the predicate, or NULL

template<typename Container, typename Predicate> Container::value_type find_if (  const Container &  c, const Predicate &  p )

Template algorithm returns first pointer element from a container that matches a predicate. Parameters: c  read-only container of pointer-based objects p  a predicate function Returns: the first object in the container matching the predicate, or NULL

XMLCh* fromUTF8 (  const char *  src, bool  use_malloc = false )

Transcodes a UTF-8 string into 16-bit Unicode. Parameters: src  the UTF-8 string to transcode use_malloc  true iff the result should be allocated with malloc, false to use new Returns: a 16-bit Unicode string allocated by the Xerces memory manager

bool operator!= (  const QName &  op1, const QName &  op2 )

Returns true iff op1's components are not equal to op2's components, excluding prefix. Parameters: op1  First qname to compare op2  Second qname to compare

bool operator< (  const QName &  op1, const QName &  op2 )

Returns true iff op1's namespace lexically compares less than op2's namespace, or if equal, iff op1's prefix lexically compares less than op2's prefix. Needed for use with sorted STL containers. Parameters: op1  First qname to compare op2  Second qname to compare

bool operator< (  const Namespace &  op1, const Namespace &  op2 )

Returns true iff op1's namespace lexically compares less than op2's namespace, or if equal, iff op1's prefix lexically compares less than op2's prefix. Needed for use with sorted STL containers. Parameters: op1  First namspace to compare op2  Second namespace to compare

std::ostream& operator<< (  std::ostream &  ostr, const XMLObject &  obj )

Marshalls and serializes the XMLObject provided to a stream using UTF-8 encoding and the default XML serializer available. No manipulation or formatting is applied. The marshaller operation takes no parameters. Parameters: obj  object to serialize ostr  stream to serialize object into Returns: reference to output stream

std::ostream& operator<< (  std::ostream &  ostr, const xercesc::DOMNode &  n )

Serializes the DOM node provided to a stream using UTF-8 encoding and the default XML serializer available. No manipulation or formatting is applied. Parameters: n  node to serialize ostr  stream to serialize element into Returns: reference to output stream

std::ostream& operator<< (  std::ostream &  ostr, const xstring &  s )

Writes a Unicode string to an ASCII stream by transcoding to UTF8. Parameters: ostr  stream to write to s  string to write Returns: reference to output stream

std::ostream& operator<< (  std::ostream &  ostr, const XMLCh *  s )

Writes a Unicode string to an ASCII stream by transcoding to UTF8. Parameters: ostr  stream to write to s  string to write Returns: reference to output stream

bool operator== (  const QName &  op1, const QName &  op2 )

Returns true iff op1's components are equal to op2's components, excluding prefix. Parameters: op1  First qname to compare op2  Second qname to compare

char* toUTF8 (  const XMLCh *  src, bool  use_malloc = false )

Transcodes a 16-bit Unicode string into UTF-8. Parameters: src  the 16-bit string to transcode use_malloc  true iff the result should be allocated with malloc, false to use new Returns: a UTF-8 string allocated by the Xerces memory manager

---

Variable Documentation

xmltooling::ValidatorSuite xmltooling::SchemaValidators

Validator suite for schema-style structural validation. This is NOT a comprehensive replacement for real schema validation, but it does basic structural checking of overall element relationships and some basic attribute presence checking.

---