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

Copyright (c) 2015-2016, 2018 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
ClearCookies () /** Removes all cookies from this message */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
ClearHeaders () /** Removes all headers from this message */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
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 */
Overrides OpenEdge.Net.HTTP.IHttpMessage:GetCookie (character)
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.IHttpMessage
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.IHttpMessage
INTEGER GetHeaders (HttpHeader[]) /** Returns all the headers @param HttpHeader[] An array of headers @return integer The number of headers returned */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
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 */
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 */
Overrides OpenEdge.Net.HTTP.IHttpMessage:HasCookie (character)
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.IHttpMessage
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.IHttpMessage
RemoveCookie (character) /** Removes cookies from this message for a given name @param character The name of the cookie(s) to remove. */
Overrides OpenEdge.Net.HTTP.IHttpMessage:RemoveCookie (character)
RemoveCookie (Cookie) /** Removes a cookie from this message @param Cookie The cookie to remove. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
RemoveHeader (character) /** Removes all headers with a given name from the set of message headers. No-op if none exists. @param character The name of the header to remove */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
SetCookie (Cookie) /** Adds a cookie to this message @param Cookie The cookie to add. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
SetCookies (Cookie[]) /** Adds cookies to this message @param Cookie[] An array of cookies to add. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
SetHeader (HttpHeader) /** Adds header info to this message's collection of headers. @param HttpHeader The header */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
SetHeaders (HttpHeader[]) /** Adds a set of header info to this message's collection of headers. @param HttpHeader[] An array of headers */
Inherited from OpenEdge.Net.HTTP.IHttpMessage

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


Method Detail
Top

PUBLIC ClearCookies ()

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

PUBLIC ClearHeaders ()

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

PUBLIC LONGCHAR GetContextValue (character)

/* Get a value from the request context
Parameters:
pcName CHARACTER
Returns LONGCHAR
longchar The content property value
Top

PUBLIC OpenEdge.Net.HTTP.Cookie GetCookie (character)

Overrides OpenEdge.Net.HTTP.IHttpMessage: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

PUBLIC INTEGER GetCookies (Cookie[])

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Returns all the cookies for this message
Parameters:
poCookies OpenEdge.Net.HTTP.Cookie
Returns INTEGER
integer The number of cookies returned
Top

PUBLIC HttpHeader GetHeader (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Returns a named header
Parameters:
pcName CHARACTER
Returns HttpHeader
HttpHeader The header object. Null if not exists.
Top

PUBLIC INTEGER GetHeaders (HttpHeader[])

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Returns all the headers
Parameters:
poHeaders HttpHeader
Returns INTEGER
integer The number of headers returned
Top

PUBLIC 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

PUBLIC LOGICAL HasCookie (character)

Overrides OpenEdge.Net.HTTP.IHttpMessage: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

PUBLIC LOGICAL HasCookie (Cookie)

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

PUBLIC LOGICAL HasHeader (character)

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

PUBLIC RemoveCookie (character)

Overrides OpenEdge.Net.HTTP.IHttpMessage:RemoveCookie (character)
Purpose: Removes cookies from this message for a given name
Parameters:
pcName CHARACTER
Top

PUBLIC RemoveCookie (Cookie)

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

PUBLIC RemoveHeader (character)

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes all headers with a given name from the set of message headers.
No-op if none exists.
Parameters:
pcName CHARACTER
Top

PUBLIC SetCookie (Cookie)

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

PUBLIC SetCookies (Cookie[])

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Adds cookies to this message
Parameters:
poCookies OpenEdge.Net.HTTP.Cookie
Top

PUBLIC SetHeader (HttpHeader)

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

PUBLIC SetHeaders (HttpHeader[])

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


Property Detail
Top

PUBLIC CHARACTER CharacterEncoding

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns CHARACTER
Top

PUBLIC INTEGER ContentLength

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns INTEGER
Top

PUBLIC RAW ContentMD5

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns RAW
Top

PUBLIC CHARACTER ContentType

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns CHARACTER
Top

PUBLIC CHARACTER ContextNames

Returns CHARACTER
Top

PUBLIC CHARACTER DefaultCookieDomain

Returns CHARACTER
Top

PUBLIC CHARACTER DefaultCookiePath

Returns CHARACTER
Top

PUBLIC Object Entity

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns Object
Top

PUBLIC CHARACTER LocalAddress

Returns CHARACTER
Top

PUBLIC CHARACTER LocalHost

Returns CHARACTER
Top

PUBLIC INTEGER LocalPort

Returns INTEGER
Top

PUBLIC CHARACTER Method

Inherited from OpenEdge.Net.HTTP.IHttpRequest
Returns CHARACTER
Top

PUBLIC CHARACTER PathInfo

Returns CHARACTER
Top

PUBLIC CHARACTER PathParameterNames

Returns CHARACTER
Top

PUBLIC CHARACTER RemoteAddress

Returns CHARACTER
Top

PUBLIC CHARACTER RemoteHost

Returns CHARACTER
Top

PUBLIC INTEGER RemotePort

Returns INTEGER
Top

PUBLIC CHARACTER RemoteUser

Returns CHARACTER
Top

PUBLIC CHARACTER ResolvedTransportPath

Returns CHARACTER
Top

PUBLIC CHARACTER ResolvedWebAppPath

Returns CHARACTER
Top

PUBLIC CHARACTER ServerSoftware

Returns CHARACTER
Top

PUBLIC CHARACTER TransferEncoding

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns CHARACTER
Top

PUBLIC CHARACTER TransportPath

Returns CHARACTER
Top

PUBLIC URI URI

Inherited from OpenEdge.Net.HTTP.IHttpRequest
Returns URI
Top

PUBLIC CHARACTER UriTemplate

Returns CHARACTER
Top

PUBLIC CHARACTER Version

Inherited from OpenEdge.Net.HTTP.IHttpMessage
Returns CHARACTER
Top

PUBLIC CHARACTER WebAppPath

Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0