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-2017 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
/* Default constructor




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. */
LogMessage (character, integer) /** Logs a message. @param character The message to log @param integer The level this message should be logged at */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
LogMessage (character, LogLevelEnum) /** Logs a message @param character The message to log @param LogLevelEnum The level this message should be logged at */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
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) /* no-op */
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) /* no-op */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (memptr)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (memptr, int64, int64) /* no-op */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (Object)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (Object)
INT64 WriteFileStream (FileInputStream) /** Reads the contents of a file and writes the bytes as memptr @param FileInputStream A valid file stream @return int64 The number of bytes read. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
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 () /* Default constructor */

Property Summary
Options Name Purpose
Progress.Lang.Object Entity
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Progress.Lang.Class EntityType
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
ILogWriter Logger
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter


Method Detail
Top

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

PROTECTED 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 LogMessage (character, integer)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Logs a message.
Parameters:
pcMessage CHARACTER
piLogLevel INTEGER
Top

PROTECTED LogMessage (character, LogLevelEnum)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Logs a message
Parameters:
pcMessage CHARACTER
poLogLevel LogLevelEnum
Top

PUBLIC 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

PUBLIC INT64 Write (character)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
/* no-op
Parameters:
p0 CHARACTER
Returns INT64
Top

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

PUBLIC INT64 Write (longchar)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
/* no-op
Parameters:
p0 LONGCHAR
Returns INT64
Top

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

PUBLIC INT64 Write (memptr, int64, int64)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
/* no-op
Parameters:
p0 MEMPTR
p1 INT64
p2 INT64
Returns INT64
Top

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

PROTECTED INT64 WriteFileStream (FileInputStream)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Reads the contents of a file and writes the bytes as memptr
Parameters:
pStream FileInputStream
Returns INT64
int64 The number of bytes read.
Top

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

PROTECTED 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

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


Constructor Detail
Top

PUBLIC DefaultRequestFilter ()
/* Default constructor


Property Detail
Top

PUBLIC Progress.Lang.Object Entity
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Returns Progress.Lang.Object
Top

PUBLIC Progress.Lang.Class EntityType
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Returns Progress.Lang.Class
Top

PUBLIC ILogWriter Logger
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Returns ILogWriter


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0