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

Copyright (c) 2015-2016 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




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 */
OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Build () /** Builder director method. @return ClientBuilder A builder for the requested type */
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. */
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 /** Each concrete builder will implement this differently */
CHARACTER PROP_SSL_CIPHERS
CHARACTER PROP_SSL_HOSTVERIFY
CHARACTER PROP_SSL_PROTOCOLS
OpenEdge.Net.HTTP.BuilderRegistry Registry /** Registry for the mapping of library types to their builder. */


Method Detail
Top

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

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

OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Build ()

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

InitializeRegistry (BuilderRegistry)

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

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

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

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

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

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

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

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

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

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

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

OpenEdge.Net.HTTP.IHttpClientLibrary Library

Purpose: Each concrete builder will implement this differently
Returns OpenEdge.Net.HTTP.IHttpClientLibrary
Top

CHARACTER PROP_SSL_CIPHERS

Returns CHARACTER
Top

CHARACTER PROP_SSL_HOSTVERIFY

Returns CHARACTER
Top

CHARACTER PROP_SSL_PROTOCOLS

Returns CHARACTER
Top

OpenEdge.Net.HTTP.BuilderRegistry Registry

Purpose: Registry for the mapping of library types to their builder.
Returns OpenEdge.Net.HTTP.BuilderRegistry


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7