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

Copyright (c) 2015 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
# 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 */
# 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 (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 (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
# SetHeader (HttpHeader) /** Adds header info to this message's collection of headers. @param HttpHeader The header */
Inherited from OpenEdge.Net.HTTP.IHttpMessage

Property Summary
Options Name Purpose
# CHARACTER CharacterEncoding /** The message's content type encoding (eg charset='utf-8'). For more detail, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7 */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# INTEGER ContentLength /** The length (in bytes/characters) of the payload/entity. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# RAW ContentMD5 /** An MD5 hash of the message's content. */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# CHARACTER ContentType /** The message's content type (eg text/html). For more detail, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7 */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# CHARACTER ContextNames /* Returns a list of all context property names */
# CHARACTER DefaultCookieDomain /* Returns the default cookie domain */
# CHARACTER DefaultCookiePath /* Returns the default cookie path */
# Object Entity /** Object containing the message body/entity. The object can be of any type, which may depend on the content type. The Entity is the 'programmer-readable' version of the message body: it's the formatted, strongly-typed version */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# 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 Method /** (mandatory) GET/PUT/POST etc, Maps to MethodEnum, although there are extension methods too */
Inherited from OpenEdge.Net.HTTP.IHttpRequest
# 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 TransferEncoding /** The message's Transfer-Encoding. For more detail, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6 */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# CHARACTER TransportPath /* The part of this request's URL that specifies the OE transport */
# URI URI /** (mandatory) The URI to request eg. http://progress.com/ */
Inherited from OpenEdge.Net.HTTP.IHttpRequest
# CHARACTER Version /** The HTTP version supported. Typically HTTP/1.1 */
Inherited from OpenEdge.Net.HTTP.IHttpMessage
# CHARACTER WebAppPath /* Portion of request URI that indicates the web application. */


Method Detail
Top

PROTECTED ClearCookies ()
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes all cookies from this message
Top

PROTECTED ClearHeaders ()
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Removes all headers from this message
Top

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

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

PROTECTED 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

PROTECTED 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

PROTECTED 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

PROTECTED LOGICAL HasCookie (Cookie)
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Indicates whether a cookie exists for this message
Parameters:
poCookie Cookie
Returns LOGICAL
logical True if this message contains the cookie
Top

PROTECTED 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

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

PROTECTED 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

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

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


Property Detail
Top

PROTECTED CHARACTER CharacterEncoding
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: The message's content type encoding (eg charset='utf-8'). For more detail, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
Returns CHARACTER
Top

PROTECTED INTEGER ContentLength
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: The length (in bytes/characters) of the payload/entity.
Returns INTEGER
Top

PROTECTED RAW ContentMD5
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: An MD5 hash of the message's content.
Returns RAW
Top

PROTECTED CHARACTER ContentType
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: The message's content type (eg text/html). For more detail, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
Returns CHARACTER
Top

PROTECTED CHARACTER ContextNames
/* Returns a list of all context property names
Returns CHARACTER
Top

PROTECTED CHARACTER DefaultCookieDomain
/* Returns the default cookie domain
Returns CHARACTER
Top

PROTECTED CHARACTER DefaultCookiePath
/* Returns the default cookie path
Returns CHARACTER
Top

PROTECTED Object Entity
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: Object containing the message body/entity. The object can be of any type,
which may depend on the content type.
The Entity is the 'programmer-readable' version of the message body: it's
the formatted, strongly-typed version
Returns Object
Top

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

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

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

PROTECTED CHARACTER Method
Inherited from OpenEdge.Net.HTTP.IHttpRequest
Purpose: (mandatory) GET/PUT/POST etc, Maps to MethodEnum, although there are extension methods too
Returns CHARACTER
Top

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

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

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

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

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

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

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

PROTECTED CHARACTER ServerSoftware
/* Return the server software
Returns CHARACTER
Top

PROTECTED CHARACTER TransferEncoding
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: The message's Transfer-Encoding. For more detail, see
http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6
Returns CHARACTER
Top

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

PROTECTED URI URI
Inherited from OpenEdge.Net.HTTP.IHttpRequest
Purpose: (mandatory) The URI to request eg. http://progress.com/
Returns URI
Top

PROTECTED CHARACTER Version
Inherited from OpenEdge.Net.HTTP.IHttpMessage
Purpose: The HTTP version supported. Typically HTTP/1.1
Returns CHARACTER
Top

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


10.27.2015 12:36:57