Namespace: OpenEdge.Net.HTTP
Class 
DefaultHttpClientBuilder
Parent classes:
Inherits: OpenEdge.Net.HTTP.ClientBuilder
Implements: OpenEdge.Core.ISupportInitialize

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:DefaultHttpClientBuilder
Author(s):pjudge
Created:Wed Jan 14 14:53:46 EST 2015




Method Summary
Options Name Purpose
# OpenEdge.Net.HTTP.ClientBuilder Build () /** Builder director method. @return ClientBuilder A builder for the requested type */
Inherited from OpenEdge.Net.HTTP.ClientBuilder
# 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 */
Inherited from OpenEdge.Net.HTTP.ClientBuilder
# Destroy ()
# Initialize ()
+ InitializeRegistry (BuilderRegistry) /** Adds initial values into the registry @param BuilderRegistry The registry to populate */
Inherited from OpenEdge.Net.HTTP.ClientBuilder
# OpenEdge.Net.HTTP.ClientBuilder KeepCookies () /** Uses a default cookie for managing cookies. @return ClientBuilder */
Inherited from OpenEdge.Net.HTTP.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 */
Inherited from OpenEdge.Net.HTTP.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. */
Inherited from OpenEdge.Net.HTTP.ClientBuilder
+ OpenEdge.Net.HTTP.IHttpClient NewClient () /** Returns a useable HttpClient based on the config. @return IHttpClient A useable HttpClient instance */
# 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. */
Inherited from OpenEdge.Net.HTTP.ClientBuilder
# 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. */
Inherited from OpenEdge.Net.HTTP.ClientBuilder
# 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. */
Inherited from OpenEdge.Net.HTTP.ClientBuilder
# 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 */
Inherited from OpenEdge.Net.HTTP.ClientBuilder
# 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. */
Inherited from OpenEdge.Net.HTTP.ClientBuilder
# 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. */
Inherited from OpenEdge.Net.HTTP.ClientBuilder

Constructor Summary
Options Name Purpose
# DefaultHttpClientBuilder ()

Property Summary
Options Name Purpose
# OpenEdge.Net.HTTP.IHttpClient Client /** Returns a configured client. */
Overrides OpenEdge.Net.HTTP.ClientBuilder:Client
# BuilderRegistry Registry /** Registry for mapping build types to their implementations */
Inherited from OpenEdge.Net.HTTP.ClientBuilder


Method Detail
Top

PROTECTED OpenEdge.Net.HTTP.ClientBuilder Build ()

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

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

Inherited from OpenEdge.Net.HTTP.ClientBuilder
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 Destroy ()

Top

PROTECTED Initialize ()

Top

PUBLIC InitializeRegistry (BuilderRegistry)

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

PROTECTED OpenEdge.Net.HTTP.ClientBuilder KeepCookies ()

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

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

Inherited from OpenEdge.Net.HTTP.ClientBuilder
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)

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

PUBLIC OpenEdge.Net.HTTP.IHttpClient NewClient ()

Purpose: Returns a useable HttpClient based on the config.
Returns OpenEdge.Net.HTTP.IHttpClient
IHttpClient A useable HttpClient instance
Top

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

Inherited from OpenEdge.Net.HTTP.ClientBuilder
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)

Inherited from OpenEdge.Net.HTTP.ClientBuilder
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)

Inherited from OpenEdge.Net.HTTP.ClientBuilder
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)

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

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

Inherited from OpenEdge.Net.HTTP.ClientBuilder
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)

Inherited from OpenEdge.Net.HTTP.ClientBuilder
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.


Constructor Detail
Top

PROTECTED DefaultHttpClientBuilder ()



Property Detail
Top

PROTECTED OpenEdge.Net.HTTP.IHttpClient Client

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

PROTECTED BuilderRegistry Registry

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


10.27.2015 12:36:37