Consultingwerk.OERA.Swagger.SwaggerRestEntitiesWebHandler

Namespace:

Consultingwerk.OERA.Swagger

Class

SwaggerRestEntitiesWebHandler

Parent classes:

OpenEdge.Web.WebHandler

Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

Consultingwerk.OERA.Swagger.SwaggerRestEntitiesWebHandler

Inherits:

Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

File:	SwaggerRestEntitiesWebHandler
Purpose:	Web handler to access Swagger documentation for RESTful
	Business Entities
Author(s):	Martyn Kemp / Consultingwerk Ltd.
Created:	Tue Sep 12 12:47:31 BST 2017
Notes:	Supports the "SwaggerRequests" custom log entry type for
	detailed error logging

Top Method Summary

Options	Name	Purpose
-	GenerateHtml (character, IHttpResponse)	Generate html page displaying all BusinessServices found in Package
-	GenerateJson (character, IHttpResponse)	Generates a list of all BusinessServices found in Package as json
#	CharacterDictionary GetQueryStringAsDictionary (IWebRequest)	Returns a CharacterDictionary containing the query string for a web request Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
#	HandleError (Error, IHttpResponse)	Handles 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)	Handles the http GET operation
#	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
#	OnBeginRequest (BeginRequestEventArgs)	Raises the BeginRequest Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
#	OnEndRequest (EndRequestEventArgs)	Raises the EndRequest Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
#	WriteResponse (IHttpResponse)	Writes the HttpResponse to the stream Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

Top Event Summary

	Options	Name	Purpose
	+	BeginRequest (Object, BeginRequestEventArgs)	Raised when the web handler begins a request Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
	+	EndRequest (Object, EndRequestEventArgs)	Raised when the web handler begins a request Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

Top Property Summary

	Options	Name	Purpose
	+	LOGICAL CacheSwaggerFile
	+	OpenEdge.Web.IWebRequest CurrentRequest	Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

Method Detail

Top

PRIVATE GenerateHtml (character, IHttpResponse)

Purpose:	Generate html page displaying all BusinessServices found in Package
Notes:

Parameters:
pcRequestUri	CHARACTER
	The URI
poResponse	OpenEdge.Net.HTTP.IHttpResponse
	The Response to the client requesting the information

Top

PRIVATE GenerateJson (character, IHttpResponse)

Purpose:	Generates a list of all BusinessServices found in Package as json
Notes:

Parameters:
pcRequestUri	CHARACTER
	The URI of the request
poResponse	OpenEdge.Net.HTTP.IHttpResponse
	The Response to the client requesting the information

Top

PROTECTED CharacterDictionary GetQueryStringAsDictionary (IWebRequest)

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

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	CharacterDictionary
	A dictionary instance containing the query string as name-value pairs

Top

PROTECTED HandleError (Error, IHttpResponse)

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

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

PROTECTED INTEGER HandleGet (IWebRequest)

Purpose:	Handles the http GET operation
Notes:

Parameters:
poRequest	OpenEdge.Web.IWebRequest
	The IWebRequest
Returns	INTEGER
	The http response code

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 response generated

Top

PROTECTED OnBeginRequest (BeginRequestEventArgs)

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

Purpose:	Raises the BeginRequest
Notes:

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

Top

PROTECTED OnEndRequest (EndRequestEventArgs)

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

Purpose:	Raises the EndRequest
Notes:

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

Top

PROTECTED WriteResponse (IHttpResponse)

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

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

Event Detail

Top

PUBLIC BeginRequest (Object, BeginRequestEventArgs)

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

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)

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

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 LOGICAL CacheSwaggerFile

Returns	LOGICAL

Top

PUBLIC OpenEdge.Web.IWebRequest CurrentRequest

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

Returns	OpenEdge.Web.IWebRequest

info@consultingwerk.de http://www.consultingwerk.de 09.11.2024 18:38:50