Namespace: OpenEdge.Net.HTTP
Class
HttpHeaderCollection
Parent classes:
Inherits: Progress.Lang.Object

Copyright (c) 2015-2016 by Progress Software Corporation. All rights reserved.
File:HttpHeaderCollection
Author(s):pjudge
Created:Fri Jul 10 12:00:12 EDT 2015




Method Summary
Options Name Purpose
Clear () /** Removes all headers from this message */
DeleteHeaderRecord (character) /** Private method for removing a header record @param character The header name */
LOGICAL FindHeaderRecord (character) /** Internal helper method to perform the find. @param character The header name @return logical True if a header record was found. */
LOGICAL FindHeaderRecord (handle, character) /** Internal helper method to perform the find. @param handle The buffer handle of the Headers table. @param character The header name @return logical True if a header record was found. */
OpenEdge.Net.HTTP.HttpHeader Get (character) /** Returns a named header @param character The name of the header to retrieve @return HttpHeader The header object. Returns a NullHeader if none exists. */
INTEGER GetAll (HttpHeader[]) /** Returns all the headers (Names and values) @param HttpHeader[] An array of headers @return integer The number of headers returned */
LOGICAL Has (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 */
Put (HttpHeader) /** Adds a header to this collection. @param HttpHeader The header */
Put (HttpHeader[]) /** Adds a set of headers to this collection. Overwrites any existing headers that appear in this (the target) collection. @param HttpHeader[] The headers */
Put (HttpHeaderCollection) /** Adds a set of headers to this collection. Overwrites any existing headers that appear in this (the target) collection. @param HttpHeaderCollection The header collection */
Remove (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 */
UpdateHeaderRecord (HttpHeader) /** Private method for updating the value of a header record @param HttpHeader The header */

Constructor Summary
Options Name Purpose
HttpHeaderCollection ()


Method Detail
Top

Clear ()

Purpose: Removes all headers from this message
Top

DeleteHeaderRecord (character)

Purpose: Private method for removing a header record
Parameters:
pcName CHARACTER
Top

LOGICAL FindHeaderRecord (character)

Purpose: Internal helper method to perform the find.
Parameters:
pcName CHARACTER
Returns LOGICAL
logical True if a header record was found.
Top

LOGICAL FindHeaderRecord (handle, character)

Purpose: Internal helper method to perform the find.
Parameters:
phBuffer HANDLE
pcName CHARACTER
Returns LOGICAL
logical True if a header record was found.
Top

OpenEdge.Net.HTTP.HttpHeader Get (character)

Purpose: Returns a named header
Parameters:
pcName CHARACTER
Returns OpenEdge.Net.HTTP.HttpHeader
HttpHeader The header object. Returns a NullHeader if none exists.
Top

INTEGER GetAll (HttpHeader[])

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

LOGICAL Has (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

Put (HttpHeader)

Purpose: Adds a header to this collection.
Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader
Top

Put (HttpHeader[])

Purpose: Adds a set of headers to this collection. Overwrites any existing
headers that appear in this (the target) collection.
Parameters:
poHeaders OpenEdge.Net.HTTP.HttpHeader
Top

Put (HttpHeaderCollection)

Purpose: Adds a set of headers to this collection. Overwrites any existing
headers that appear in this (the target) collection.
Parameters:
poHeaders OpenEdge.Net.HTTP.HttpHeaderCollection
Top

Remove (character)

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

UpdateHeaderRecord (HttpHeader)

Purpose: Private method for updating the value of a header record
Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader


Constructor Detail
Top

HttpHeaderCollection ()



Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7