Skip to main content

This documentation is for an older version of this product. See the latest version of this content.Opens in a new tab

EnsLib.HTTP.GenericMessage

persistent class EnsLib.HTTP.GenericMessage extends Ens.StreamContainer

SQL Table Name: EnsLib_HTTP.GenericMessage

Transport contents of an HTTP request or response through InterSystems IRIS

Property Inventory

Method Inventory

Parameters

parameter XMLNAME = HTTPMessage;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLTYPE = HTTPMessage;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property HTTPHeaders as array of %String);
An array of strings containing any HTTP header values
Property methods: HTTPHeadersBuildValueArray(), HTTPHeadersCollectionToDisplay(), HTTPHeadersCollectionToOdbc(), HTTPHeadersDisplayToCollection(), HTTPHeadersDisplayToLogical(), HTTPHeadersGet(), HTTPHeadersGetObject(), HTTPHeadersGetObjectId(), HTTPHeadersGetStored(), HTTPHeadersGetSwizzled(), HTTPHeadersIsValid(), HTTPHeadersLogicalToDisplay(), HTTPHeadersLogicalToOdbc(), HTTPHeadersNormalize(), HTTPHeadersOdbcToCollection(), HTTPHeadersSet(), HTTPHeadersSetObject(), HTTPHeadersSetObjectId()

Methods

method %OnNew(pBodyStream As %RawString = $$$NULLOREF, pAttributes As %Collection.ArrayOfDT = $$$NULLOREF, pHTTPHeaders As %Collection.ArrayOfDT = $$$NULLOREF) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method SetHTTPHeaders(ByRef pHTTPHeaders)
Set values into the HTTPHeaders array property Pass in an array object, a ObjectScript array, a ObjectScript array reference, a %AbstractStream with its own Attributes to copy from, a %Net.HttpResponse object with its own Headers to copy from, or a string of the form 'a=1,b=2,c=3'.

Triggers

trigger OnDelete (BEFORE event DELETE);

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.StreamContainer)

^Ens.StreamContainerD(ID,"Attributes",n)
=
Attributes(n)

Storage Model: Storage (Ens.StreamContainer)

^Ens.StreamContainerD(ID)
=
%%CLASSNAME
OriginalFilename
StreamFB
StreamFC
StreamGB
StreamGC
Type
StreamCF
StreamBF
StreamCG
StreamBG
FileCharEncodingTable
CharEncodingTable
OutputFolder
OutputFilename

Storage Model: Storage (EnsLib.HTTP.GenericMessage)

^Ens.StreamContainerD(ID,"EnsLib.HTTP.GenericMessage.HTTPHeaders",n)
=
HTTPHeaders(n)

Subclasses

FeedbackOpens in a new tab