Namespace: OpenEdge.Net.HTTP
Type: Class HttpClientDecorator
Parent Classes:
Progress.Lang.Object
OpenEdge.Net.HTTP.HttpClientDecorator

Inherits: Progress.Lang.Object
Implements: OpenEdge.Net.HTTP.IHttpClient, OpenEdge.Core.IAdaptable

Copyright (c) 2015, 2019, 2021 by Progress Software Corporation. All rights reserved.
File:HttpClientDecorator
Purpose:Decorator class for decoracting/customising Http Clients
without requiring inheritance. This allows us to construct
more complex clients (say with cookies, no proxy OR with cookies,
with proxy) without having to have individual types for all the
combinations
Author(s):pjudge
Created:Wed Jan 21 09:26:18 EST 2015
Notes:* There's a decent description of Decorator pattern in Wikipedia
at http://en.wikipedia.org/wiki/Decorator_pattern
For instance, adding support for proxies, or cookies
/* the decorated client. this can be a decoration or an actual http client



Method Summary
  Options Name Purpose
  OpenEdge.Net.HTTP.IHttpResponse Execute (IHttpRequest) /** Executes an HTTP request. This method wraps the Execute(Req,Resp) call in the same way that the HttpClient does. If does so in order to ensure that the Execute(req, resp) is always called, because we don't want to force each decorator to have to implement this call. @param HttpRequest Request parameters (URL, method, etc) @return HttpResponse Includes status and payload */
  Execute (IHttpRequest, IHttpResponse)
  Progress.Lang.Object GetAdapter (Class)

Constructor Summary
  Options Name Purpose
  HttpClientDecorator (IHttpClient)

Property Summary
  Options Name Purpose
  CHARACTER ClientName
  CHARACTER ClientVersion
  OpenEdge.Net.HTTP.IHttpClient DecoratedHttpClient
  OpenEdge.Net.HTTP.ClientOptions Options


Method Detail
Top

OpenEdge.Net.HTTP.IHttpResponse Execute (IHttpRequest)

Purpose: Executes an HTTP request.
This method wraps the Execute(Req,Resp) call in the same way that the
HttpClient does. If does so in order to ensure that the Execute(req, resp)
is always called, because we don't want to force each decorator to have
to implement this call.
Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest
 
Returns OpenEdge.Net.HTTP.IHttpResponse
  HttpResponse Includes status and payload
Top

Execute (IHttpRequest, IHttpResponse)

Parameters:
poRequest OpenEdge.Net.HTTP.IHttpRequest
 
poResponse OpenEdge.Net.HTTP.IHttpResponse
 
Top

Progress.Lang.Object GetAdapter (Class)

Parameters:
pAdaptTo Progress.Lang.Class
 
Returns Progress.Lang.Object
 


Constructor Detail
Top

HttpClientDecorator (IHttpClient)

Parameters:
poHttpClient OpenEdge.Net.HTTP.IHttpClient
 


Property Detail
Top

CHARACTER ClientName

Returns CHARACTER
 
Top

CHARACTER ClientVersion

Returns CHARACTER
 
Top

OpenEdge.Net.HTTP.IHttpClient DecoratedHttpClient

Returns OpenEdge.Net.HTTP.IHttpClient
 
Top

OpenEdge.Net.HTTP.ClientOptions Options

Returns OpenEdge.Net.HTTP.ClientOptions