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

Copyright (c) 2015-2016 by Progress Software Corporation. All rights reserved.
File:ClientBuilder
Purpose:Allows the construction of a working HttpClient via a fluent
interface.
Syntax:ClientBuilder:Build(<type>).
Author(s):pjudge
Created:Tue Jan 13 10:52:05 EST 2015
Purpose: Registry for mapping build types to their implementations




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.ClientBuilder Build () /** Builder director method. @return ClientBuilder A builder for the requested type */
OpenEdge.Net.HTTP.IHttpClientLibrary BuildLibrary () /** Helper method to build a http client library */
ClearOptions () /** Clears all options for this builder */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Net.HTTP.IHttpClient DecorateClient (Class, IHttpClient) /** Decorate the client with additional behaviour @param Class The type of decorator to use @param IHttpClient The client/instance we're decorating @return IHttpClient The new, decorating client */
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.ClientBuilder KeepCookies () /** Uses a default cookie for managing cookies. @return ClientBuilder */
OpenEdge.Net.HTTP.ClientBuilder KeepCookies (ICookieJar) /** Sets a cookie jar for managing cookies. @param ICookieJar The cookie jar which manages cookies for this client @return ClientBuilder */
OpenEdge.Net.HTTP.ClientBuilder Named (character, character) /** Sets the client name and version @param character The client name @param character The client version (semantic version: major.minor.patch). @return ClientBuilder This builder object. */
LOGICAL RemoveOption (character) /** Removes an option @param character The option name */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Net.HTTP.ClientBuilder SetNumRetries (integer) /** Sets the value of the NumRetries option. @param integer A zero or positive value @return ClientBuilder This builder object. */
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.ClientBuilder SetRequestTimeout (decimal) /** Sets the value of the RequestTimeout option. @param Decimal A zero or positive value @return ClientBuilder This builder object. */
OpenEdge.Net.HTTP.ClientBuilder SetRetryPause (decimal) /** Sets the value of the PauseBetweenRetry option. @param Decimal A zero or positive value @return ClientBuilder This builder object. */
OpenEdge.Net.HTTP.ClientBuilder UsingLibrary (IHttpCLientLibrary) /** Override the default client library to be used with this http client. @param IHttpClientLibrary The library to be used @return ClientBuilder This builder instance */
OpenEdge.Net.HTTP.ClientBuilder UsingLogger (ILogWriter) /** Override the default log writer to be used with this http client @param ILogWriter The log writer to be used @return ClientBuilder This builder instance */
OpenEdge.Net.HTTP.ClientBuilder ViaProxy (character) /** Sets the URI to use as a proxy server for all requests @param character The proxy server URI @return ClientBuilder This builder object. */
OpenEdge.Net.HTTP.ClientBuilder ViaProxy (URI) /** Sets the URI to use as a proxy server for all requests @param URI The proxy server URI @return ClientBuilder This builder object. */

Property Summary
Options Name Purpose
OpenEdge.Net.HTTP.IHttpClient Client
CHARACTER PROP_CLIENT_NAME
CHARACTER PROP_CLIENT_VERSION
OpenEdge.Net.HTTP.BuilderRegistry Registry


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.ClientBuilder Build ()

Purpose: Builder director method.
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder A builder for the requested type
Top

PROTECTED OpenEdge.Net.HTTP.IHttpClientLibrary BuildLibrary ()

Purpose: Helper method to build a http client library
Returns OpenEdge.Net.HTTP.IHttpClientLibrary
Top

PROTECTED ClearOptions ()

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

PUBLIC OpenEdge.Net.HTTP.IHttpClient DecorateClient (Class, IHttpClient)

Purpose: Decorate the client with additional behaviour
Parameters:
poDecorationType Progress.Lang.Class
poDecoratedClient OpenEdge.Net.HTTP.IHttpClient
Returns OpenEdge.Net.HTTP.IHttpClient
IHttpClient The new, decorating client
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.ClientBuilder KeepCookies ()

Purpose: Uses a default cookie for managing cookies.
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder
Top

PUBLIC OpenEdge.Net.HTTP.ClientBuilder KeepCookies (ICookieJar)

Purpose: Sets a cookie jar for managing cookies.
Parameters:
poCookieJar OpenEdge.Net.HTTP.ICookieJar
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder
Top

PUBLIC OpenEdge.Net.HTTP.ClientBuilder Named (character, character)

Purpose: Sets the client name and version
Parameters:
pcName CHARACTER
pcVersion CHARACTER
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder This builder object.
Top

PROTECTED LOGICAL RemoveOption (character)

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

PUBLIC OpenEdge.Net.HTTP.ClientBuilder SetNumRetries (integer)

Purpose: Sets the value of the NumRetries option.
Parameters:
piValue INTEGER
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder This builder object.
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.ClientBuilder SetRequestTimeout (decimal)

Purpose: Sets the value of the RequestTimeout option.
Parameters:
pdValue DECIMAL
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder This builder object.
Top

PUBLIC OpenEdge.Net.HTTP.ClientBuilder SetRetryPause (decimal)

Purpose: Sets the value of the PauseBetweenRetry option.
Parameters:
pdValue DECIMAL
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder This builder object.
Top

PUBLIC OpenEdge.Net.HTTP.ClientBuilder UsingLibrary (IHttpCLientLibrary)

Purpose: Override the default client library to be used with this http client.
Parameters:
poLibrary OpenEdge.Net.HTTP.IHttpClientLibrary
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder This builder instance
Top

PUBLIC OpenEdge.Net.HTTP.ClientBuilder UsingLogger (ILogWriter)

Purpose: Override the default log writer to be used with this http client
Parameters:
poLogger OpenEdge.Logging.ILogWriter
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder This builder instance
Top

PUBLIC OpenEdge.Net.HTTP.ClientBuilder ViaProxy (character)

Purpose: Sets the URI to use as a proxy server for all requests
Parameters:
pcProxyURI CHARACTER
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder This builder object.
Top

PUBLIC OpenEdge.Net.HTTP.ClientBuilder ViaProxy (URI)

Purpose: Sets the URI to use as a proxy server for all requests
Parameters:
poProxyURI OpenEdge.Net.URI
Returns OpenEdge.Net.HTTP.ClientBuilder
ClientBuilder This builder object.


Property Detail
Top

PUBLIC OpenEdge.Net.HTTP.IHttpClient Client

Returns OpenEdge.Net.HTTP.IHttpClient
Top

PROTECTED CHARACTER PROP_CLIENT_NAME

Returns CHARACTER
Top

PROTECTED CHARACTER PROP_CLIENT_VERSION

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