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 */
# 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 (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 (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

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

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

PROTECTED 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

PROTECTED 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

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

PROTECTED 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

PROTECTED 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

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

PROTECTED 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

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

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


Property Detail
Top

PROTECTED 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

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

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

PROTECTED 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

PROTECTED 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

PROTECTED 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

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


10.27.2015 12:36:49