Namespace: Consultingwerk.OERA.RestResource
Class 
RestResourceService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.RestResource.RestResourceService

Inherits: Progress.Lang.Object
Implements: Consultingwerk.OERA.RestResource.IRestResourceService


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



Top Method Summary
Options Name Purpose
DeregisterBusinessTaskRestMethod () Deregisters REST Business Tasks
DeregisterRestAddress (character) Deregisters a REST Address
DeregisterRestMethod (character) Deregisters a REST Method
dispose () Destroy/Shutdown/Anti-Initializer
Consultingwerk.OERA.RestResource.ListRestMethod GetBusinessTaskRestMethods () Returns the list of registered REST Business Task Methods
GetClassNames (Class) Populates the ttClassNames temp-table
Consultingwerk.OERA.RestResource.ListRestAddress GetRestAddresses () Returns the list of registered REST Addresses
Consultingwerk.OERA.RestResource.ListRestMethod GetRestMethods () Returns the list of registered REST Invokable Methods
initialize () Initializer/Startup
CHARACTER MatchingContentType (character, character, logical) Returns the first media type from a comma-delimited list of media types that is accepted by the given Accept header value
LOGICAL MediaTypeParametersMatch (character, character, logical) Compares the media type parameters of an Accept header entry against the parameters of a media type served by an endpoint
CHARACTER MediaTypeParameterValue (character, character) Returns the value of a named media type parameter
RegisterBusinessTaskMethods () Registers Business Task methods as REST resources
RegisterBusinessTaskRestMethod (IRestMethod) Registers a REST Method
RegisterBusinessTaskRestMethods (ListRestMethod) Registers a list of REST Addresses
RegisterEntities () Registers Business Entities as REST resources
RegisterMethods () Registers Business Entities methods and Business Tasks as REST resources
RegisterRestAddress (IRestAddress) Registers a REST Address
RegisterRestAddresses (ListRestAddress) Registers a list of REST Addresses
RegisterRestMethod (IRestMethod) Registers a REST Method
RegisterRestMethods (ListRestMethod) Registers a list of REST Addresses
CHARACTER RemoveAcceptExtensions (character) Removes the quality value (;q=...) and the subsequent accept extension parameters from an Accept header entry
Consultingwerk.OERA.RestResource.IRestRequest ResolveAddressForRequest (character, character) Resolves the current REST request to an IRestAddress and Values
Consultingwerk.OERA.RestResource.IRestRequest ResolveAddressForRequest (character, character, character) Resolves the current REST request to an IRestAddress and Values

Top Constructor Summary
Options Name Purpose
RestResourceService () Constructor for the RestResourceService class


Method Detail
Top

DeregisterBusinessTaskRestMethod ()
Purpose: Deregisters REST Business Tasks
Notes:

Top

DeregisterRestAddress (character)
Purpose: Deregisters a REST Address
Notes:

Parameters:
pcAddress CHARACTER
The Address to deregister
Top

DeregisterRestMethod (character)
Purpose: Deregisters a REST Method
Notes:

Parameters:
pcAddress CHARACTER
The Address of the method to deregister
Top

dispose ()
Purpose: Destroy/Shutdown/Anti-Initializer
Notes:

Top

Consultingwerk.OERA.RestResource.ListRestMethod GetBusinessTaskRestMethods ()
Purpose: Returns the list of registered REST Business Task Methods
Notes:

Returns Consultingwerk.OERA.RestResource.ListRestMethod
The list of registered IRestMethod's
Top

GetClassNames (Class)
Purpose: Populates the ttClassNames temp-table
Notes:

Parameters:
poType Progress.Lang.Class
The classes to look for (ISupportsRestAddress or ISupportsRestMethods)
Top

Consultingwerk.OERA.RestResource.ListRestAddress GetRestAddresses ()
Purpose: Returns the list of registered REST Addresses
Notes:

Returns Consultingwerk.OERA.RestResource.ListRestAddress
The list of registered IRestAddress'es
Top

Consultingwerk.OERA.RestResource.ListRestMethod GetRestMethods ()
Purpose: Returns the list of registered REST Invokable Methods
Notes:

Returns Consultingwerk.OERA.RestResource.ListRestMethod
The list of registered IRestMethod's
Top

initialize ()
Purpose: Initializer/Startup
Notes: Locates a list of classes that implement the ISupportsRestAddress
and registers their REST Addresses

Top

CHARACTER MatchingContentType (character, character, logical)
Purpose: Returns the first media type from a comma-delimited list of media
types that is accepted by the given Accept header value
Notes: SCL-2349: Used to negotiate the media type between the request's
Accept header and the media types of a REST endpoint. The quality
value (;q=0.8) and the subsequent accept extension parameters of
an Accept header entry are ignored for the comparison, while
media type parameters (e.g. ;version=1.0) are compared against
the parameters of the endpoint's media types. When plExactOnly is
TRUE, only exact media type matches are considered - every
parameter of the endpoint's media type must be present in the
Accept header entry with the same value. When FALSE, wildcard
Accept header entries retain their meaning, parameters may be
missing from the Accept header entry (but must not contradict)
and an empty Accept header accepts any media type (per RFC 7231 a
missing Accept header implies any media type), so the first media
type of the list is returned. Callers perform an exact pass over
all endpoints before falling back to wildcard matches, so that an
explicitly requested media type wins over a wildcard match (e.g.
the trailing * / * sent by web browsers)

