Namespace: Consultingwerk.OERA.JsdoGenericService.WebHandler
Class 
SmartWebHandler Copy to Clipboard
Parent classes:
OpenEdge.Web.WebHandler
Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

Inherits: OpenEdge.Web.WebHandler
Inherited by: Consultingwerk.OERA.JsdoGenericService.WebHandler.CatalogWebHandler Consultingwerk.OERA.JsdoGenericService.WebHandler.CountWebHandler Consultingwerk.OERA.JsdoGenericService.WebHandler.InvokeMethodWebHandler Consultingwerk.OERA.JsdoGenericService.WebHandler.ListBusinessServicesWebHandler Consultingwerk.OERA.JsdoGenericService.WebHandler.BusinessServicesWebHandler Consultingwerk.OERA.JsdoGenericService.WebHandler.CatalogsWebHandler Consultingwerk.OERA.JsdoGenericService.WebHandler.ResourceSubmitWebHandler Consultingwerk.OERA.JsdoGenericService.WebHandler.ResourceWebHandler Consultingwerk.OERA.RestResource.RestEntitiesWebHandler Consultingwerk.OERA.Swagger.SwaggerRestEntitiesWebHandler Consultingwerk.OERA.Swagger.SwaggerWebHandler Consultingwerk.Web2.Services.SmartViewsHandler.SmartFormWebHandler Consultingwerk.Web2.Services.SmartViewsHandler.SmartGridWebHandler Consultingwerk.Web2.Services.SmartViewsHandler.SmartViewerWebHandler Consultingwerk.Web2.WebHandler.ContextPropertiesWebHandler Consultingwerk.Web2.WebHandler.ExecuteAblWebHandler Consultingwerk.Web2.WebHandler.ExecuteQueryWebHandler Consultingwerk.Web2.WebHandler.FileSearchWebHandler Consultingwerk.Web2.WebHandler.FileUploadWebHandler Consultingwerk.Web2.WebHandler.GetImageNamesHandler Consultingwerk.Web2.WebHandler.GetImageWebHandler Consultingwerk.Web2.WebHandler.SessionContextWebHandler Consultingwerk.Web2.WebHandler.SessionInfoWebHandler Consultingwerk.Web2.WebHandler.SmartAttachmentsWebHandler Consultingwerk.Web2.WebHandler.SmartAttachmentWebHandler Consultingwerk.Web2.WebHandler.SmartEntityTableMappingHandler Consultingwerk.Web2.WebHandler.SmartFieldSecurityCheckWebHandler Consultingwerk.Web2.WebHandler.SmartLanguagesWebHandler Consultingwerk.Web2.WebHandler.SmartMenuStructureWebHandler Consultingwerk.Web2.WebHandler.SmartMenuWebHandler Consultingwerk.Web2.WebHandler.SmartMessageWebHandler Consultingwerk.Web2.WebHandler.SmartRoutesWebHandler Consultingwerk.Web2.WebHandler.SmartSecurityCheckWebHandler Consultingwerk.Web2.WebHandler.SmartTokenSecurityCheckWebHandler Consultingwerk.Web2.WebHandler.SmartTreeChildNodesWebHandler Consultingwerk.Web2.WebHandler.SmartTreeRootNodeWebHandler Consultingwerk.Web2.WebHandler.SmartValueListWebHandler Consultingwerk.Web2.WebHandler.TranslationProviderWebHandler
ABSTRACT


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
Consultingwerk.Framework.Collections.CharacterDictionary GetQueryStringAsDictionary (IWebRequest) Returns a CharacterDictionary containing the query string for a web request
HandleError (Error, IHttpResponse) Handles an error. The error is written into the logfile and returned to the client in the body.
INTEGER HandleNotAllowedMethod (IWebRequest) Handler for unsupported methods. The request being serviced and an optional status code is returned. A zero or null value means this method will deal with all errors.
INTEGER HandleNotImplemented (IWebRequest) Handler for unknown methods. The request being serviced and an optional status code is returned. A zero or null value means this method will deal with all errors.
InvokeErrorHandler (Error, IHttpResponse) Invokes the error handler
LogRequestDetail (IWebRequest) Logs details about the current web handler request
LogRequestEnd (IWebRequest, IHttpResponse) Logs details about the end of current web handler request
OnBeginRequest (BeginRequestEventArgs) Raises the BeginRequest
OnEndRequest (EndRequestEventArgs) Raises the EndRequest
WriteResponse (IHttpResponse) Writes the HttpResponse to the stream

