System::Xml::XmlResolver Class Referenceabstract

Resolves external XML resources named by a Uniform Resource Identifier (URI). More...

#include "xml_resolver.h"

Inherits System::Object.

Inherited by System::Xml::Resolvers::XmlPreloadedResolver, System::Xml::XmlSecureResolver, and System::Xml::XmlUrlResolver.

Public Types

using Ptr = SharedPtr< XmlResolver >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

virtual ASPOSECPP_SHARED_API void set_Credentials (SharedPtr< Net::ICredentials > value)
 When overridden in a derived class, sets the credentials used to authenticate web requests. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< ObjectGetEntity (SharedPtr< Uri > absoluteUri, String role, const TypeInfo &ofObjectToReturn)=0
 When overridden in a derived class, maps a URI to an object that contains the actual resource. More...
 
virtual ASPOSECPP_SHARED_API SharedPtr< UriResolveUri (SharedPtr< Uri > baseUri, String relativeUri)
 When overridden in a derived class, resolves the absolute URI from the base and relative URIs. More...
 
virtual ASPOSECPP_SHARED_API bool SupportsType (SharedPtr< Uri > absoluteUri, const TypeInfo &type)
 Enables the resolver to return types other than Stream. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Resolves external XML resources named by a Uniform Resource Identifier (URI).

Member Typedef Documentation

◆ Ptr

An alias for shared pointer to an instance of this class.

Member Function Documentation

◆ GetEntity()

virtual ASPOSECPP_SHARED_API SharedPtr<Object> System::Xml::XmlResolver::GetEntity ( SharedPtr< Uri absoluteUri,
String  role,
const TypeInfo ofObjectToReturn 
)
pure virtual

When overridden in a derived class, maps a URI to an object that contains the actual resource.

Parameters
absoluteUriThe URI returned from XmlResolver::ResolveUri(SharedPtr<Uri>, String) call.
roleCurrently not used.
ofObjectToReturnThe type of object to return. The current version only returns Stream objects.
Returns
A stream object or nullptr if a type other than stream is specified.
Exceptions
XmlExceptionofObjectToReturn is not a Stream type.
UriFormatExceptionThe specified URI is not an absolute URI.
ArgumentNullExceptionabsoluteUri is nullptr.
ExceptionThere is a runtime error (for example, an interrupted server connection).

Implemented in System::Xml::Resolvers::XmlPreloadedResolver, System::Xml::XmlUrlResolver, and System::Xml::XmlSecureResolver.

◆ ResolveUri()

virtual ASPOSECPP_SHARED_API SharedPtr<Uri> System::Xml::XmlResolver::ResolveUri ( SharedPtr< Uri baseUri,
String  relativeUri 
)
virtual

When overridden in a derived class, resolves the absolute URI from the base and relative URIs.

Parameters
baseUriThe base URI used to resolve the relative URI.
relativeUriThe URI to resolve. The URI can be absolute or relative. If absolute, this value effectively replaces the baseUri value. If relative, it combines with the baseUri to make an absolute URI.
Returns
The absolute URI or nullptr if the relative URI cannot be resolved.
Exceptions
ArgumentExceptionrelativeUri is nullptr.

Reimplemented in System::Xml::Resolvers::XmlPreloadedResolver, System::Xml::XmlUrlResolver, and System::Xml::XmlSecureResolver.

◆ set_Credentials()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlResolver::set_Credentials ( SharedPtr< Net::ICredentials value)
virtual

When overridden in a derived class, sets the credentials used to authenticate web requests.

Parameters
valueThe value to set.

Reimplemented in System::Xml::Resolvers::XmlPreloadedResolver, System::Xml::XmlUrlResolver, and System::Xml::XmlSecureResolver.

◆ SupportsType()

virtual ASPOSECPP_SHARED_API bool System::Xml::XmlResolver::SupportsType ( SharedPtr< Uri absoluteUri,
const TypeInfo type 
)
virtual

Enables the resolver to return types other than Stream.

Parameters
absoluteUriThe URI.
typeThe type to return.
Returns
true if the type is supported; otherwise, false.

Reimplemented in System::Xml::Resolvers::XmlPreloadedResolver.