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

Copyright (c) 2015-2016 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




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 */
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 /* Returns a list of all context property names */
CHARACTER DefaultCookieDomain /* Returns the default cookie domain */
CHARACTER DefaultCookiePath /* Returns the default cookie path */
CHARACTER LocalAddress /* IP address of the interface on which the request was received */
CHARACTER LocalHost /* Host name of the interface on which the request was received */
INTEGER LocalPort /* Port number of the interface on which the request was received */
CHARACTER PathInfo /* The URL after the TransportPath. Does not include the query. */
CHARACTER PathParameterNames /* Returns a comma-delimited list of path parameter names, for URI mappings */
CHARACTER RemoteAddress /* IP address of the client or last proxy that sent the request */
CHARACTER RemoteHost /* Host name the client or the last proxy that sent the request */
INTEGER RemotePort /* Port of the client or last proxy that sent the request */
CHARACTER RemoteUser /* Login of the user making this request, or null if not authenticated */
CHARACTER ResolvedTransportPath /* The real path to the part of the URL specified by TransportPath */
CHARACTER ServerSoftware /* Return the server software */
CHARACTER TransportPath /* The part of this request's URL that specifies the OE transport */
CHARACTER UriTemplate /* Returns the URI template used to find the handler for this request. May be empty */
CHARACTER WebAppPath /* Portion of request URI that indicates the web application. */


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

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 a list of all context property names
Returns CHARACTER
Top

CHARACTER DefaultCookieDomain

/* Returns the default cookie domain
Returns CHARACTER
Top

CHARACTER DefaultCookiePath

/* Returns the default cookie path
Returns CHARACTER
Top

CHARACTER LocalAddress

/* IP address of the interface on which the request was received
Returns CHARACTER
Top

CHARACTER LocalHost

/* Host name of the interface on which the request was received
Returns CHARACTER
Top

INTEGER LocalPort

/* Port number of the interface on which the request was received
Returns INTEGER
Top

CHARACTER PathInfo

/* The URL after the TransportPath. Does not include the query.
Returns CHARACTER
Top

CHARACTER PathParameterNames

/* Returns a comma-delimited list of path parameter names, for URI mappings
Returns CHARACTER
Top

CHARACTER RemoteAddress

/* IP address of the client or last proxy that sent the request
Returns CHARACTER
Top

CHARACTER RemoteHost

/* Host name the client or the last proxy that sent the request
Returns CHARACTER
Top

INTEGER RemotePort

/* Port of the client or last proxy that sent the request
Returns INTEGER
Top

CHARACTER RemoteUser

/* Login of the user making this request, or null if not authenticated
Returns CHARACTER
Top

CHARACTER ResolvedTransportPath

/* The real path to the part of the URL specified by TransportPath
Returns CHARACTER
Top

CHARACTER ServerSoftware

/* Return the server software
Returns CHARACTER
Top

CHARACTER TransportPath

/* The part of this request's URL that specifies the OE transport
Returns CHARACTER
Top

CHARACTER UriTemplate

/* Returns the URI template used to find the handler for this request. May be empty
Returns CHARACTER
Top

CHARACTER WebAppPath

/* Portion of request URI that indicates the web application.
Returns CHARACTER


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7