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

Inherits: Progress.Lang.Object

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:HttpHeader
Purpose:A basic HTTP header. Can be extended for headers that have multi-part values
(like Content-Type which has an optional charset= part.
Author(s):pjudge
Created:Wed Feb 11 11:49:10 EST 2015




Method Summary
Options Name Purpose
ClearParams () /** Removes any parameter records for this header. */
# ExtractParameters () /** Extracts/separates any parameters from the header's value, and stores the 'clean' value. */
# CHARACTER GetBaseValue () /** Returns the unparameterised value for this header. @return character The value. */
# CHARACTER GetParameterValue (character) /** Returns a parameter from a (for example, 'charset' from Content-Type) header value @param character The name of the parameter value to retrieve @return character The charset paremeter value; blank/empty otherwise */
# CHARACTER GetParameterValues () /** Returns the unparameterised value for this header. @return character The value. */
# LOGICAL HasParameter (character) /** Indicates whether a parameter exists in the header @param character The name of the parameter to check. @return logical True if the parameter exists. */
# LOGICAL SetParameterValue (character, character) /** Returns a parameter from a (for example, 'charset' from Content-Type) header value @param character The name of the parameter value to retrieve @param character The charset paremeter value; blank/empty otherwise @param character The character used to separate param name/value pairs @return logical True when the parameter was replaced/previously existed. */
# CHARACTER ToString ()

Constructor Summary
Options Name Purpose
# HttpHeader (character) /** Constructor @param character The header name */
# HttpHeader (character, character) /** Constructor @param character The header name @param character The header value */

Property Summary
Options Name Purpose
# CHARACTER Name /** (mandatory) The name of the header */
# CHARACTER ParamDelimiter /** (optional) delimiter for header parameters */
# CHARACTER Value /** A header value */


Method Detail
Top

ClearParams ()
Purpose: Removes any parameter records for this header.
Top

PROTECTED ExtractParameters ()
Purpose: Extracts/separates any parameters from the header's value, and stores the 'clean' value.
Top

PROTECTED CHARACTER GetBaseValue ()
Purpose: Returns the unparameterised value for this header.
Returns CHARACTER
character The value.
Top

PROTECTED CHARACTER GetParameterValue (character)
Purpose: Returns a parameter from a (for example, 'charset' from Content-Type) header value
Parameters:
pcParamName CHARACTER
Returns CHARACTER
character The charset paremeter value; blank/empty otherwise
Top

PROTECTED CHARACTER GetParameterValues ()
Purpose: Returns the unparameterised value for this header.
Returns CHARACTER
character The value.
Top

PROTECTED LOGICAL HasParameter (character)
Purpose: Indicates whether a parameter exists in the header
Parameters:
pcParamName CHARACTER
Returns LOGICAL
logical True if the parameter exists.
Top

PROTECTED LOGICAL SetParameterValue (character, character)
Purpose: Returns a parameter from a (for example, 'charset' from Content-Type) header value
Parameters:
pcParamName CHARACTER
pcParamValue CHARACTER
Returns LOGICAL
logical True when the parameter was replaced/previously existed.
Top

PROTECTED CHARACTER ToString ()
Returns CHARACTER


Constructor Detail
Top

PROTECTED HttpHeader (character)
Purpose: Constructor
Parameters:
pcName CHARACTER
Top

PROTECTED HttpHeader (character, character)
Purpose: Constructor
Parameters:
pcName CHARACTER
pcValue CHARACTER


Property Detail
Top

PROTECTED CHARACTER Name
Purpose: (mandatory) The name of the header
Returns CHARACTER
Top

PROTECTED CHARACTER ParamDelimiter
Purpose: (optional) delimiter for header parameters
Returns CHARACTER
Top

PROTECTED CHARACTER Value
Purpose: A header value
Returns CHARACTER


10.27.2015 12:36:46