Namespace: OpenEdge.Web
Class
WebResponse
Parent classes:
Inherits: OpenEdge.Net.HTTP.HttpResponse

Copyright (c) 2015, 2017 by Progress Software Corporation. All rights reserved.
File:WebResponse
Author(s):mbanks
Created:Wed Jun 03 13:27:12 EDT 2015
/* Default constructor.




Method Summary
Options Name Purpose
ClearCookies () /** Removes all cookies from this message */
Inherited from OpenEdge.Net.HTTP.HttpMessage
ClearHeaders () /** Removes all headers from this message */
Inherited from OpenEdge.Net.HTTP.HttpMessage
Destroy ()
Inherited from OpenEdge.Net.HTTP.HttpMessage
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 */
Inherited from OpenEdge.Net.HTTP.HttpMessage
Cookie GetCookie (character) /** Returns a cookie by name from this message. Typically returns the first cookie it finds by name, oif more than one exist @param character The cookie's name to check @return Cookie The (first) cookie found by name */
Inherited from OpenEdge.Net.HTTP.HttpMessage
INTEGER GetCookies (Cookie[]) /** Returns all the cookies for this message @param Cookie[] An array of cookies @return integer The number of cookies returned */
Inherited from OpenEdge.Net.HTTP.HttpMessage
HttpHeader GetHeader (character) /** Returns a named header @param character The name of the header to retrieve @return HttpHeader The header object. Null if not exists. */
Inherited from OpenEdge.Net.HTTP.HttpMessage
INTEGER GetHeaders (HttpHeader[]) /** Returns all the headers (Names and values) @param HttpHeader[] An array of headers @return integer The number of headers returned */
Inherited from OpenEdge.Net.HTTP.HttpMessage
LOGICAL HasCookie (character) /** Indicates whether a cookie exists for this message @param character The cookie's name to check @return logical TRUE if this message contains the cookie */
Inherited from OpenEdge.Net.HTTP.HttpMessage
LOGICAL HasCookie (Cookie) /** Indicates whether a cookie exists for this message @param Cookie The cookie to check @return logical True if this message contains the cookie */
Inherited from OpenEdge.Net.HTTP.HttpMessage
LOGICAL HasHeader (character) /** Indicates whether a header exists for this message or not. @param character The name of a header to check @return logical True if this message contains the header */
Inherited from OpenEdge.Net.HTTP.HttpMessage
Initialize ()
Inherited from OpenEdge.Net.HTTP.HttpMessage
RemoveCookie (character) /** Removes cookies from this message for a given name @param character The name of the cookie(s) to remove. */
Inherited from OpenEdge.Net.HTTP.HttpMessage
RemoveCookie (Cookie) /** Removes a cookie from this request @param Cookie The cookie to remove. */
Inherited from OpenEdge.Net.HTTP.HttpMessage
RemoveHeader (character) /** Removes a header from the collection of message headers. No-op if none exists. This implementation sets the value of the header to ?/unknown, passes it down the filter chain, and then removes it from the header collection. @param character The name of the header to remove */
Inherited from OpenEdge.Net.HTTP.HttpMessage
SetCookie (Cookie) /** Adds a cookie to this request @param Cookie The cookie to add. */
Inherited from OpenEdge.Net.HTTP.HttpMessage
SetCookies (Cookie[]) /** Adds cookies to this message @param Cookie[] An array of cookies to add. */
Inherited from OpenEdge.Net.HTTP.HttpMessage
SetHeader (character, character) /** Adds header info to this message's collection of headers. @param character The header name @param character The complete header value */
SetHeader (HttpHeader) /** Adds header info to this message's collection of headers. @param character The header name @param character The complete header value */
Inherited from OpenEdge.Net.HTTP.HttpMessage
SetHeaders (HttpHeader[]) /** Adds a set of header info to this message's collection of headers. @param HttpHeader[] An array of headers */
Inherited from OpenEdge.Net.HTTP.HttpMessage

Constructor Summary
Options Name Purpose
WebResponse () /* Default constructor. */
WebResponse (integer) /* Constructor. @param integer A status code for the response */
WebResponse (StatusCodeEnum) /* Constructor. @param StatusCodeEnum A status code for the response */

Property Summary
Options Name Purpose
CHARACTER CharacterEncoding
Inherited from OpenEdge.Net.HTTP.HttpMessage
INTEGER ContentLength
Inherited from OpenEdge.Net.HTTP.HttpMessage
RAW ContentMD5
Inherited from OpenEdge.Net.HTTP.HttpMessage
CHARACTER ContentType
Inherited from OpenEdge.Net.HTTP.HttpMessage
IStringKeyedMap Cookies
Inherited from OpenEdge.Net.HTTP.HttpMessage
Object Entity
Inherited from OpenEdge.Net.HTTP.HttpMessage
HttpHeaderCollection Headers
Inherited from OpenEdge.Net.HTTP.HttpMessage
INTEGER StatusCode
Inherited from OpenEdge.Net.HTTP.HttpResponse
CHARACTER StatusReason
Inherited from OpenEdge.Net.HTTP.HttpResponse
CHARACTER TransferEncoding
Inherited from OpenEdge.Net.HTTP.HttpMessage
CHARACTER Version
Inherited from OpenEdge.Net.HTTP.HttpMessage


