Namespace: OpenEdge.Net.HTTP.Filter.Writer
Class
RequestWriterBuilder
Parent classes:
Progress.Lang.Object
OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Net.HTTP.ConfigBuilder
OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder

Inherits: OpenEdge.Net.HTTP.ConfigBuilder

Copyright (c) 2015, 2018-2019 by Progress Software Corporation. All rights reserved.
File:RequestWriterBuilder
Purpose:Builds a request writer for a given type of entity
Author(s):pjudge
Created:Thu Jan 29 09:30:28 EST 2015
/* The type of request being built.




Method Summary
Options Name Purpose
OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder Build () /** Returns a request writer for a given request. @return RequestWriterBuilder The writer to use */
OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder Build (IHttpRequest) /** Returns a request writer for a given request. @param IHttpRequest The request for which to build a writer @return RequestWriterBuilder The writer to use */
Progress.Lang.Class GetWriter (IHttpRequest, BuilderRegistry) /** Returns a request writer from a particular registry The search alogrithm is 1. A writer for the HTTP Version+METHOD 2. A writer for the HTTP version 3. The writer for HTTP/1.1 . We use HTTP/1.1 as a defautl because it's pretty pervasive @param IHttpRequest The request for which we are seeking a writer @param BuilderRegistry The registry in which to look @return Progress.Lang.Class The type of the writer. It's the caller's responsibility to invoke and use the writer */
InitializeRegistry (BuilderRegistry) /** Adds initial values into the registry @param BuilderRegistry The registry to populate */
OpenEdge.Net.HTTP.Filter.Payload.MessageWriter NewRequestWriter ()
OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder Request (IHttpRequest) /** Adds a message to the writer (for any extra context). @param IHttpRequest The message @return RequestWriterBuilder The writer used */
OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder WriteTo (ByteBucket) /** Specifies the ByteBucket to use for the message body @param ByteBucket The bucket to use @return RequestWriterBuilder The writer used */

Constructor Summary
Options Name Purpose
RequestWriterBuilder () /* Default constructor */
RequestWriterBuilder (IHttpRequest) /* Constructor. @param IHttpRequest */

Property Summary
Options Name Purpose
OpenEdge.Net.HTTP.BuilderRegistry Registry
OpenEdge.Net.HTTP.IHttpRequest Request
OpenEdge.Net.HTTP.Filter.Payload.MessageWriter Writer


Method Detail
Top

OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder Build ()
Purpose: Returns a request writer for a given request.
Returns OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder
RequestWriterBuilder The writer to use
Top

OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder Build (IHttpRequest)
Purpose: Returns a request writer for a given request.
Parameters:
pRequest OpenEdge.Net.HTTP.IHttpRequest
Returns OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder
RequestWriterBuilder The writer to use
Top

Progress.Lang.Class GetWriter (IHttpRequest, BuilderRegistry)
Purpose: Returns a request writer from a particular registry
The search alogrithm is
1. A writer for the HTTP Version+METHOD
2. A writer for the HTTP version
3. The writer for HTTP/1.1 . We use HTTP/1.1 as a defautl because it's pretty pervasive
invoke and use the writer
Parameters:
pRequest OpenEdge.Net.HTTP.IHttpRequest
pRegistry OpenEdge.Net.HTTP.BuilderRegistry
Returns Progress.Lang.Class
Progress.Lang.Class The type of the writer. It's the caller's responsibility to
Top

InitializeRegistry (BuilderRegistry)
Purpose: Adds initial values into the registry
Parameters:
poRegistry OpenEdge.Net.HTTP.BuilderRegistry
Top

OpenEdge.Net.HTTP.Filter.Payload.MessageWriter NewRequestWriter ()
Returns OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Top

OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder Request (IHttpRequest)
Purpose: Adds a message to the writer (for any extra context).
Parameters:
poMessage OpenEdge.Net.HTTP.IHttpRequest
Returns OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder
RequestWriterBuilder The writer used
Top

OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder WriteTo (ByteBucket)
Purpose: Specifies the ByteBucket to use for the message body
Parameters:
poMessageBody OpenEdge.Core.ByteBucket
Returns OpenEdge.Net.HTTP.Filter.Writer.RequestWriterBuilder
RequestWriterBuilder The writer used


Constructor Detail
Top

RequestWriterBuilder ()
/* Default constructor
Top

RequestWriterBuilder (IHttpRequest)
/* Constructor.
Parameters:
pRequest OpenEdge.Net.HTTP.IHttpRequest


Property Detail
Top

OpenEdge.Net.HTTP.BuilderRegistry Registry
Returns OpenEdge.Net.HTTP.BuilderRegistry
Top

OpenEdge.Net.HTTP.IHttpRequest Request
Returns OpenEdge.Net.HTTP.IHttpRequest
Top

OpenEdge.Net.HTTP.Filter.Payload.MessageWriter Writer
Returns OpenEdge.Net.HTTP.Filter.Payload.MessageWriter


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15