Namespace: OpenEdge.Web
Class
WebRequest
Parent classes:
Progress.Lang.Object
OpenEdge.Web.WebRequest

Inherits: Progress.Lang.Object
Implements: OpenEdge.Web.IWebRequest

Copyright (c) 2015-2016, 2018 by Progress Software Corporation. All rights reserved.
Purpose:An HttpRequest that adds request context information
Author(s):mbanks
Created:Fri Apr 24 14:07:54 EDT 2015
Notes:The assumption is that this is created on each web request
DO NOT KEEP ALIVE BETWEEN REQUESTS.
@since:11.6




Method Summary
Options Name Purpose
ClearCookies () /** Removes all cookies is not implemented */
ClearHeaders () /** Remove all headers is not implemented . */
OpenEdge.Core.Collections.IStringStringMap createQueryMapFromContext () /** creates a query map from the quesry string to pass to URI constructor*/
LONGCHAR GetContextValue (character) /** Get a value from the request context */
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. The NullHeader object is returned if the header is not set on the request */
INTEGER GetHeaders (HttpHeader[]) /** Returns all the headers Note: As of current this is not cached The assumption is that you will not call this multiple times per request since there is a getHeader(name) (which does not use this). @param HttpHeader[] An array of headers @return integer The number of headers returned */
CHARACTER GetHeaderValue (character) /** Gets a character header value @param character The name of the header @return character the value of the header. */
CHARACTER GetMethodNotImplementedMessage () /** return not implemented message for method- must be called from the method **/
CHARACTER GetPathParameter (character) /** get the named path value from the URI (see IWebRequest) */
CHARACTER GetPropNotImplementedMessage () /** return not implemented message for property - must be called from setter and/or getter **/
CHARACTER GetReadOnlyMessage () /** return read only message for property - must be called from setter **/
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 */
LoadCookies () /* Private method */
RemoveCookie (character) /** Removes cookies from this message for a given name @param character The name of the cookie(s) to remove. */
RemoveCookie (Cookie) /** Remove cookie is not implemented @param Cookie The cookie to remove. */
RemoveHeader (character) /** Removes headers is not implemented . @param character The name of the header to remove */
SetCookie (Cookie) /** Set cookie is not implemented */
SetCookies (Cookie[]) /** Set cookie is not implemented */
OpenEdge.Net.HTTP.HttpHeader SetHeader (character, character) /** Adds header info to this message's collection of headers. @param character The header name @param character The header value @return HttpHeader The header actual header */
SetHeader (HttpHeader) /** Set header is not implemented */
SetHeaders (HttpHeader[]) /** Set header is not implemented */

Property Summary
Options Name Purpose
CHARACTER CharacterEncoding
INTEGER ContentLength
RAW ContentMD5
CHARACTER ContentType
CHARACTER ContextNames
CHARACTER DefaultCookieDomain
CHARACTER DefaultCookiePath
Progress.Lang.Object Entity
CHARACTER LocalAddress
CHARACTER LocalHost
INTEGER LocalPort
CHARACTER Method
CHARACTER PathInfo
CHARACTER PathParameterNames
CHARACTER RemoteAddress
CHARACTER RemoteHost
INTEGER RemotePort
CHARACTER RemoteUser
CHARACTER ResolvedTransportPath
CHARACTER ResolvedWebAppPath
CHARACTER ServerSoftware
CHARACTER TransferEncoding
CHARACTER TransportPath
OpenEdge.Net.URI URI
CHARACTER UriTemplate
CHARACTER Version
CHARACTER WebAppPath


Method Detail
Top

ClearCookies ()
Purpose: Removes all cookies is not implemented
Top

ClearHeaders ()
Purpose: Remove all headers is not implemented .
Top

OpenEdge.Core.Collections.IStringStringMap createQueryMapFromContext ()
Purpose: creates a query map from the quesry string to pass to URI constructor
Returns OpenEdge.Core.Collections.IStringStringMap
Top