Method Detail
Top

PUBLIC ClearCookies ()

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Removes all cookies from this message
Top

PUBLIC ClearHeaders ()

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Removes all headers from this message
Top

PUBLIC Destroy ()

Inherited from OpenEdge.Net.HTTP.HttpMessage
Top

PUBLIC Progress.Lang.Object GetAdapter (Class)

Inherited from OpenEdge.Net.HTTP.HttpMessage
/* 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 Cookie GetCookie (character)

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Returns a cookie by name from this message. Typically
returns the first cookie it finds by name, oif more than
one exist
Parameters:
pcName CHARACTER
Returns Cookie
Cookie The (first) cookie found by name
Top

PUBLIC INTEGER GetCookies (Cookie[])

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Returns all the cookies for this message
Parameters:
poCookies Cookie
Returns INTEGER
integer The number of cookies returned
Top

PUBLIC HttpHeader GetHeader (character)

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Returns a named header
Parameters:
pcName CHARACTER
Returns HttpHeader
HttpHeader The header object. Null if not exists.
Top

PUBLIC INTEGER GetHeaders (HttpHeader[])

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Returns all the headers (Names and values)
Parameters:
poHeaders HttpHeader
Returns INTEGER
integer The number of headers returned
Top

PUBLIC LOGICAL HasCookie (character)

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Indicates whether a cookie exists for this message
Parameters:
pcName CHARACTER
Returns LOGICAL
logical TRUE if this message contains the cookie
Top

PUBLIC LOGICAL HasCookie (Cookie)

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Indicates whether a cookie exists for this message
Parameters:
poCookie Cookie
Returns LOGICAL
logical True if this message contains the cookie
Top

PUBLIC LOGICAL HasHeader (character)

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Indicates whether a header exists for this message or not.
Parameters:
pcName CHARACTER
Returns LOGICAL
logical True if this message contains the header
Top

PUBLIC Initialize ()

Inherited from OpenEdge.Net.HTTP.HttpMessage
Top

PUBLIC RemoveCookie (character)

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Removes cookies from this message for a given name
Parameters:
pcName CHARACTER
Top

PUBLIC RemoveCookie (Cookie)

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Removes a cookie from this request
Parameters:
poCookie Cookie
Top

PUBLIC RemoveHeader (character)

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Removes a header from the collection of message headers.
No-op if none exists.
This implementation sets the value of the header to ?/unknown,
passes it down the filter chain, and then removes it from the
header collection.
Parameters:
pcName CHARACTER
Top

PUBLIC SetCookie (Cookie)

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Adds a cookie to this request
Parameters:
poCookie Cookie
Top

PUBLIC SetCookies (Cookie[])

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

PUBLIC SetHeader (character, character)

Purpose: Adds header info to this message's collection of headers.
Parameters:
pcName CHARACTER
pcValue CHARACTER
Top

PUBLIC SetHeader (HttpHeader)

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Adds header info to this message's collection of headers.
Parameters:
poHeader HttpHeader
Top

PUBLIC SetHeaders (HttpHeader[])

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


Constructor Detail
Top

PUBLIC WebResponse ()

/* Default constructor.
Top

PUBLIC WebResponse (integer)

/* Constructor.
Parameters:
pStatusCode INTEGER
Top

PUBLIC WebResponse (StatusCodeEnum)

/* Constructor.
Parameters:
pStatusCode OpenEdge.Net.HTTP.StatusCodeEnum


Property Detail
Top

PUBLIC CHARACTER CharacterEncoding

Inherited from OpenEdge.Net.HTTP.HttpMessage
Returns CHARACTER
Top

PUBLIC INTEGER ContentLength

Inherited from OpenEdge.Net.HTTP.HttpMessage
Returns INTEGER
Top

PUBLIC RAW ContentMD5

Inherited from OpenEdge.Net.HTTP.HttpMessage
Returns RAW
Top

PUBLIC CHARACTER ContentType

Inherited from OpenEdge.Net.HTTP.HttpMessage
Returns CHARACTER
Top

PROTECTED IStringKeyedMap Cookies

Inherited from OpenEdge.Net.HTTP.HttpMessage
Returns IStringKeyedMap
Top

PUBLIC Object Entity

Inherited from OpenEdge.Net.HTTP.HttpMessage
Returns Object
Top

PROTECTED HttpHeaderCollection Headers

Inherited from OpenEdge.Net.HTTP.HttpMessage
Returns HttpHeaderCollection
Top

PUBLIC INTEGER StatusCode

Inherited from OpenEdge.Net.HTTP.HttpResponse
Returns INTEGER
Top

PUBLIC CHARACTER StatusReason

Inherited from OpenEdge.Net.HTTP.HttpResponse
Returns CHARACTER
Top

PUBLIC CHARACTER TransferEncoding

Inherited from OpenEdge.Net.HTTP.HttpMessage
Returns CHARACTER
Top

PUBLIC CHARACTER Version

Inherited from OpenEdge.Net.HTTP.HttpMessage
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0