Top Constructor Summary
Options Name Purpose
SmartWebHandler () Static constructor for the SmartWebHandler class

Top Event Summary
Options Name Purpose
BeginRequest (Object, BeginRequestEventArgs) Raised when the web handler begins a request
EndRequest (Object, EndRequestEventArgs) Raised when the web handler begins a request

Top Property Summary
Options Name Purpose
OpenEdge.Web.IWebRequest CurrentRequest


Method Detail
Top

Consultingwerk.Framework.Collections.CharacterDictionary GetQueryStringAsDictionary (IWebRequest)
Purpose: Returns a CharacterDictionary containing the query string for
a web request
Notes: Generally, WebHandlers can and should us the request's URI:HasQueryName and
URI:GetQueryValue GetQueryValue methods to inspect the query string. But certain APIs
require a CharacterDictionary, so this method exists to provide one from
the request.

Parameters:
poRequest OpenEdge.Web.IWebRequest
The request
Returns Consultingwerk.Framework.Collections.CharacterDictionary
A dictionary instance containing the query string as name-value pairs
Top

HandleError (Error, IHttpResponse)
Purpose: Handles an error. The error is written into the logfile and returned
to the client in the body.
Notes:

Parameters:
poError Progress.Lang.Error
An instance of a Progress.Lang.Error
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response instance returned to the client
Top

INTEGER HandleNotAllowedMethod (IWebRequest)
Purpose: Handler for unsupported methods. The request being serviced and
an optional status code is returned. A zero or null value means
this method will deal with all errors.
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The IWebRequest instance representing the call
Returns INTEGER
StatusCode of the response sent to the client
Top

INTEGER HandleNotImplemented (IWebRequest)
Purpose: Handler for unknown methods. The request being serviced and an
optional status code is returned. A zero or null value means
this method will deal with all errors.
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The IWebRequest instance representing the call
Returns INTEGER
StatusCode of the response sent to the client
Top

InvokeErrorHandler (Error, IHttpResponse)
Purpose: Invokes the error handler
Notes: This method is expected to be overridden to change the JSON error details

Parameters:
poError Progress.Lang.Error
An instance of a Progress.Lang.Error
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response instance returned to the client
Top

LogRequestDetail (IWebRequest)
Purpose: Logs details about the current web handler request
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The IWebRequest instance representing the call
Top

LogRequestEnd (IWebRequest, IHttpResponse)
Purpose: Logs details about the end of current web handler request
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The IWebRequest instance representing the call
poResponse OpenEdge.Net.HTTP.IHttpResponse
The http response generated
Top

OnBeginRequest (BeginRequestEventArgs)
Purpose: Raises the BeginRequest
Notes:

Parameters:
e Consultingwerk.OERA.JsdoGenericService.WebHandler.BeginRequestEventArgs
The BeginRequestEventArgs with the data for the event
Top

OnEndRequest (EndRequestEventArgs)
Purpose: Raises the EndRequest
Notes:

Parameters:
e Consultingwerk.OERA.JsdoGenericService.WebHandler.EndRequestEventArgs
The EndRequestEventArgs with the data for the event
Top

WriteResponse (IHttpResponse)
Purpose: Writes the HttpResponse to the stream
Notes: Does handle OpenEdge.Core.String separately due to (PSC00348040)

Parameters:
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response instance to write


Constructor Detail
Top

STATIC SmartWebHandler ()
Purpose: Static constructor for the SmartWebHandler class
Notes:



Event Detail
Top

BeginRequest (Object, BeginRequestEventArgs)
Purpose: Raised when the web handler begins a request
Notes: Can be used for custom request logging or benchmarking

Parameters:
sender Progress.Lang.Object
The object that raised the BeginRequest event
e Consultingwerk.OERA.JsdoGenericService.WebHandler.BeginRequestEventArgs
The BeginRequestEventArgs with the data for the event
Top

EndRequest (Object, EndRequestEventArgs)
Purpose: Raised when the web handler begins a request
Notes: Can be used for custom request logging or benchmarking

Parameters:
sender Progress.Lang.Object
The object that raised the EndRequest event
e Consultingwerk.OERA.JsdoGenericService.WebHandler.EndRequestEventArgs
The EndRequestEventArgs with the data for the event


Property Detail
Top

OpenEdge.Web.IWebRequest CurrentRequest

Returns OpenEdge.Web.IWebRequest


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:22:28