Namespace: OpenEdge.Net.HTTP
Interface
IHttpMessage
Parent classes:
Inherits: Progress.Lang.Object

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:IHttpMessage
Author(s):pjudge
Created:Thu Jan 22 15:31:36 EST 2015




Method Summary
Options Name Purpose
ClearCookies () /** Removes all cookies from this message */
ClearHeaders () /** Removes all headers from this message */
OpenEdge.Net.HTTP.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 */
INTEGER GetCookies (Cookie[]) /** Returns all the cookies for this message @param Cookie[] An array of cookies @return integer The number of cookies returned */
OpenEdge.Net.HTTP.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. */
INTEGER GetHeaders (HttpHeader[]) /** Returns all the headers @param HttpHeader[] An array of headers @return integer The number of headers returned */
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 */
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 */
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 */
RemoveCookie (character) /** Removes coolies from this message for a given name @param character The name of the cookie(s) to remove. */
RemoveCookie (Cookie) /** Removes a cookie from this message @param Cookie The cookie to remove. */
RemoveHeader (character) /** Removes all headers with a given name from the set of message headers. No-op if none exists. @param character The name of the header to remove */
SetCookie (Cookie) /** Adds a cookie to this message @param Cookie The cookie to add. */
SetHeader (HttpHeader) /** Adds header info to this message's collection of headers. @param HttpHeader The header */

Property Summary
Options Name Purpose
CHARACTER CharacterEncoding /** The message's content type encoding (eg charset='utf-8'). For more detail, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7 */
INTEGER ContentLength /** The length (in bytes/characters) of the payload/entity. */
RAW ContentMD5 /** An MD5 hash of the message's content. */
CHARACTER ContentType /** The message's content type (eg text/html). For more detail, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7 */
Progress.Lang.Object Entity /** Object containing the message body/entity. The object can be of any type, which may depend on the content type. The Entity is the 'programmer-readable' version of the message body: it's the formatted, strongly-typed version */
CHARACTER TransferEncoding /** The message's Transfer-Encoding. For more detail, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6 */
CHARACTER Version /** The HTTP version supported. Typically HTTP/1.1 */


Method Detail
Top

ClearCookies ()
Purpose: Removes all cookies from this message
Top

ClearHeaders ()
Purpose: Removes all headers from this message
Top

OpenEdge.Net.HTTP.Cookie GetCookie (character)
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 OpenEdge.Net.HTTP.Cookie
Cookie The (first) cookie found by name
Top

INTEGER GetCookies (Cookie[])
Purpose: Returns all the cookies for this message
Parameters:
poCookies OpenEdge.Net.HTTP.Cookie
Returns INTEGER
integer The number of cookies returned
Top

OpenEdge.Net.HTTP.HttpHeader GetHeader (character)
Purpose: Returns a named header
Parameters:
pcName CHARACTER
Returns OpenEdge.Net.HTTP.HttpHeader
HttpHeader The header object. Null if not exists.
Top

INTEGER GetHeaders (HttpHeader[])
Purpose: Returns all the headers
Parameters:
poHeaders OpenEdge.Net.HTTP.HttpHeader
Returns INTEGER
integer The number of headers returned
Top

LOGICAL HasCookie (character)
Purpose: Indicates whether a cookie exists for this message
Parameters:
pcName CHARACTER
Returns LOGICAL
logical TRUE if this message contains the cookie
Top

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

LOGICAL HasHeader (character)
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

RemoveCookie (character)
Purpose: Removes coolies from this message for a given name
Parameters:
pcName CHARACTER
Top

RemoveCookie (Cookie)
Purpose: Removes a cookie from this message
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Top

RemoveHeader (character)
Purpose: Removes all headers with a given name from the set of message headers.
No-op if none exists.
Parameters:
pcName CHARACTER
Top

SetCookie (Cookie)
Purpose: Adds a cookie to this message
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Top

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


Property Detail
Top

CHARACTER CharacterEncoding
Purpose: The message's content type encoding (eg charset='utf-8'). For more detail, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
Returns CHARACTER
Top

INTEGER ContentLength
Purpose: The length (in bytes/characters) of the payload/entity.
Returns INTEGER
Top

RAW ContentMD5
Purpose: An MD5 hash of the message's content.
Returns RAW
Top

CHARACTER ContentType
Purpose: The message's content type (eg text/html). For more detail, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
Returns CHARACTER
Top

Progress.Lang.Object Entity
Purpose: Object containing the message body/entity. The object can be of any type,
which may depend on the content type.
The Entity is the 'programmer-readable' version of the message body: it's
the formatted, strongly-typed version
Returns Progress.Lang.Object
Top

CHARACTER TransferEncoding
Purpose: The message's Transfer-Encoding. For more detail, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6
Returns CHARACTER
Top

CHARACTER Version
Purpose: The HTTP version supported. Typically HTTP/1.1
Returns CHARACTER


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7