Support for RESTful invocation of Business Task and Business Entity Methods
- Mike Fechner
- Peter Judge
- Martyn Kemp
Introduction
The support for invoking Business Tasks and Business Entity Methods through the RESTful interface is based on the requirements described in this article: RESTful services. Particularly the RestEntitiesWebHandler and the RestResourceService (as a Service Instance of the IRestResourceService).
Business Task methods and Business Entity methods are exposed as RESTful resources using the same set of annotations - and actually share a lot of similarities. Business Entity invokable methods are typically PUBLIC VOID methods with a ProDataset INPUT-OUTPUT parameter and a (JSON serializable) parameter object. Business Task methods are typically PUBLIC VOID methods with zero to five ProDataset INPUT-OUTPUT parameters and a (JSON serializable) parameter object.
Support for return value of Business Task and Business Entity Methods
Also to facilitate the support for RESTful invocation of Business Task and Business Entity methods the Consultingwerk.OERA.ServiceInterface:InvokeTask API has been enhanced with support for returning the return value of a method to the caller. This finally allows developers to separate the request message from the response message.
The InvokeTask API is fully capable of invoking Business Entity methods as well.
Known limitations
Due to limitations of the ABL reflection API, we currently do not support ProDatasets passed as the input to Business Task and Business Entity methods. This limitation has been accepted in our design process as we expect a majority of use-cases for RESTful invocation of Business Task and Business Entity methods just requires to return data in ProDatasets, not to receive data. So, the only input message to the invokable messages supported through the RESTful interface is the parameter object instance.
As ABL reflection is not capable of providing the schema of the ProDataset parameters we've had to balance the requirement to provide the schema of the ProDataset parameters manually (through code in the Business Tasks) with ease of use. The schema of ProDataset parameters is required as the loosely typed JSON messages do not allow the AVM to securely create an input ProDataset "on the fly" without losing schema compatibility with the strongly typed Dataset's used within Business Tasks and Business Entities.
Preparing Business Tasks and Entities for RESTful invocation of methods
Business Tasks
A Business Task needs to implement the ISupportsRestMethods interface in order to support RESTful invocation. This Interface is expected by the IRestResourceService.
CLASS Consultingwerk.SmartComponentsDemo.OERA.SampleBusinessTask
IMPLEMENTS IBusinessService, ISupportsRestMethods:A typical implementation of the required GetRestMethods method looks like this:
/**
* Purpose: Returns the list of supported rest adresses for methods
* to the caller
* Notes:
* @return The list of supported rest methods to the caller
*/
METHOD PUBLIC ListRestMethod GetRestMethods ():
RETURN (NEW RestMethodProvider():GetRestMethods (THIS-OBJECT:GetClass())) .
END METHOD .Business Entities
Business Entities implement the GetRestMethods method by inheriting from the Consultingwerk.OERA.BusinessEntity class. It is however still required to declare the Interface in the Business Entity class header:
CLASS Consultingwerk.SmartComponentsDemo.OERA.Sports2000.CustomerBusinessEntity
INHERITS SmartBusinessEntity IMPLEMENTS IFetchDataByReference, ISupportsRestAddress, ISupportsRestMethods:Invokable methods
Valid signatures for methods that can be invoked using the RESTful interface must have the following characteristics:
Zero to five INPUT-OUTPUT datasets or dataset handles.
Zero or one INPUT parameter object. If used, the parameter object must be the last parameter defined.
A void return value, or an OOABL type that is serializable to JSON (typically using the Consultingwerk.IJsonSerializable interface).
This includes methods that take no inputs and return no values, as well as methods that have only a single dataset INPUT-OUTPUT parameter.
Defining RESTful interfaces for invokable methods
RESTful interfaces for Business Entity methods are defined by a @RestMethod annotations attached to the method (just before the METHOD block).
@RestMethod (address="/Customers/~{CustNum}/PutCustomerOnHold", requestMethod="get", parameterClassName="Consultingwerk.SmartComponentsDemo.OERA.Sports2000.PutOnHoldParameter", response="dsCustomer").
/*------------------------------------------------------------------------------
Purpose: Puts the Customer on hold
Notes: Client callable method
@param dsCustomer INPUT-OUTPUT DATASET
@param poParameter The Parameter Object for this method
------------------------------------------------------------------------------*/
METHOD PUBLIC VOID PutCustomerOnHold (INPUT-OUTPUT DATASET dsCustomer,
poParameter AS PutOnHoldParameter):Arguments of the @RestMethod annotation
The annotation provides the following arguments:
Argument/Attribute | Mandatory | Description |
|---|---|---|
address | no | The URI pattern to invoke the method. When not specified the pattern /{methodName} is used by default |
ParameterClassName | no | The name of the parameter class to instantiate for calling into the method. When not specified, the OOABL type name of the parameter is used. In either case, if the type name is not instantiable - if it's an interface, enum or abstract class - then a Consultingwerk.Exceptions.InvalidValueException will be raised. |
RequestMethod | no | The http method for the call described by this annotation. When not specified, get will be assumed as the default. |
Request | no | Comma delimited list of the components from the JSON request body of the REST request. Components are "parameter" and the names of the ProDataset parameters. |
Response | yes | Comma delimited list of the components for the JSON response of the REST request. Components are "return", the names of the ProDataset parameters and the name of the parameter. If only a single ProDataset is provided, it may have additional modifiers.
|
mapHeaders | no | Comma-delimited list of HTTP header names that are set as values on the method parameter object.. The header names may have an optional mapped property name, delimited by =. For example, a value of Accept-Language=Language,Content-Disposition sets the values of the Accept-Language and Content-Disposition headers from the web request to properties named Language and Content-Disposition. |
mapCookies | no | Comma-delimited list of HTTP cookie names to be set as values on the method parameter object. The cookie names may have an optional mapped property name, similar to the mapHeaders value. For example, a value of JSESSIONID=SessionId will set the value of the JSESSIONID cookie to a property named SessionId on the parameter object. |
tags | no | Comma-separated list of tags used for grouping endpoints in Swagger documentation. |
requestParameterSchemaType | no | An alternate name to use for the (input) parameter class in the Swagger documentation. This allows details of the implementation to be hidden. If not provided, the parameter's OOABL class name is used. |
responseSchemaType | no | An alternate name to use for the return value class in the Swagger documentation. This allows details of the implementation to be hidden. If not provided, the OOABL type name of the return value is used. |
propertyFrom | no | Comma-delimited list of values indicating how property values for a parameter class should be provided. Each entry has the format <property-name>:[query|hidden] . A value of query indicates that a query string is used. A value of hidden indicates that a value for that property is not expected to be sent by a client. |
description | no | A description for the operation used in the Swagger documentation |
Every invokable method may be annotated with more than a single @RestMethod annotation to provide alternative URI's for the same method.
Arguments of the @ParameterSchema annotation
When Business Task methods are configured to return a Dataset as the method response, it's required to provide an XSD file with the ProDataset schema to be included in the method documentation, e.g.:
Argument/Attribute | Mandatory | Description |
|---|---|---|
datasetname | yes | The name of the dataset |
schemafile | yes | The path reference to the dataset schema. This schema file is an XSD containing the schema of the dataset. Note that if there are fields in the dataset’s temp-table that have been define with a SERIALIZE-HIDDEN or XML-NODE-HIDDEN clause, that the fields are not written to the XSD file. This may result in schema mismatches and errors when calling the method. |
datasetSchemaType | no | An alternative name used to provide the name of the ProDataSet schema generated as properties of the components.schemas object in the generated Swagger document. If not provided, a combination of the Business Entity or Business Task class name and the dataset name is used, in the format <entityname>-<datasetname> . |
The @ParameterSchema annotation is optional.
Arguments of the @RestMethodParameter annotation
Parameters passed into the method may receive a meaningful description for Swagger documentation provided by a RestMethodParameter annotation. Each parameter should have its own annotation.
Argument/Attribute | Mandatory | Description |
|---|---|---|
name | yes | The name of the parameter. May also be parameter if the method’s parameter is a JsonObject. |
description | yes | A description for the parameter |
The @RestMethodParameter annotation is optional.
Arguments of the @ApiDoc annotation
A Business Entity or Business Task may use an ApiDoc annotation to provide additional information for the generated Swagger documentation, for the whole class.
Argument/Attribute | Mandatory | Description |
|---|---|---|
tags | no | Comma-separated list of tags used for grouping endpoints in Swagger documentation. |
entitySchemaType | no | An alternate name to use for the Business Entity or Business Task class name in the Swagger documentation. This allows details of the implementation to be hidden. If not provided, the Business Entity or Business Task class name is used. This value is used to generate schemas that will be re-used: these appear as properties of the components.schemas object in the generated document. |
The @ApiDoc annotation is optional.
Population of the Parameter object
The REST request to the annotated method will be used to populate the properties of the method's parameter object using the following sources:
For GET requests, the query string is first parsed and query string values will be used to populate the same named properties of the parameter object
For all other request methods, e.g. POST, the request entity (request payload) - when the request entity represents a JSON object - is used to deserialize a JSON serializable parameter object.
For all request methods (GET, POST, ...), the path parameter arguments are also assigned to properties of the parameter object. This is performed at the end, so that path parameters, as the strongest component of the request URI, overwrite properties assigned by query string components or deserialized form the request entity (request payload).
Population of the JSON response of the request
The JSON response object can either be populated by the return value of the method alone or a combination of the return value, the parameter object and the ProDataset parameter(s). For the return value we support both Consultingwerk.JsonSerializable derived types and JsonObjects/JsonArrays. For the parameter object we only support JsonSerializable instances.
Examples
Classic invokable method of a Business Entity
@RestMethod (address="/Customers/~{CustNum}/PutCustomerOnHold", requestMethod="get", parameterClassName="Consultingwerk.SmartComponentsDemo.OERA.Sports2000.PutOnHoldParameter", response="dsCustomer").
/*------------------------------------------------------------------------------
Purpose: Puts the Customer on hold
Notes: Client callable method
@param dsCustomer INPUT-OUTPUT DATASET
@param poParameter The Parameter Object for this method
------------------------------------------------------------------------------*/
METHOD PUBLIC VOID PutCustomerOnHold (INPUT-OUTPUT DATASET dsCustomer,
poParameter AS PutOnHoldParameter):This annotation defines a method which will be exposed using a GET request under an URI like this:
The method parameter object (PutOnHoldParameter) is populated with the Comments property as specified in the query string of the get request and the CustNum value of 42 from the path parameter. The request will return the ProDataset dsCustomer to the caller.
Business Task method returning a serializable object to the caller
@RestMethod (address="/CalculateSumTask", requestMethod="get",
parameterClassName="Consultingwerk.SmartComponentsDemo.OERA.CalculateSumParameter",
response="return").
METHOD PUBLIC DecimalHolder CalculateSum (poParameter AS CalculateSumParameter):This annotation defines an endpoint for a Business Task method that will be exposed using a GET request under an URI like this:
http://localhost:8820/web/Entities/CalculateSumTask?Value1=17&Value2=4
The method parameter object properties are populated from the two values in the query string. The request will return the serialized DecimalHolder instance:
{
"Value": 21.0
}The same method can also be exposed like this:
@RestMethod (address="/CalculateSumTask/~{value1}/~{value2}", requestMethod="get",
parameterClassName="Consultingwerk.SmartComponentsDemo.OERA.CalculateSumParameter",
response="return").
METHOD PUBLIC DecimalHolder CalculateSum (poParameter AS CalculateSumParameter):http://localhost:8820/web/Entities/CalculateSumTask2/47/11
Business Task method returning two ProDatasets and optionally the parameter object
@RestMethod (address="/GetCustomerAndInvoices", requestMethod="get",
parameterClassName="Consultingwerk.IntegerHolder",
response="poParameter,dsCustomer,dsInvoice").
@RestMethod (address="/GetCustomerAndInvoices/~{Value}", requestMethod="get",
parameterClassName="Consultingwerk.IntegerHolder",
response="dsCustomer,dsInvoice").
@RestMethod (address="/GetCustomerAndInvoices", requestMethod="post",
parameterClassName="Consultingwerk.IntegerHolder",
response="dsCustomer,dsInvoice").
@ParameterSchema (datasetname="dsCustomer", schemafile="Consultingwerk/SmartComponentsDemo/OERA/Sports2000/dsCustomer.xsd").
@ParameterSchema (datasetname="dsInvoice", schemafile="Consultingwerk/SmartComponentsDemo/OERA/Sports2000/dsInvoice.xsd").
METHOD PUBLIC VOID GetCustomerAndInvoices (INPUT-OUTPUT DATASET dsCustomer,
INPUT-OUTPUT DATASET dsInvoice,
poParameter AS IntegerHolder):This method allows clients to provide the Value property of the IntegerHolder parameter in one of three ways:
GET http://localhost:8820/web/Entities/GetCustomerAndInvoices?Value=1
GET http://localhost:8820/web/Entities/GetCustomerAndInvoices/1
POST http://localhost:8820/web/Entities/GetCustomerAndInvoices with a JSON payload like:
"poParameter": {
"Value": 1
},
"dsCustomer": {
"eCustomer": [
{
"CustNum": 1,
"Country": "USA",
"Name": "Lift Line Skiing",
"Address": "Unter Käster 1",
"Address2": null,
"City": "Chicago",
"State": "MA",
"PostalCode": "01730",
"Contact": "Gloria Shepley",
"Phone": "(617) 450-0086",
"SalesRep": "HXM",
"CreditLimit": 0,
"Balance": 50000,
"Terms": "PREPAID ONLY",
"Discount": 35,
"Comments": "Put on hold: 25.06.2019 07:46:59\ntest",
"Fax": "",
"EmailAddress": "info@lift-tours.com",
"Flags": "C",
"SmartRecordKey": "000000001",
"SmartAttachments": true,
"SmartComments": false,
"SmartCopiedFrom": ""
}
]
},
"dsInvoice": {
"eInvoice": [
{
"Invoicenum": 6,
"CustNum": 1,
"InvoiceDate": "2009-02-09",
"Amount": 1829.5,
"TotalPaid": 1829.5,
"Adjustment": 0,
"OrderNum": 6,
"ShipCharge": 0
},
{
"Invoicenum": 79,
"CustNum": 1,
"InvoiceDate": "2008-11-19",
"Amount": 34707.84,
"TotalPaid": 34707.84,
"Adjustment": 0,
"OrderNum": 79,
"ShipCharge": 0
},
{
"Invoicenum": 146,
"CustNum": 1,
"InvoiceDate": "2009-02-28",
"Amount": 4605.91,
"TotalPaid": 0,
"Adjustment": 0,
"OrderNum": 177,
"ShipCharge": 0
}
]
}