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.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 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
ABSTRACT

File:SmartWebHandler
Purpose:Base class for WebHandler classes
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Wed Jun 01 08:18:13 CEST 2016
Notes:Compilation requires %DLC%/{gui|tty}/netlib/OpenEdge.Net.pl
in propath and PacificWebSpeed setting in products.i

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) Handels 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.
# 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

PROTECTED 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 methords 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

PROTECTED HandleError (Error, IHttpResponse)
Purpose: Handels 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

PROTECTED 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

PROTECTED 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

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

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

PROTECTED 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 reponse generated
Top

PROTECTED OnBeginRequest (BeginRequestEventArgs)
Purpose: Raises the BeginRequest
Notes:

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

PROTECTED OnEndRequest (EndRequestEventArgs)
Purpose: Raises the EndRequest
Notes:

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

PROTECTED WriteResponse (IHttpResponse)
Purpose: Writes the HttpResponse to the stream
Notes: Does handle OpenEdge.Core.String seperatly 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

PUBLIC 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

PUBLIC 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

PUBLIC OpenEdge.Web.IWebRequest CurrentRequest

Returns OpenEdge.Web.IWebRequest


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:52:48