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

Inherits: Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

File:SwaggerWebHnadler
Purpose:WebHandler for Swagger requests
Author(s):Martyn Kemp / Consultingwerk Ltd.
Created:Fri May 19 08:39:21 BST 2017
Notes:Compilation requires %DLC%/{gui|tty}/netlib/OpenEdge.Net.pl
in propath and PacificWebSpeed setting in products.i
/* Mike Fechner, Consultingwerk Ltd. 13.09.2017
Preprocessor variables for SmartComponentLibrary, WinKit and SmartFramework
based on Consultingwerk/packages.i now

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



Top Method Summary
Options Name Purpose
+ Consultingwerk.OERA.JsdoGenericService.RestServiceAddress GetRestServiceAddress (character) Returns the RestServiceAddress from the restapplicationsettings file
# HandleError (Error, IHttpResponse) Handels an error. The error is written into the logfile and returned to the client in the body.
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
# INTEGER HandleGet (IWebRequest) Default handler for the HTTP GET method. 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 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.
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
# 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.
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
# LogRequestDetail (IWebRequest) Logs details about the current web handler request
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
# LogRequestEnd (IWebRequest, IHttpResponse) Logs details about the end of current web handler request
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
# WriteResponse (IHttpResponse) Writes the HttpResponse to the stream
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler


Method Detail
Top

PUBLIC Consultingwerk.OERA.JsdoGenericService.RestServiceAddress GetRestServiceAddress (character)
Purpose: Returns the RestServiceAddress from the restapplicationsettings file
Notes:

Parameters:
pcEntityName CHARACTER
The BusinessEntity name of the requested catalog
Returns Consultingwerk.OERA.JsdoGenericService.RestServiceAddress
The RestServiceAddress
Top

PROTECTED HandleError (Error, IHttpResponse)
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
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 HandleGet (IWebRequest)
Purpose: Default handler for the HTTP GET method. 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 HandleNotAllowedMethod (IWebRequest)
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
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)
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
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)
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
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)
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
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 WriteResponse (IHttpResponse)
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
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


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:15:03