Powered by Zoomin Software. For more details please contactZoomin

OpenEdge ABL API Reference

OpenEdge.Web.WebHandler

  • Last Updated: November 12, 2026
  • 4 minute read
    • OpenEdge
    • Version 13.1
    • Documentation
Namespace: OpenEdge.Web
Type: Class WebHandler
Parent Classes:
Progress.Lang.Object

Inherits: Progress.Lang.Object
Implements: Progress.Web.IWebHandler, OpenEdge.Logging.ISupportLogging


Copyright (c) 2015-2017,2022,2024,2026 by Progress Software Corporation. All rights reserved.
Purpose:Abstract class to use as a basis for building WebSpeed for
PASOE request handlers
Author(s):mbanks
Created:Wed Jan 14 14:38:25 EST 2015
HandleNotAllowedMethod methods so which are the baseline on how
we control the messages back (either created entirely in ABL or
served by PASOE).
to control the way error states are handled. The default is to
always return an integer status code.
override specific handlers (eg. HandleGet, HandlePost, etc.).



Method Summary
  Options Name Purpose
  LOGICAL CanAcceptContentType (IWebRequest, character) /** * Ensures that the request's Accept header and the operation's ContentType values are compatible, * per https://tools.ietf.org/html/rfc7231#section-5.3.2 * ContentType must be a complete type/subtype. * Accept may contain type/subtype, type/<star> or <star>/<star> values. If <star>/<star> * values appear then we can service the request. * @param IWebRequest The request that resulted in the exception * @param character The MIME type we're wanting to return (usually from the operation) * @return logical TRUE if the operation's ContentType is compatible with the request's Accept value */
  INTEGER HandleDelete (IWebRequest) /** * Default handler for the HTTP DELETE method. * @param IWebRequest The request being serviced * @return integer An optional status code. A zero or null value means this * method will deal with all errors */
  INTEGER HandleException (Error, IWebRequest) /** * Handles an exception that has been raised while dealing with the request. * @param Progress.Lang.Error The as-yet-unhandled exception * @param IWebRequest The request that resulted in the exception * @return integer A non-null status code to use for error handling */
  INTEGER HandleGet (IWebRequest) /** * Default handler for the HTTP GET method. * @param IWebRequest The request being serviced * @return integer An optional status code. A zero or null value means this * method will deal with all errors */
  INTEGER HandleHead (IWebRequest) /** * Default handler for the HTTP HEAD method. * @param IWebRequest The request being serviced * @return integer An optional status code. A zero or null value means this * method will deal with all errors */
  INTEGER HandleNotAllowedMethod (IWebRequest) /** * Handler for unsupported methods. * @param IWebRequest The request being serviced * @return integer An optional status code. A zero or null value means this * method will deal with all errors */
  INTEGER HandleNotImplemented (IWebRequest) /** * Handler for unknown methods. * @param IWebRequest The request being serviced * @return integer An optional status code. A zero or null value means this * method will deal with all errors */
  INTEGER HandleOptions (IWebRequest) /** * Default handler for the HTTP OPTIONS method. * @param IWebRequest The request being serviced * @return integer An optional status code. A zero or null value means this * method will deal with all errors */
  INTEGER HandlePatch (IWebRequest) /** * Default handler for the HTTP PATCH method. * @param IWebRequest The request being serviced * @return integer An optional status code. A zero or null value means this * method will deal with all errors */
  INTEGER HandlePost (IWebRequest) /** * Default handler for the HTTP POST method. * @param IWebRequest The request being serviced * @return integer An optional status code. A zero or null value means this * method will deal with all errors */
  INTEGER HandlePut (IWebRequest) /** * Default handler for the HTTP PUT method. * @param IWebRequest The request being serviced * @return integer An optional status code. A zero or null value means this * method will deal with all errors */
  INTEGER HandleRequest () /** * Handle request by calling the specific handler for the request method. * @return integer An HTTP status code. Zero means that the webhandler will take care of * any errors. A non-zero value means that the PASOE webapp's error handling * will return a standard page for the error */
  INTEGER HandleTrace (IWebRequest) /** * Default handler for the HTTP TRACE method. * @param IWebRequest The request being serviced * @return integer An optional status code. A zero or null value means this * method will deal with all errors */
  LogMessage (character, integer) /** * Logs a message at the specified level. * @param character The message to log * @param integer The level this message should be logged at */

Property Summary
  Options Name Purpose
  OpenEdge.Logging.ILogWriter Logger


Method Detail
Top

LOGICAL CanAcceptContentType (IWebRequest, character)

Purpose:
Parameters:
pRequest OpenEdge.Web.IWebRequest
 
pContentType CHARACTER
 
Returns LOGICAL
 
Top

INTEGER HandleDelete (IWebRequest)

Purpose:
Parameters:
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandleException (Error, IWebRequest)

Purpose:
Parameters:
poError Progress.Lang.Error
 
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandleGet (IWebRequest)

Purpose:
Parameters:
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandleHead (IWebRequest)

Purpose:
Parameters:
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandleNotAllowedMethod (IWebRequest)

Purpose:
Parameters:
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandleNotImplemented (IWebRequest)

Purpose:
Parameters:
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandleOptions (IWebRequest)

Purpose:
Parameters:
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandlePatch (IWebRequest)

Purpose:
Parameters:
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandlePost (IWebRequest)

Purpose:
Parameters:
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandlePut (IWebRequest)

Purpose:
Parameters:
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandleRequest ()

Purpose:
Returns INTEGER
 
Top

INTEGER HandleTrace (IWebRequest)

Purpose:
Parameters:
poRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

LogMessage (character, integer)

Purpose:
Parameters:
pcMessage CHARACTER
 
piLogLevel INTEGER
 


Property Detail
Top

OpenEdge.Logging.ILogWriter Logger



Alert