Namespace: OpenEdge.Net.HTTP.Filter.Payload
Class 
DefaultRequestFilter
Parent classes:
Progress.IO.OutputStream
OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
OpenEdge.Net.HTTP.Filter.Payload.DefaultRequestFilter

Inherits: OpenEdge.Net.HTTP.Filter.Payload.MessageWriter

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:DefaultRequestFilter
Purpose:Writes data from a request into another data structure,
as passed into the Write() methods.
Author(s):pjudge
Created:Mon Jan 26 09:57:31 EST 2015




Method Summary
Options Name Purpose
# Close () /** Closes the writer. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
OpenEdge.Core.ByteBucket ExtractEntity (IHttpRequest) /** Extracts the contents of the Entity property, and populates the MessageBody. This default implementation returns an empty message body. @return Memptr A memptr object containing the extracted entity. */
# Open () /** Opens the writer for output. Open/Close allows us to write the same message multiple times without requiring a new writer each time. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
# INT64 Write (character)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
# INT64 Write (handle) /** Write data to/from the entity @param handle Data to write */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
# INT64 Write (longchar)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
# INT64 Write (memptr)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
# INT64 Write (memptr, int64, int64)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
# INT64 Write (Object)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (Object)
WriteHeaders (IHttpRequest) /** Writes the HTTP headers into the bucket @param ByteBucket The target for the write operation */
WriteMessage (IHttpRequest) /** Builds a complete HTTP request (ie headers, protocol etc) for the data in this object. */
WriteRequestLine (IHttpRequest) /** Writes the request line into the bucket @param ByteBucket The target for the write operation */

Constructor Summary
Options Name Purpose
# DefaultRequestFilter ()

Property Summary
Options Name Purpose
CHARACTER CRLF /* private and immutable constant value */
# Progress.Lang.Object Entity /** (mandatory) The message entity that's being written to. The values passed in to the Write() methods will be parsed/processed and written to this entity. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
# Progress.Lang.Class EntityType /** (mandatory) The type that the entity this writer can write to. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter


Method Detail
Top

PROTECTED Close ()
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Closes the writer.
Top

OpenEdge.Core.ByteBucket ExtractEntity (IHttpRequest)
Purpose: Extracts the contents of the Entity property, and
populates the MessageBody.
This default implementation returns an empty message body.
Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest
Returns OpenEdge.Core.ByteBucket
Memptr A memptr object containing the extracted entity.
Top

PROTECTED Open ()
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Opens the writer for output. Open/Close allows us to write the same message multiple
times without requiring a new writer each time.
Top

PROTECTED INT64 Write (character)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Parameters:
p0 CHARACTER
Returns INT64
Top

PROTECTED INT64 Write (handle)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Write data to/from the entity
Parameters:
phData HANDLE
Returns INT64
Top

PROTECTED INT64 Write (longchar)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Parameters:
p0 LONGCHAR
Returns INT64
Top

PROTECTED INT64 Write (memptr)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Parameters:
p0 MEMPTR
Returns INT64
Top

PROTECTED INT64 Write (memptr, int64, int64)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Parameters:
p0 MEMPTR
p1 INT64
p2 INT64
Returns INT64
Top

PROTECTED INT64 Write (Object)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (Object)
Parameters:
poData Progress.Lang.Object
Returns INT64
Top

WriteHeaders (IHttpRequest)
Purpose: Writes the HTTP headers into the bucket
Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest
Top

WriteMessage (IHttpRequest)
Purpose: Builds a complete HTTP request (ie headers, protocol etc)
for the data in this object.
Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest
Top

WriteRequestLine (IHttpRequest)
Purpose: Writes the request line into the bucket
Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest


Constructor Detail
Top

PROTECTED DefaultRequestFilter ()


Property Detail
Top

CHARACTER CRLF
/* private and immutable constant value
Returns CHARACTER
Top

PROTECTED Progress.Lang.Object Entity
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: (mandatory) The message entity that's being written to. The values passed
in to the Write() methods will be parsed/processed and written to this entity.
Returns Progress.Lang.Object
Top

PROTECTED Progress.Lang.Class EntityType
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: (mandatory) The type that the entity this writer can write to.
Returns Progress.Lang.Class


10.27.2015 12:36:41