Namespace: OpenEdge.Net.HTTP
Class 
HttpResponse
Parent classes:
Inherits: OpenEdge.Net.HTTP.HttpMessage
Implements: OpenEdge.Net.HTTP.IHttpResponse

Copyright (c) 2014,2015 by Progress Software Corporation. All rights reserved.
File:HttpResponse
Purpose:Contains a response for an HttpRequest
Author(s):pjudge
Created:Wed Dec 18 13:24:08 EST 2013
Notes:* Via http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html
Response = Status-Line ; Section 6.1
| response-header ; Section 6.2
| entity-header ) CRLF) ; Section 7.1
CRLF
[ message-Entity ] ; Section 7.2
http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html
Status-Line = HTTP-Version SP Status-Code SP Reason-Phrase CRLF




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

Constructor Summary
Options Name Purpose
# HttpResponse () /** Constructor. */

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 */
Inherited from OpenEdge.Net.HTTP.HttpMessage
# INTEGER ContentLength /** The length (in bytes/characters) of the payload/entity. */
Inherited from OpenEdge.Net.HTTP.HttpMessage
# RAW ContentMD5 /** An MD5 hash of the message's content. */
Inherited from OpenEdge.Net.HTTP.HttpMessage
# 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 */
Inherited from OpenEdge.Net.HTTP.HttpMessage
# Object Entity /** Object containing the response body/entity. The object can be of any type, which may depend on the content type and the body filters it passes through. */
Inherited from OpenEdge.Net.HTTP.HttpMessage
# INTEGER StatusCode /** The status of the HTTP response. Section 6.1 */
# CHARACTER StatusReason /** The status reason of the HTTP response. Section 6.1 */
# CHARACTER TransferEncoding /** The message's Transfer-Encoding. For more detail, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6 This property does not use the same mechanism that the ContentType does, since the header name used depends on whether this is a request or response. */
Inherited from OpenEdge.Net.HTTP.HttpMessage
# CHARACTER Version /** The HTTP version supported. Typically HTTP/1.1 */
Inherited from OpenEdge.Net.HTTP.HttpMessage


Method Detail
Top

PROTECTED ClearCookies ()

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

PROTECTED ClearHeaders ()

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

PROTECTED Destroy ()

Inherited from OpenEdge.Net.HTTP.HttpMessage
Top

PROTECTED 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

PROTECTED 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

PROTECTED 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

PROTECTED 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

PROTECTED 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

PROTECTED Initialize ()

Inherited from OpenEdge.Net.HTTP.HttpMessage
Top

PROTECTED RemoveCookie (Cookie)

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

PROTECTED 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

PROTECTED SetCookie (Cookie)

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

PROTECTED SetHeader (HttpHeader)

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


Constructor Detail
Top

PROTECTED HttpResponse ()

Purpose: Constructor.


Property Detail
Top

PROTECTED CHARACTER CharacterEncoding

Inherited from OpenEdge.Net.HTTP.HttpMessage
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

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: The length (in bytes/characters) of the payload/entity.
Returns INTEGER
Top

PROTECTED RAW ContentMD5

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: An MD5 hash of the message's content.
Returns RAW
Top

PROTECTED CHARACTER ContentType

Inherited from OpenEdge.Net.HTTP.HttpMessage
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 Object Entity

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: Object containing the response body/entity.
The object can be of any type, which may depend on the content type
and the body filters it passes through.
Returns Object
Top

PROTECTED INTEGER StatusCode

Purpose: The status of the HTTP response. Section 6.1
Returns INTEGER
Top

PROTECTED CHARACTER StatusReason

Purpose: The status reason of the HTTP response. Section 6.1
Returns CHARACTER
Top

PROTECTED CHARACTER TransferEncoding

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: The message's Transfer-Encoding. For more detail, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6
This property does not use the same mechanism that the ContentType does,
since the header name used depends on whether this is a request or response.
Returns CHARACTER
Top

PROTECTED CHARACTER Version

Inherited from OpenEdge.Net.HTTP.HttpMessage
Purpose: The HTTP version supported. Typically HTTP/1.1
Returns CHARACTER


10.27.2015 12:36:48