Namespace: Consultingwerk.OERA.JsdoGenericService.WebHandler
Class 
Rfc7807WebErrorHandler Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.JsdoGenericService.WebHandler.Rfc7807WebErrorHandler

Inherits: Progress.Lang.Object
Implements: Consultingwerk.OERA.JsdoGenericService.WebHandler.ISmartWebErrorHandler


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



Top Method Summary
Options Name Purpose
AddErrorEntries (Error, JsonArray, character) Adds an entry to the "errors" extension array for every message of the given error object
AddErrorEntry (character, JsonArray, character) Adds a single entry to the "errors" extension array
AddInstanceUri (JsonObject) Adds the "instance" URI referencing the current request to the Problem Details document
Progress.Json.ObjectModel.JsonObject GetProblemDetails (Error, integer) Returns the RFC 7807 Problem Details document describing the given error
HandleError (Error, IHttpResponse) Handles an error. The error is written into the logfile and returned to the client in the body as an RFC 7807 Problem Details document


Method Detail
Top

AddErrorEntries (Error, JsonArray, character)
Purpose: Adds an entry to the "errors" extension array for every message
of the given error object
Notes: Every error message may contain a chr(3) delimited list of ADM2
style validation messages, each composed of the message text,
the field name and the table name separated by chr(4).
Exceptions constructed with an error string only carry their
text in the AppError ReturnValue instead of the message list

Parameters:
poError Progress.Lang.Error
The reference to the error object to process
poErrors Progress.Json.ObjectModel.JsonArray
The JsonArray to add the error entries to
pcDetail CHARACTER
OUTPUT The plain text detail composed of the message texts
Top

AddErrorEntry (character, JsonArray, character)
Purpose: Adds a single entry to the "errors" extension array
Notes: The error string is composed of the message text, the field name
and the table name separated by chr(4). The "field" and "table"
attributes are only added when present. SmartMessage references
are resolved through the ErrorHelper

Parameters:
pcErrorString CHARACTER
The chr(4) delimited error string to process
poErrors Progress.Json.ObjectModel.JsonArray
The JsonArray to add the error entry to
pcDetail CHARACTER
INPUT-OUTPUT The plain text detail the message text is appended to
Top

AddInstanceUri (JsonObject)
Purpose: Adds the "instance" URI referencing the current request to the
Problem Details document
Notes: The request id is wrapped as an urn:requestid:<id> URI as the
"instance" member is required to be a URI by RFC 7807 chapter 3.1.
The attribute is skipped when the JsonErrorWriteRequestId
configuration setting is set to false or no request id is available

Parameters:
poProblemDetails Progress.Json.ObjectModel.JsonObject
The JsonObject with the RFC 7807 Problem Details document
Top

Progress.Json.ObjectModel.JsonObject GetProblemDetails (Error, integer)
Purpose: Returns the RFC 7807 Problem Details document describing the
given error
Notes: The "errors" extension array (RFC 7807 chapter 3.2) contains one
entry per error message with distinct "message", "field" and
"table" attributes

Parameters:
poError Progress.Lang.Error
The reference to the error object to describe
piStatusCode INTEGER
The HTTP status code returned to the client
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the RFC 7807 Problem Details document
Top

HandleError (Error, IHttpResponse)
Purpose: Handles an error. The error is written into the logfile and returned
to the client in the body as an RFC 7807 Problem Details document
Notes: Content-Type of the response is set to application/problem+json

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


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       16.08.2026 16:57:11