IRISLIB database
EntityResolver Class Reference
Inheritance diagram for EntityResolver:
Collaboration diagram for EntityResolver:

Public Member Functions

_.Library.Integer resolveEntity (_.Library.String publicID, _.Library.String systemID)
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Public Attributes

 SSLConfiguration
 The name of the activated TLS/SSL configuration to use for https requests. More...
 
 Timeout
 The amount of time to wait for a response from the web server before. More...
 

Additional Inherited Members

- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

For details on using this class, see Customizing How the SAX Parser Is Used.

This class enables the SAX parser to resolve external entities. The parser will call the resolveEntity method passing the URI/URL of the external entity,expecting a new stream object to be returned. This class provides a default implementation; you may wish to provide your own subclass with specialized semantics. The entity must be returned as an instance of BinaryStream (or one of its subclasses) wrapped in an instance of XML.SAX.StreamAdapter. If the entity cannot be resolved, then $$$NULLOREF should be returned to indicate to the SAX parser that the entity cannot be resolved).

If you want the EntityResolver to be able to resolve urls prefixed by https then you MUST set the SSLConfiguration property to the name of a valid SSLConfiguration that is appropriate for the servers to which the urls resolve.

Member Function Documentation

◆ resolveEntity()

_.Library.Integer resolveEntity ( _.Library.String  publicID,
_.Library.String  systemID 
)

For details on using this class, see Customizing How the SAX Parser Is Used.

This class enables the SAX parser to resolve external entities. The parser will call the resolveEntity method passing the URI/URL of the external entity,expecting a new stream object to be returned. This class provides a default implementation; you may wish to provide your own subclass with specialized semantics. The entity must be returned as an instance of BinaryStream (or one of its subclasses) wrapped in an instance of XML.SAX.StreamAdapter. If the entity cannot be resolved, then $$$NULLOREF should be returned to indicate to the SAX parser that the entity cannot be resolved).

If you want the EntityResolver to be able to resolve urls prefixed by https then you MUST set the SSLConfiguration property to the name of a valid SSLConfiguration that is appropriate for the servers to which the urls resolve.

Reimplemented in NullEntityResolver, and XDataEntityResolver.

Member Data Documentation

◆ SSLConfiguration

SSLConfiguration

The name of the activated TLS/SSL configuration to use for https requests.

 

◆ Timeout

Timeout

The amount of time to wait for a response from the web server before.

assuming that the web server is not responding. If not specified, the Net.HttpRequest default is used.