Parameters:
pcAcceptHeader CHARACTER
The comma-delimited list of media types accepted by the request
pcContentTypes CHARACTER
The comma-delimited list of media types served by the endpoint
plExactOnly LOGICAL
TRUE when only exact media type matches are considered
Returns CHARACTER
The first media type of pcContentTypes accepted by the Accept header, empty when none matches
Top

LOGICAL MediaTypeParametersMatch (character, character, logical)
Purpose: Compares the media type parameters of an Accept header entry
against the parameters of a media type served by an endpoint
Notes: SCL-2349: Supports versioning by media type parameter (e.g.
application/vnd.sports2000+json;version=1.0). When plExactOnly is
TRUE, every parameter of the endpoint's media type must be present
in the Accept header entry with the same value. When FALSE,
parameters may be missing from the Accept header entry, but
parameters present in both must have the same value. Parameters
of the Accept header entry that the endpoint's media type does not
declare are ignored

Parameters:
pcAcceptedType CHARACTER
The media type of the Accept header entry (without quality value)
pcContentType CHARACTER
The media type served by the endpoint
plExactOnly LOGICAL
TRUE when every endpoint parameter must be present in the Accept header entry
Returns LOGICAL
TRUE when the media type parameters match
Top

CHARACTER MediaTypeParameterValue (character, character)
Purpose: Returns the value of a named media type parameter
Notes: SCL-2349: Returns the unknown value when the parameter is not
present in the media type

Parameters:
pcMediaType CHARACTER
The media type (e.g. application/vnd.sports2000+json;version=1.0)
pcParameterName CHARACTER
The name of the parameter (e.g. version)
Returns CHARACTER
The value of the parameter, or the unknown value when not present
Top

RegisterBusinessTaskMethods ()
Purpose: Registers Business Task methods as REST resources
Notes:

Top

RegisterBusinessTaskRestMethod (IRestMethod)
Purpose: Registers a REST Method
Notes:

Parameters:
poRestMethod Consultingwerk.OERA.RestResource.IRestMethod
The RestMethod structure to register
Top

RegisterBusinessTaskRestMethods (ListRestMethod)
Purpose: Registers a list of REST Addresses
Notes:

Parameters:
poRestMethods Consultingwerk.OERA.RestResource.ListRestMethod
The ListRestMethod with the rest methods to register
Top

RegisterEntities ()
Purpose: Registers Business Entities as REST resources
Notes:

Top

RegisterMethods ()
Purpose: Registers Business Entities methods and Business Tasks
as REST resources
Notes:

Top

RegisterRestAddress (IRestAddress)
Purpose: Registers a REST Address
Notes:

Parameters:
poRestAddress Consultingwerk.OERA.RestResource.IRestAddress
The RestAddress structure to register
Top

RegisterRestAddresses (ListRestAddress)
Purpose: Registers a list of REST Addresses
Notes:

Parameters:
poRestAddresses Consultingwerk.OERA.RestResource.ListRestAddress
The ListRestAddress with the rest addresses to register
Top

RegisterRestMethod (IRestMethod)
Purpose: Registers a REST Method
Notes:

Parameters:
poRestMethod Consultingwerk.OERA.RestResource.IRestMethod
The RestMethod structure to register
Top

RegisterRestMethods (ListRestMethod)
Purpose: Registers a list of REST Addresses
Notes:

Parameters:
poRestMethods Consultingwerk.OERA.RestResource.ListRestMethod
The ListRestMethod with the rest methods to register
Top

CHARACTER RemoveAcceptExtensions (character)
Purpose: Removes the quality value (;q=...) and the subsequent accept
extension parameters from an Accept header entry
Notes: SCL-2349: Per RFC 7231 the quality value separates the media type
parameters (e.g. ;version=1.0) from the accept extension
parameters. Media type parameters are retained

Parameters:
pcAcceptedType CHARACTER
The Accept header entry
Returns CHARACTER
The Accept header entry without the quality value and accept extension parameters
Top

Consultingwerk.OERA.RestResource.IRestRequest ResolveAddressForRequest (character, character)
Purpose: Resolves the current REST request to an IRestAddress and Values
Notes: Defaults to application/json as the content-types

Parameters:
pcUri CHARACTER
The request URI
pcRequestMethod CHARACTER
The request method
Returns Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest structure with the resolved request address and values
Top

Consultingwerk.OERA.RestResource.IRestRequest ResolveAddressForRequest (character, character, character)
Purpose: Resolves the current REST request to an IRestAddress and Values
Notes:

Parameters:
pcUri CHARACTER
The request URI
pcRequestMethod CHARACTER
The request method
pcContentTypes CHARACTER
The comma-delimited list of accepted content types
Returns Consultingwerk.OERA.RestResource.IRestRequest
The IRestRequest structure with the resolved request address and values


Constructor Detail
Top

RestResourceService ()
Purpose: Constructor for the RestResourceService class
Notes:



©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       20.07.2026 16:03:49