Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.HTTP.GenericMessage
Private  Storage   

EnsLib.HTTP.GenericMessage


persistent class EnsLib.HTTP.GenericMessage extends
Ens.StreamContainer

Transport contents of an HTTP request or response through InterSystems IRIS

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 1 3 1


Summary


Properties
Attributes HTTPHeaders OriginalFilename OutputFilename
OutputFolder Stream Type

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %BuildIndicesAsync
%BuildIndicesAsyncResponse %CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion
%ClassName %CompareContents %ComposeOid %ConstructClone
%Delete %DeleteExtent %DeleteId %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawHTMLForm %DrawHTMLTable
%Exists %ExistsId %Extends %GUID
%GUIDSet %GetContentType %GetLock %GetParameter
%GetSwizzleObject %Id %InsertBatch %IsA
%IsModified %IsNull %KillExtent %KillExtentData
%LoadFromMemory %LockExtent %LockId %New
%NormalizeObject %ObjectIsNull %ObjectModified %Oid
%OnBeforeAddToSync %OnDetermineClass %OnNew %OnTimeout
%Open %OpenId %OriginalNamespace %PackageName
%PhysicalAddress %ProcessSubmit %PurgeIndices %Reload
%RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack %Save
%SaveDirect %SaveIndices %SerializeObject %SetModified
%ShowContents %ShowContentsHead %SortBegin %SortEnd
%SyncObjectIn %SyncTransport %UnlockExtent %UnlockId
%ValidateIndices %ValidateObject GetStatsDimension SetAttributes
SetHTTPHeaders StreamGet StreamSet XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLSchema
XMLSchemaNamespace XMLSchemaType

Subclasses
EnsLib.REST.GenericMessage EnsLib.SOAP.GenericMessage

Parameters


• parameter XMLNAME = "HTTPMessage";
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";
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(MAXLEN="");
An array of strings containing any HTTP header values

Methods


• method %OnNew(pBodyStream As %RawString = $$$NULLOREF, pAttributes As %Collection.ArrayOfDT = $$$NULLOREF, pHTTPHeaders As %Collection.ArrayOfDT = $$$NULLOREF) as %Status
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)