Powered by Zoomin Software. For more details please contactZoomin

OpenEdge ABL API Reference

OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder

  • Last Updated: November 12, 2026
  • 4 minute read
    • OpenEdge
    • Version 13.1
    • Documentation
Namespace: OpenEdge.Net.HTTP.Lib
Type: Class ClientLibraryBuilder
Parent Classes:
Inherits: OpenEdge.Net.HTTP.ConfigBuilder


Copyright (c) 2015-2017,2023,2026 by Progress Software Corporation. All rights reserved.
File:ClientLibraryBuilder
Purpose:Builds instances of OpenEdge.Net.HTTP.IHttpClientLibrary
Description:Abstract base class that provides a fluent API for configuring
and building HTTP client libraries. Acts as the builder director
in the builder pattern, allowing socket connection parameters
(SSL/TLS settings, timeouts, etc.) to be configured via method
chaining before instantiation.
Created:Tue Jan 13 13:59:53 EST 2015
This class works with:
- ABLSocketLibraryBuilder: Concrete builder that creates socket-based
HTTP client libraries from the configured options
- ABLSocketLibrary: The actual HTTP client implementation that
executes requests using ClientSocket
- ClientSocketConnectionParameters: Connection configuration built
from the options set via this builder's fluent API
Typical usage:
ClientLibraryBuilder:Build()
:SetSslProtocols(...)
:SetConnectTimeout(...)
:Library // triggers library creation with configured options



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 AddTlsSupportedGroup (character)
  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: * - ABLSocketLibraryBuilder as the default ClientLibraryBuilder * - ABLSocketLibrary as the default IHttpClientLibrary * * @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 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 */
  OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetConnectTimeout (integer)
  OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetReceiveTimeout (integer)
  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 TlsSupportedGroups (character[])
  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_CONNECT_TIMEOUT
  CHARACTER PROP_RECEIVE_TIMEOUT
  CHARACTER PROP_REUSESESSION
  CHARACTER PROP_SERVERNAME
  CHARACTER PROP_SSL_CIPHERS
  CHARACTER PROP_SSL_HOSTVERIFY
  CHARACTER PROP_SSL_PROTOCOLS
  CHARACTER PROP_TLS_SUPPORTEDGROUPS
  OpenEdge.Net.HTTP.BuilderRegistry Registry


Method Detail
Top

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

Purpose:
Parameters:
pcCipher CHARACTER
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Purpose:
Parameters:
pcProtocol CHARACTER
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder AddTlsSupportedGroup (character)

Parameters:
pcGroup CHARACTER
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Top

InitializeRegistry (BuilderRegistry)

Purpose:
Parameters:
poRegistry OpenEdge.Net.HTTP.BuilderRegistry
 
Top

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

Purpose:
Parameters:
pcName CHARACTER
 
pcValue CHARACTER
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Purpose:
Parameters:
pcName CHARACTER
 
pdValue DECIMAL
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Purpose:
Parameters:
pcName CHARACTER
 
piValue INT64
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Purpose:
Parameters:
pcName CHARACTER
 
plValue LOGICAL
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Purpose:
Parameters:
pcName CHARACTER
 
poValue Progress.Lang.Object
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder ReuseSession (logical)

Purpose:
Parameters:
pReuse LOGICAL
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Purpose:
Parameters:
pServerName CHARACTER
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetConnectTimeout (integer)

Parameters:
piTimeoutMs INTEGER
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetReceiveTimeout (integer)

Parameters:
piTimeoutSec INTEGER
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetRequestTimeout (decimal)

Purpose:
Parameters:
pdValue DECIMAL
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Purpose:
Parameters:
pcCiphers CHARACTER
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Purpose:
Parameters:
pcProtocols CHARACTER
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Purpose:
Parameters:
plVerify LOGICAL
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder TlsSupportedGroups (character[])

Parameters:
pcGroups CHARACTER
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 
Top

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

Purpose:
Parameters:
poLogger OpenEdge.Logging.ILogWriter
 
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
 


Property Detail
Top

OpenEdge.Net.HTTP.IHttpClientLibrary Library

Top

CHARACTER PROP_CONNECT_TIMEOUT

Returns CHARACTER
 
Top

CHARACTER PROP_RECEIVE_TIMEOUT

Returns CHARACTER
 
Top

CHARACTER PROP_REUSESESSION

Returns CHARACTER
 
Top

CHARACTER PROP_SERVERNAME

Returns CHARACTER
 
Top

CHARACTER PROP_SSL_CIPHERS

Returns CHARACTER
 
Top

CHARACTER PROP_SSL_HOSTVERIFY

Returns CHARACTER
 
Top

CHARACTER PROP_SSL_PROTOCOLS

Returns CHARACTER
 
Top

CHARACTER PROP_TLS_SUPPORTEDGROUPS

Returns CHARACTER
 
Top

OpenEdge.Net.HTTP.BuilderRegistry Registry



Alert