Namespace: OpenEdge.Net.HTTP.Lib
Class
ClientLibraryBuilder
Parent classes:
Inherits: OpenEdge.Net.HTTP.ConfigBuilder

Copyright (c) 2015-2017 by Progress Software Corporation. All rights reserved.
File:ClientLibraryBuilder
Purpose:Creates/builds instances of OpenEdge.Net.HTTP.IHttpClientLibrary
-implementing objects
Author(s):pjudge
Created:Tue Jan 13 13:59:53 EST 2015
Purpose: Registry for the mapping of library types to their builder.




Method Summary
Options Name Purpose
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder AddSslCipher (character) /** Adds (appends) a single SSL cipher to the config. @param character A non-empty cipher. @return ClientLibraryBuilder This builder object */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder AddSslProtocol (character) /** Adds (appends) a single SSL protocol to the config. @param character A non-empty protocols. @return ClientLibraryBuilder This 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.Lib.ClientLibraryBuilder Build () /** Builder director method. @return ClientBuilder 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
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
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.Lib.ClientLibraryBuilder 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 ClientLibraryBuilder This builder object. */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder 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 ClientLibraryBuilder This builder object. */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder 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 ClientLibraryBuilder This builder object. */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder 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 ClientLibraryBuilder This builder object. */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder 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 ClientLibraryBuilder This builder object. */
LOGICAL RemoveOption (character) /** Removes an option @param character The option name */
Inherited from OpenEdge.Core.Util.ConfigBuilder
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder ReuseSession (logical) /** Determines whether (SSL) sessions should be reused. @param logical TRUE if sessions should be reused @return ClientLibraryBuilder This builder object */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder ServerNameIndicator (character) /** Sets the server name indicator for TLS. @param character The server name indicator @return ClientLibraryBuilder 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.Lib.ClientLibraryBuilder SetRequestTimeout (decimal) /** Sets the value of the RequestTimeout option. @param Decimal A zero or positive value @return ClientLibraryBuilder This builder object. */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetSslCiphers (character[]) /** Add an array of SSL ciphers to the config. Replaces any existing ciphers. @param character[] A non-empty array of ciphers. @return ClientLibraryBuilder This builder object */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetSslProtocols (character[]) /** Add an array of SSL protocols to the config. Replaces any existing protocols. @param character[] A non-empty array of protocols. @return ClientLibraryBuilder This builder object */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SslVerifyHost (logical) /** Determines whether the SSL host should be verified @param logical True if host verification should be enabled @return ClientLibraryBuilder This builder object */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder UsingLogger (ILogWriter) /** Override the default log writer to be used with this http client @param ILogWriter The log writer to be used @return ClientLibraryBuilder This builder instance */

Property Summary
Options Name Purpose
OpenEdge.Net.HTTP.IHttpClientLibrary Library
CHARACTER PROP_REUSESESSION
CHARACTER PROP_SERVERNAME
CHARACTER PROP_SSL_CIPHERS
CHARACTER PROP_SSL_HOSTVERIFY
CHARACTER PROP_SSL_PROTOCOLS
OpenEdge.Net.HTTP.BuilderRegistry Registry


Method Detail
Top

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder AddSslCipher (character)

Purpose: Adds (appends) a single SSL cipher to the config.
Parameters:
pcCipher CHARACTER
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object
Top

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder AddSslProtocol (character)

Purpose: Adds (appends) a single SSL protocol to the config.
Parameters:
pcProtocol CHARACTER
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This 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.Lib.ClientLibraryBuilder Build ()

Purpose: Builder director method.
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientBuilder 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 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 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.Lib.ClientLibraryBuilder Option (character, character)

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

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, decimal)

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

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, int64)

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

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, logical)

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

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, Object)

Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
poValue Progress.Lang.Object
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder 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.Lib.ClientLibraryBuilder ReuseSession (logical)

Purpose: Determines whether (SSL) sessions should be reused.
Parameters:
pReuse LOGICAL
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object
Top

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder ServerNameIndicator (character)

Purpose: Sets the server name indicator for TLS.
Parameters:
pServerName CHARACTER
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder 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 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.Lib.ClientLibraryBuilder SetRequestTimeout (decimal)

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

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetSslCiphers (character[])

Purpose: Add an array of SSL ciphers to the config. Replaces any existing
ciphers.
Parameters:
pcCiphers CHARACTER
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object
Top

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetSslProtocols (character[])

Purpose: Add an array of SSL protocols to the config. Replaces any existing
protocols.
Parameters:
pcProtocols CHARACTER
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object
Top

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SslVerifyHost (logical)

Purpose: Determines whether the SSL host should be verified
Parameters:
plVerify LOGICAL
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object
Top

PUBLIC OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder UsingLogger (ILogWriter)

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


Property Detail
Top

PUBLIC OpenEdge.Net.HTTP.IHttpClientLibrary Library

Returns OpenEdge.Net.HTTP.IHttpClientLibrary
Top

PROTECTED CHARACTER PROP_REUSESESSION

Returns CHARACTER
Top

PROTECTED CHARACTER PROP_SERVERNAME

Returns CHARACTER
Top

PROTECTED CHARACTER PROP_SSL_CIPHERS

Returns CHARACTER
Top

PROTECTED CHARACTER PROP_SSL_HOSTVERIFY

Returns CHARACTER
Top

PROTECTED CHARACTER PROP_SSL_PROTOCOLS

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