Namespace: Consultingwerk.OERA.JsdoGenericService.WebHandler
Class 
BusinessServicesWebHandler Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.OERA.JsdoGenericService.WebHandler.ListBusinessServicesWebHandler

File:BusinessServicesWebHandler
Purpose:WebHandler for BusinessServices requests
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Tue Nov 29 22:36:19 CEST 2016
Notes:Compilation requires %DLC%/{gui|tty}/netlib/OpenEdge.Net.pl
in propath and PacificWebSpeed setting in products.i



Top Method Summary
Options Name Purpose
# EmptyCache () Empties the ttClassNames cache
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.ListBusinessServicesWebHandler
+ GatherClassInformation (character) Find ClassNames based on Package filtering including wildcards
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.ListBusinessServicesWebHandler
- GenerateHtml (IHttpResponse, character) Generate html page displaying all BusinessServices found in Package
- GenerateJson (IHttpResponse) Generates a list of all BusinessServices found in Package as json
- GeneratePng (IWebRequest, IHttpResponse, character) Returns an image of the BusinessEntity layout identified by Entity Name
- GenerateXml (IHttpResponse) Generates a list of all BusinessServices found in Package as xml
- CHARACTER GetDetailLink (character, character) Return a html link string
# CharacterDictionary GetQueryStringAsDictionary (IWebRequest) Returns a CharacterDictionary containing the query string for a web request
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler
# 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
# 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 Constructor Summary
Options Name Purpose
BusinessServicesWebHandler () Static constructor for the BusinessServicesWebHandler class
+ BusinessServicesWebHandler () Constructor for the BusinessServicesWebHandler class

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
+ OpenEdge.Web.IWebRequest CurrentRequest
Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler


Method Detail
Top

PROTECTED EmptyCache ()

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.ListBusinessServicesWebHandler
Purpose: Empties the ttClassNames cache
Notes:

Top

PUBLIC GatherClassInformation (character)

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.ListBusinessServicesWebHandler
Purpose: Find ClassNames based on Package filtering including wildcards
Notes:

Parameters:
pcPackageName CHARACTER
Startpackage and possible wildcard ".*"
Top

PRIVATE GenerateHtml (IHttpResponse, character)

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

Parameters:
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response to the client requesting the information
pcPackageName CHARACTER
Base package as requested to be used to build href
Top

PRIVATE GenerateJson (IHttpResponse)

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

Parameters:
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response to the client requesting the information
Top

PRIVATE GeneratePng (IWebRequest, IHttpResponse, character)

Purpose: Returns an image of the BusinessEntity layout identified by Entity Name
Notes:

Parameters:
poRequest OpenEdge.Web.IWebRequest
The Request send by the client
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response to the client requesting the information
pcBusinessEntityName CHARACTER
The BusinessEntity Name of the image to be displayed
Top

PRIVATE GenerateXml (IHttpResponse)

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

Parameters:
poResponse OpenEdge.Net.HTTP.IHttpResponse
The Response to the client requesting the information
Top

PRIVATE CHARACTER GetDetailLink (character, character)

Purpose: Return a html link string
Notes:

Parameters:
pcType CHARACTER
Type of resource to be linked to, determines the Image and alt text
pcLinkTarget CHARACTER
The URL to navigate to
Returns CHARACTER
The html link with associated image
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 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 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: 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 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 seperatly due to (PSC00348040)

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


Constructor Detail
Top

STATIC BusinessServicesWebHandler ()

Purpose: Static constructor for the BusinessServicesWebHandler class
Notes:

Top

PUBLIC BusinessServicesWebHandler ()

Purpose: Constructor for the BusinessServicesWebHandler class
Notes:



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 OpenEdge.Web.IWebRequest CurrentRequest

Inherited from Consultingwerk.OERA.JsdoGenericService.WebHandler.SmartWebHandler

Returns OpenEdge.Web.IWebRequest


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       27.03.2024 00:28:44