Namespace: OpenEdge.Net.HTTP
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
/* the decorated Request. this can be a decoration or an actual http Request




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

PUBLIC ClearCookies ()
Top

PUBLIC ClearHeaders ()
Top

PUBLIC 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

PUBLIC OpenEdge.Net.HTTP.Cookie GetCookie (character)
Parameters:
pcName CHARACTER
Returns OpenEdge.Net.HTTP.Cookie
Top

PUBLIC INTEGER GetCookies (Cookie[])
Parameters:
poCookies OpenEdge.Net.HTTP.Cookie
Returns INTEGER
Top

PUBLIC OpenEdge.Net.HTTP.HttpHeader GetHeader (character)
Parameters:
pcName CHARACTER
Returns OpenEdge.Net.HTTP.HttpHeader
Top

PUBLIC INTEGER GetHeaders (HttpHeader[])
Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader
Returns INTEGER
Top

PUBLIC LOGICAL HasCookie (character)
Parameters:
pcName CHARACTER
Returns LOGICAL
Top

PUBLIC LOGICAL HasCookie (Cookie)
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Returns LOGICAL
Top

PUBLIC LOGICAL HasHeader (character)
Parameters:
pcName CHARACTER
Returns LOGICAL
Top

PUBLIC RemoveCookie (character)
Parameters:
pcName CHARACTER
Top

PUBLIC RemoveCookie (Cookie)
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Top

PUBLIC RemoveHeader (character)
Parameters:
pcName CHARACTER
Top

PUBLIC SetCookie (Cookie)
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Top

PUBLIC SetCookies (Cookie[])
Purpose: Adds cookies to this message
Parameters:
poCookies OpenEdge.Net.HTTP.Cookie
Top

PUBLIC SetHeader (HttpHeader)
Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader
Top

PUBLIC 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

PUBLIC HttpResponseDecorator (IHttpResponse)
Parameters:
poHttpResponse OpenEdge.Net.HTTP.IHttpResponse


Property Detail
Top

PUBLIC CHARACTER CharacterEncoding
Returns CHARACTER
Top

PUBLIC INTEGER ContentLength
Returns INTEGER
Top

PUBLIC RAW ContentMD5
Returns RAW
Top

PUBLIC CHARACTER ContentType
Returns CHARACTER
Top

PROTECTED OpenEdge.Net.HTTP.IHttpResponse DecoratedHttpResponse
Returns OpenEdge.Net.HTTP.IHttpResponse
Top

PUBLIC Progress.Lang.Object Entity
Returns Progress.Lang.Object
Top

PUBLIC INTEGER StatusCode
Returns INTEGER
Top

PUBLIC CHARACTER StatusReason
Returns CHARACTER
Top

PUBLIC CHARACTER TransferEncoding
Returns CHARACTER
Top

PUBLIC CHARACTER Version
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0