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

Copyright (c) 2015, 2017 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
LOGICAL AppendArrayCharacterValue (character, character) /** Appends a character value to an array (convenience) @param character The option name @param character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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 */
ClearOptions () /** Clears all options for this builder */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL FindConfigRecord (buffer, character) /** Internal helper method to perform the find. This method attempts to find a record using the input buffer. @param buffer The buffer of the ConfigOption table. @param character The config name @return logical True if a config record was found. */
Inherited from OpenEdge.Core.Util.ConfigBuilder
DATETIME-TZ GetOptionDateTimeValue (character) /** Returns an option's datetime value @param character The option name @return datetime-tz the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL GetOptionLogicalValue (character) /** Returns an option's logical value @param character The option name @return logical the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LONGCHAR GetOptionLongcharValue (character) /** Returns an option's longchar value @param character The option name @return longchar the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
DECIMAL GetOptionNumericValue (character) /** Returns an option's decimal value @param character The option name @return decimal the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
Progress.Lang.Object GetOptionObjectValue (character) /** Returns an option's object value @param character The option name @return Object the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
CHARACTER GetOptionStringArrayValue (character) /** Returns an option's character array value @param character The option name @return character[] the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
CHARACTER GetOptionStringValue (character) /** Returns an option's character value @param character The option name @return character the value */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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 */
LOGICAL HasOption (character) /** Checks whether a config option already exists @param character The option name @return logical True if the named configuration option exists */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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. */
LOGICAL RemoveOption (character) /** Removes an option @param character The option name */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, character) /** Stores an value as an option @param character The option name @param character the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, character[]) /** Stores an value as an option @param character The option name @param character the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, datetime-tz) /** Stores a datetime-tzvalue as an option @param character The option name @param datetime-tz the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, decimal) /** Stores an numeric value as an option @param character The option name @param Object the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, logical) /** Stores a logical value as an option @param character The option name @param logical the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (character, Object) /** Stores an object value as an option @param character The option name @param Object the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
LOGICAL SetOption (Class, Object) /** Stores an object value as an option @param Progress.Lang>Class The option name (as a type) @param Object the value @return logical True is the option was overwritten */
Inherited from OpenEdge.Core.Util.ConfigBuilder
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

PROTECTED LOGICAL AppendArrayCharacterValue (character, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Appends a character value to an array (convenience)
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
Top

PUBLIC 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

PUBLIC 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

PROTECTED ClearOptions ()

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Clears all options for this builder
Top

PROTECTED LOGICAL FindConfigRecord (buffer, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Internal helper method to perform the find. This method attempts to find a record using
the input buffer.
Parameters:
pConfig buffer
pName CHARACTER
Returns LOGICAL
logical True if a config record was found.
Top

PROTECTED DATETIME-TZ GetOptionDateTimeValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's datetime value
Parameters:
pcName CHARACTER
Returns DATETIME-TZ
datetime-tz the value
Top

PROTECTED LOGICAL GetOptionLogicalValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's logical value
Parameters:
pcName CHARACTER
Returns LOGICAL
logical the value
Top

PROTECTED LONGCHAR GetOptionLongcharValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's longchar value
Parameters:
pcName CHARACTER
Returns LONGCHAR
longchar the value
Top

PROTECTED DECIMAL GetOptionNumericValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's decimal value
Parameters:
pcName CHARACTER
Returns DECIMAL
decimal the value
Top

PROTECTED Progress.Lang.Object GetOptionObjectValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's object value
Parameters:
pcName CHARACTER
Returns Progress.Lang.Object
Object the value
Top

PROTECTED CHARACTER GetOptionStringArrayValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's character array value
Parameters:
pcName CHARACTER
Returns CHARACTER
character[] the value
Top

PROTECTED CHARACTER GetOptionStringValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's character value
Parameters:
pcName CHARACTER
Returns CHARACTER
character the value
Top

PROTECTED 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

PROTECTED LOGICAL HasOption (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Checks whether a config option already exists
Parameters:
pcConfigName CHARACTER
Returns LOGICAL
logical True if the named configuration option exists
Top

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PROTECTED LOGICAL RemoveOption (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Removes an option
Parameters:
pcName CHARACTER
Returns LOGICAL
Top

PROTECTED LOGICAL SetOption (character, character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an value as an option
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, character[])

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an value as an option
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, datetime-tz)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores a datetime-tzvalue as an option
Parameters:
pcName CHARACTER
ptValue DATETIME-TZ
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, decimal)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an numeric value as an option
Parameters:
pcName CHARACTER
pdValue DECIMAL
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, logical)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores a logical value as an option
Parameters:
pcName CHARACTER
plValue LOGICAL
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (character, Object)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an object value as an option
Parameters:
pcName CHARACTER
poValue Progress.Lang.Object
Returns LOGICAL
logical True is the option was overwritten
Top

PROTECTED LOGICAL SetOption (Class, Object)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Stores an object value as an option
Parameters:
pName Progress.Lang.Class
pValue Progress.Lang.Object
Returns LOGICAL
logical True is the option was overwritten
Top

PUBLIC 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

PUBLIC MessageWriterBuilder (character, BuilderRegistry)

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


Property Detail
Top

PROTECTED CHARACTER ContentType

Returns CHARACTER
Top

PUBLIC OpenEdge.Net.HTTP.BuilderRegistry Registry

Returns OpenEdge.Net.HTTP.BuilderRegistry
Top

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

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

PROTECTED OpenEdge.Net.HTTP.BuilderRegistry WriterRegistry

Returns OpenEdge.Net.HTTP.BuilderRegistry


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0