LONGCHAR GetContextValue (character)
Purpose: Get a value from the request context
Parameters:
pcName CHARACTER
Returns LONGCHAR
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. The NullHeader object is returned if the header is not set on the request
Top

INTEGER GetHeaders (HttpHeader[])
Purpose: Returns all the headers
Note: As of current this is not cached
The assumption is that you will not call this multiple times per request
since there is a getHeader(name) (which does not use this).
Parameters:
poHeaders OpenEdge.Net.HTTP.HttpHeader
Returns INTEGER
integer The number of headers returned
Top

CHARACTER GetHeaderValue (character)
Purpose: Gets a character header value
Parameters:
pcName CHARACTER
Returns CHARACTER
character the value of the header.
Top

CHARACTER GetMethodNotImplementedMessage ()
Purpose: return not implemented message for method- must be called from the method
Returns CHARACTER
Top

CHARACTER GetPathParameter (character)
Purpose: get the named path value from the URI (see IWebRequest)
Parameters:
pcName CHARACTER
Returns CHARACTER
Top

CHARACTER GetPropNotImplementedMessage ()
Purpose: return not implemented message for property - must be called from setter and/or getter
Returns CHARACTER
Top

CHARACTER GetReadOnlyMessage ()
Purpose: return read only message for property - must be called from setter
Returns CHARACTER
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

LoadCookies ()
/* Private method
Top

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

RemoveCookie (Cookie)
Purpose: Remove cookie is not implemented
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Top

RemoveHeader (character)
Purpose: Removes headers is not implemented .
Parameters:
pcName CHARACTER
Top

SetCookie (Cookie)
Purpose: Set cookie is not implemented
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Top

SetCookies (Cookie[])
Purpose: Set cookie is not implemented
Parameters:
poCookie OpenEdge.Net.HTTP.Cookie
Top

OpenEdge.Net.HTTP.HttpHeader SetHeader (character, character)
Purpose: Adds header info to this message's collection of headers.
Parameters:
pName CHARACTER
pValue CHARACTER
Returns OpenEdge.Net.HTTP.HttpHeader
HttpHeader The header actual header
Top

SetHeader (HttpHeader)
Purpose: Set header is not implemented
Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader
Top

SetHeaders (HttpHeader[])
Purpose: Set header is not implemented
Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader


Property Detail
Top

CHARACTER CharacterEncoding
Returns CHARACTER
Top

INTEGER ContentLength
Returns INTEGER
Top

RAW ContentMD5
Returns RAW
Top

CHARACTER ContentType
Returns CHARACTER
Top

CHARACTER ContextNames
Returns CHARACTER
Top

CHARACTER DefaultCookieDomain
Returns CHARACTER
Top

CHARACTER DefaultCookiePath
Returns CHARACTER
Top

Progress.Lang.Object Entity
Returns Progress.Lang.Object
Top

CHARACTER LocalAddress
Returns CHARACTER
Top

CHARACTER LocalHost
Returns CHARACTER
Top

INTEGER LocalPort
Returns INTEGER
Top

CHARACTER Method
Returns CHARACTER
Top

CHARACTER PathInfo
Returns CHARACTER
Top

CHARACTER PathParameterNames
Returns CHARACTER
Top

CHARACTER RemoteAddress
Returns CHARACTER
Top

CHARACTER RemoteHost
Returns CHARACTER
Top

INTEGER RemotePort
Returns INTEGER
Top

CHARACTER RemoteUser
Returns CHARACTER
Top

CHARACTER ResolvedTransportPath
Returns CHARACTER
Top

CHARACTER ResolvedWebAppPath
Returns CHARACTER
Top

CHARACTER ServerSoftware
Returns CHARACTER
Top

CHARACTER TransferEncoding
Returns CHARACTER
Top

CHARACTER TransportPath
Returns CHARACTER
Top

OpenEdge.Net.URI URI
Returns OpenEdge.Net.URI
Top

CHARACTER UriTemplate
Returns CHARACTER
Top

CHARACTER Version
Returns CHARACTER
Top

CHARACTER WebAppPath
Returns CHARACTER


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15