Namespace: OpenEdge.Net.HTTP.Filter.Writer
Type: Class MessageWriterBuilder
Parent Classes:
Inherits: OpenEdge.Net.HTTP.ConfigBuilder


Copyright (c) 2015, 2017, 2021 by Progress Software Corporation. All rights reserved.
File:MessageWriterBuilder
Purpose:Builds a request writer for a given type of entity
Author(s):pjudge
Created:Thu Jan 29 09:30:28 EST 2015
Purpose: (mandatory) The content type that this builder is for



Method Summary
  Options Name Purpose
  OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Build (character, BuilderRegistry) /** Returns an entity writer for a content type @param character The content type being processed. @param BuilderRegistry The registry that contains the mappings between content types and writers @return MessageWriterBuilder The entity writer to use */
  OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Build (IHttpMessage, BuilderRegistry) /** Returns an entity writer for a message @param IHttpMessage The message being processed @param BuilderRegistry The registry that contains the mappings between content types and writers @return MessageWriterBuilder The entity writer builder to use */
  Progress.Lang.Class GetWriter (character) /** Returns a content type writer. The search alogrithm is 1. Exact match - type / sub-type 2. Vendor types - type / vendor-prefix-removed-sub-type Suffixes - type / suffix 3. General type - type / * 4. Fallback to HTTP default - application/octet-stream @param character The name of the content type to register @return logical True if the content type was previously registered */
  OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Option (character, character) /** Adds or overwrites an option for the client library. @param character The name of the option @param character The value of the option (can be anything) @return MessageWriterBuilder This builder object. */
  OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Option (character, decimal) /** Adds or overwrites an option for the client library. @param character The name of the option @param decimal The value of the option (can be anything) @return MessageWriterBuilder This builder object. */
  OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Option (character, int64) /** Adds or overwrites an option for the client library. @param character The name of the option @param int64 The value of the option (can be anything) @return MessageWriterBuilder This builder object. */
  OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Option (character, logical) /** Adds or overwrites an option for the client library. @param character The name of the option @param logical The value of the option (can be anything) @return MessageWriterBuilder This builder object. */
  OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Option (character, Object) /** Adds or overwrites an option for the client library. @param character The name of the option @param Object The value of the option (can be anything) @return MessageWriterBuilder This builder object. */
  OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder WriteTo (Object) /** Specifies the Entity object to use for the message body @param ByteBucket The bucket to use @return MessageWriterBuilder The writer used */

Constructor Summary
  Options Name Purpose
  MessageWriterBuilder (character, BuilderRegistry) /** Constructor @param character The content type used by this registry @param BuilderRegistry The registry used */

Property Summary
  Options Name Purpose
  CHARACTER ContentType
  OpenEdge.Net.HTTP.BuilderRegistry Registry
  OpenEdge.Net.HTTP.Filter.Payload.MessageWriter Writer
  OpenEdge.Net.HTTP.BuilderRegistry WriterRegistry


Method Detail
Top

OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Build (character, BuilderRegistry)

Purpose: Returns an entity writer for a content type
Parameters:
pcContentType CHARACTER
 
poRegistry OpenEdge.Net.HTTP.BuilderRegistry
 
Returns OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder
  MessageWriterBuilder The entity writer to use
Top

OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Build (IHttpMessage, BuilderRegistry)

Purpose: Returns an entity writer for a message
Parameters:
poMessage OpenEdge.Net.HTTP.IHttpMessage
 
poRegistry OpenEdge.Net.HTTP.BuilderRegistry
 
Returns OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder
  MessageWriterBuilder The entity writer builder to use
Top

Progress.Lang.Class GetWriter (character)

Purpose: Returns a content type writer.
The search alogrithm is
1. Exact match - type / sub-type
2. Vendor types - type / vendor-prefix-removed-sub-type
Suffixes - type / suffix
3. General type - type / *
4. Fallback to HTTP default - application/octet-stream
Parameters:
pcContentType CHARACTER
 
Returns Progress.Lang.Class
  logical True if the content type was previously registered
Top

OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Option (character, character)

Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
 
pcValue CHARACTER
 
Returns OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder
  MessageWriterBuilder This builder object.
Top

OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Option (character, decimal)

Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
 
pdValue DECIMAL
 
Returns OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder
  MessageWriterBuilder This builder object.
Top

OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Option (character, int64)

Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
 
piValue INT64
 
Returns OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder
  MessageWriterBuilder This builder object.
Top

OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Option (character, logical)

Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
 
plValue LOGICAL
 
Returns OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder
  MessageWriterBuilder This builder object.
Top

OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder Option (character, Object)

Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
 
poValue Progress.Lang.Object
 
Returns OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder
  MessageWriterBuilder This builder object.
Top

OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder WriteTo (Object)

Purpose: Specifies the Entity object to use for the message body
Parameters:
poEntity Progress.Lang.Object
 
Returns OpenEdge.Net.HTTP.Filter.Writer.MessageWriterBuilder
  MessageWriterBuilder The writer used


Constructor Detail
Top

MessageWriterBuilder (character, BuilderRegistry)

Purpose: Constructor
Parameters:
pcContentType CHARACTER
 
poRegistry OpenEdge.Net.HTTP.BuilderRegistry
 


Property Detail
Top

CHARACTER ContentType

Returns CHARACTER
 
Top

OpenEdge.Net.HTTP.BuilderRegistry Registry

Returns OpenEdge.Net.HTTP.BuilderRegistry
 
Top

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

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

OpenEdge.Net.HTTP.BuilderRegistry WriterRegistry

Returns OpenEdge.Net.HTTP.BuilderRegistry