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

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




Method Summary
Options Name Purpose
# 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 */
# 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 */
+ 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. */
# 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. */
# 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 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
# A OpenEdge.Net.HTTP.IHttpClient Client /** Returns a configured client. */
CHARACTER PROP_CLIENT_NAME /* constants. protected and properties to make immutable */
CHARACTER PROP_CLIENT_VERSION
# OpenEdge.Net.HTTP.BuilderRegistry Registry /** Registry for mapping build types to their implementations */


Method Detail
Top

PROTECTED OpenEdge.Net.HTTP.ClientBuilder Build ()

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

OpenEdge.Net.HTTP.IHttpClientLibrary BuildLibrary ()

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

PROTECTED 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

PUBLIC InitializeRegistry (BuilderRegistry)

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

PROTECTED OpenEdge.Net.HTTP.ClientBuilder KeepCookies ()

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

PROTECTED 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

PROTECTED 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 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 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

PROTECTED 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

PROTECTED 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

PROTECTED 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

PROTECTED 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

PROTECTED OpenEdge.Net.HTTP.IHttpClient Client

Purpose: Returns a configured client.
Returns OpenEdge.Net.HTTP.IHttpClient
Top

CHARACTER PROP_CLIENT_NAME

/* constants. protected and properties to make immutable
Returns CHARACTER
Top

CHARACTER PROP_CLIENT_VERSION

Returns CHARACTER
Top

PROTECTED OpenEdge.Net.HTTP.BuilderRegistry Registry

Purpose: Registry for mapping build types to their implementations
Returns OpenEdge.Net.HTTP.BuilderRegistry


10.27.2015 12:36:35