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

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

Copyright (c) 2015-2016, 2018 by Progress Software Corporation. All rights reserved.
File:HttpResponseDecorator
Purpose:Decorator class for decorating/customising Http Requests
without requiring inheritance. This allows us to construct
more complex Requests (say with proxy OR with credentials,
no proxy) without having to have individual types for all the
combinations
Author(s):pjudge
Created:Wed Jan 28 16:19:09 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



Method Summary
  Options Name Purpose
  ClearCookies ()
  ClearHeaders ()
  Progress.Lang.Object GetAdapter (Class) /* Returns an adapter for this message @param P.L.Class The type we want to adapt this message to @return P.L.Object The adapter. Will typically be of the type specified by the input argument */
  OpenEdge.Net.HTTP.Cookie GetCookie (character)
  INTEGER GetCookies (Cookie[])
  OpenEdge.Net.HTTP.HttpHeader GetHeader (character)
  INTEGER GetHeaders (HttpHeader[])
  LOGICAL HasCookie (character)
  LOGICAL HasCookie (Cookie)
  LOGICAL HasHeader (character)
  RemoveCookie (character)
  RemoveCookie (Cookie)
  RemoveHeader (character)
  SetCookie (Cookie)
  SetCookies (Cookie[]) /** Adds cookies to this message @param Cookie[] An array of cookies to add. */
  SetHeader (HttpHeader)
  SetHeaders (HttpHeader[]) /** Adds a set of header info to this message's collection of headers. @param HttpHeader[] An array of headers */

Constructor Summary
  Options Name Purpose
  HttpResponseDecorator (IHttpResponse)

Property Summary
  Options Name Purpose
  CHARACTER CharacterEncoding
  INTEGER ContentLength
  RAW ContentMD5
  CHARACTER ContentType
  OpenEdge.Net.HTTP.IHttpResponse DecoratedHttpResponse
  Progress.Lang.Object Entity
  INTEGER StatusCode
  CHARACTER StatusReason
  CHARACTER TransferEncoding
  CHARACTER Version


Method Detail
Top

ClearCookies ()
Top

ClearHeaders ()
Top

Progress.Lang.Object GetAdapter (Class)

/* Returns an adapter for this message
Parameters:
poAdaptTo Progress.Lang.Class
 
Returns Progress.Lang.Object
  P.L.Object The adapter. Will typically be of the type specified by the input argument
Top

OpenEdge.Net.HTTP.Cookie GetCookie (character)

Parameters:
pcName CHARACTER
 
Returns OpenEdge.Net.HTTP.Cookie
 
Top

INTEGER GetCookies (Cookie[])

Parameters:
poCookies OpenEdge.Net.HTTP.Cookie
 
Returns INTEGER
 
Top

OpenEdge.Net.HTTP.HttpHeader GetHeader (character)

Parameters:
pcName CHARACTER
 
Returns OpenEdge.Net.HTTP.HttpHeader
 
Top

INTEGER GetHeaders (HttpHeader[])

Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader
 
Returns INTEGER
 
Top

LOGICAL HasCookie (character)

Parameters:
pcName CHARACTER
 
Returns LOGICAL
 
Top

LOGICAL HasCookie (Cookie)

Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
 
Returns LOGICAL
 
Top

LOGICAL HasHeader (character)

Parameters:
pcName CHARACTER
 
Returns LOGICAL
 
Top

RemoveCookie (character)

Parameters:
pcName CHARACTER
 
Top

RemoveCookie (Cookie)

Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
 
Top

RemoveHeader (character)

Parameters:
pcName CHARACTER
 
Top

SetCookie (Cookie)

Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
 
Top

SetCookies (Cookie[])

Purpose: Adds cookies to this message
Parameters:
poCookies OpenEdge.Net.HTTP.Cookie
 
Top

SetHeader (HttpHeader)

Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader
 
Top

SetHeaders (HttpHeader[])

Purpose: Adds a set of header info to this message's collection of headers.
Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader
 


Constructor Detail
Top

HttpResponseDecorator (IHttpResponse)

Parameters:
poHttpResponse OpenEdge.Net.HTTP.IHttpResponse
 


Property Detail
Top

CHARACTER CharacterEncoding

Returns CHARACTER
 
Top

INTEGER ContentLength

Returns INTEGER
 
Top

RAW ContentMD5

Returns RAW
 
Top

CHARACTER ContentType

Returns CHARACTER
 
Top

OpenEdge.Net.HTTP.IHttpResponse DecoratedHttpResponse

Returns OpenEdge.Net.HTTP.IHttpResponse
 
Top

Progress.Lang.Object Entity

Returns Progress.Lang.Object
 
Top

INTEGER StatusCode

Returns INTEGER
 
Top

CHARACTER StatusReason

Returns CHARACTER
 
Top

CHARACTER TransferEncoding

Returns CHARACTER
 
Top

CHARACTER Version

Returns CHARACTER