Namespace: OpenEdge.Web
Type: Interface IWebRequest
Parent Classes:
Inherits: OpenEdge.Net.HTTP.IHttpRequest


Copyright (c) 2015-2016, 2018, 2022 by Progress Software Corporation. All rights reserved.
Purpose:Standard interface for PASOE/Web requests
Author(s):mbanks
Created:Mon Apr 20 11:47:12 EDT 2015
@since:11.6
/* IP address of the interface on which the request was received



Method Summary
  Options Name Purpose
  LONGCHAR GetContextValue (character) /* Get a value from the request context @param character The name context property name @return longchar The content property value */
  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 */
  CHARACTER GetPathParameter (character) /* Get the parameter value that corresponds to the defined URI mapping that invoked the handler for this request Example: URI mapping defined in openedge.properties /customers/{custname}/orders/{ordernum} Requested URI /customers/Andersen/orders/7 GetPathParameter("custname") will return "Andersen" GetPathParameter("ordernum") will return "7" @param character name defined with curly braces in URI mapping @return character The path parameter value */
  OpenEdge.Core.Memptr GetRawEntity ()
  Progress.Lang.Object GetTypedEntity ()
  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 */
  RemoveCookie (character) /** Removes cookies from this message for a given name @param character The name of the cookie(s) to remove. */

Property Summary
  Options Name Purpose
  CHARACTER ContextNames
  CHARACTER DefaultCookieDomain
  CHARACTER DefaultCookiePath
  CHARACTER LocalAddress
  CHARACTER LocalHost
  INTEGER LocalPort
  CHARACTER PathInfo
  CHARACTER PathParameterNames
  CHARACTER RemoteAddress
  CHARACTER RemoteHost
  INTEGER RemotePort
  CHARACTER RemoteUser
  CHARACTER ResolvedTransportPath
  CHARACTER ResolvedWebAppPath
  CHARACTER ServerSoftware
  CHARACTER TransportPath
  CHARACTER UriTemplate
  CHARACTER WebAppPath


Method Detail
Top

LONGCHAR GetContextValue (character)

/* Get a value from the request context
Parameters:
pcName CHARACTER
 
Returns LONGCHAR
  longchar The content property value
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

CHARACTER GetPathParameter (character)

/* Get the parameter value that corresponds to the defined URI mapping
that invoked the handler for this request
Example:
URI mapping defined in openedge.properties /customers/{custname}/orders/{ordernum}
Requested URI /customers/Andersen/orders/7
GetPathParameter("custname") will return "Andersen"
GetPathParameter("ordernum") will return "7"
Parameters:
pcName CHARACTER
 
Returns CHARACTER
  character The path parameter value
Top

OpenEdge.Core.Memptr GetRawEntity ()

Returns OpenEdge.Core.Memptr
 
Top

Progress.Lang.Object GetTypedEntity ()

Returns Progress.Lang.Object
 
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

RemoveCookie (character)

Purpose: Removes cookies from this message for a given name
Parameters:
pcName CHARACTER
 


Property Detail
Top

CHARACTER ContextNames

Returns CHARACTER
 
Top

CHARACTER DefaultCookieDomain

Returns CHARACTER
 
Top

CHARACTER DefaultCookiePath

Returns CHARACTER
 
Top

CHARACTER LocalAddress

Returns CHARACTER
 
Top

CHARACTER LocalHost

Returns CHARACTER
 
Top

INTEGER LocalPort

Returns INTEGER
 
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 TransportPath

Returns CHARACTER
 
Top

CHARACTER UriTemplate

Returns CHARACTER
 
Top

CHARACTER WebAppPath

Returns CHARACTER