Namespace: OpenEdge.Net.HTTP
Class
HttpHeaderBuilder
Parent classes:
Inherits: OpenEdge.Net.HTTP.ConfigBuilder

Copyright (c) 2015, 2017-2018 by Progress Software Corporation. All rights reserved.
File:HttpHeaderBuilder
Purpose:Creates an instance of an HttpHeader object.
Author(s):pjudge
Created:Fri Feb 13 13:33:42 EST 2015




Method Summary
Options Name Purpose
OpenEdge.Net.HTTP.HttpHeaderBuilder AddParameter (character, character) /* Adds a header parameter name and value @param character The parameter name @param character The parameter value @return HttpHeaderBuilder The current builder object. */
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.HttpHeaderBuilder Build (character) /** Builder director method. @return RequestBuilder A builder for the requested type */
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
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
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
InitializeRegistry (BuilderRegistry) /** Adds initial values into the registry @param BuilderRegistry The registry to populate */
OpenEdge.Net.HTTP.HttpHeaderBuilder ParametersDelimitedBy (character) /* Sets the header's parameter delimiter @param character The delimter to use between parameters @return HttpHeaderBuilder The current 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.HttpHeaderBuilder Value (character) /** Sets the header's value @param character The complete (unparsed) header value @return HttpHeaderBuilder The current builder object. */

Constructor Summary
Options Name Purpose
HttpHeaderBuilder (character)

Property Summary
Options Name Purpose
OpenEdge.Net.HTTP.HttpHeader Header
CHARACTER HeaderName
OpenEdge.Net.HTTP.BuilderRegistry Registry


Method Detail
Top

PUBLIC OpenEdge.Net.HTTP.HttpHeaderBuilder AddParameter (character, character)

/* Adds a header parameter name and value
Parameters:
pName CHARACTER
pValue CHARACTER
Returns OpenEdge.Net.HTTP.HttpHeaderBuilder
HttpHeaderBuilder The current builder object.
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.HttpHeaderBuilder Build (character)

Purpose: Builder director method.
Parameters:
pcName CHARACTER
Returns OpenEdge.Net.HTTP.HttpHeaderBuilder
RequestBuilder A builder for the requested type
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 Object GetOptionObjectValue (character)

Inherited from OpenEdge.Core.Util.ConfigBuilder
Purpose: Returns an option's object value
Parameters:
pcName CHARACTER
Returns 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 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

PRIVATE InitializeRegistry (BuilderRegistry)

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

PUBLIC OpenEdge.Net.HTTP.HttpHeaderBuilder ParametersDelimitedBy (character)

/* Sets the header's parameter delimiter
Parameters:
pcDelim CHARACTER
Returns OpenEdge.Net.HTTP.HttpHeaderBuilder
HttpHeaderBuilder The current 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 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 Object
Returns LOGICAL
logical True is the option was overwritten
Top

PUBLIC OpenEdge.Net.HTTP.HttpHeaderBuilder Value (character)

Purpose: Sets the header's value
Parameters:
pcValue CHARACTER
Returns OpenEdge.Net.HTTP.HttpHeaderBuilder
HttpHeaderBuilder The current builder object.


Constructor Detail
Top

PROTECTED HttpHeaderBuilder (character)

Parameters:
pcHeaderName CHARACTER


Property Detail
Top

PUBLIC OpenEdge.Net.HTTP.HttpHeader Header

Returns OpenEdge.Net.HTTP.HttpHeader
Top

PROTECTED CHARACTER HeaderName

Returns CHARACTER
Top

PUBLIC OpenEdge.Net.HTTP.BuilderRegistry Registry

Returns OpenEdge.Net.HTTP.BuilderRegistry


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0