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

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

File:RestResourcesJsonReader
Purpose:Reads Rest resources (rest addresses, rest methods, business task methods) from a JSON file
Author(s):Peter Judge / Consultingwerk Ltd.
Created:Tue Jul 26 17:44:37 CEST 2022
Notes:- The file name defaults to the value of the restResourcesCacheFile property, but can also be
be passed by constructor.
- The expected format of the JSON file is described in Consultingwerk.OERA.RestResource.RestResources
Purpose: Specifies the file containing the JSON resources
Notes: By default this value is taken from the configuration

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



Top Method Summary
Options Name Purpose
+ Consultingwerk.OERA.RestResource.RestResources GetResources () Populates a Rest Resource Service's RestAddress, RestMethod and BusinessTaskMethods from a JSON file

Top Constructor Summary
Options Name Purpose
+ RestResourcesJsonReader () Default constructor
+ RestResourcesJsonReader (character) Alternative Constructor

Top Property Summary
Options Name Purpose
+ CHARACTER FileName


Method Detail
Top

PUBLIC Consultingwerk.OERA.RestResource.RestResources GetResources ()
Purpose: Populates a Rest Resource Service's RestAddress, RestMethod and BusinessTaskMethods from a JSON file
Notes: The general assumption is that if the file is not found, or cannot be loaded for any reasons, that
no errors are raised, and that the caller of this method needs to populate the various lists themselves.
- If a file name is not specified, return an unknown parameter object
- If the file does not exist on disk, return an unknown parameter object
- If the file is not JSON, return without an unknown parameter object
- If there are any errors in loading items, return an unknown parameter object
any errors were encountered while loading.

Returns Consultingwerk.OERA.RestResource.RestResources
RestResources An object containing loaded resources; this may be an unknown value if


Constructor Detail
Top

PUBLIC RestResourcesJsonReader ()
Purpose: Default constructor
Notes:

Top

PUBLIC RestResourcesJsonReader (character)
Purpose: Alternative Constructor
Notes:

Parameters:
pcCacheFile CHARACTER
The file name that contains the REST resources


Property Detail
Top

PUBLIC CHARACTER FileName

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:53:03