| Version 6 (modified by , 14 years ago) (diff) |
|---|
Semantic Query Resolver
The Semantic Query Resolver (SQR) acts as a single entry point for Resource Users into the SENSEI system. The SQR provides the Semantic Query Interface (SQI) to Resource Users which offers convenience methods for Resource lookups as well as information and actuation requests. The implementation features a Web GUI that allows users to access the SQI interface. For developpers, the latter is also directly accessible through REST calls. In what follows, we describe these features and specify the installation procedure of the corresponding software.
Implementation
The SQR has been implemented within a REST container RESTlet to offer RESTful APIs. As a result, the buisness logic of the component has been embedded within so-called RESTlet Resources that provide the API to manage the access to the SQR operations in a RESTful fashion. One of the key features of the RESTlet framework is also the integration within its API of a template engine, Freemarker that allows to build Web pages on top of the framework RESTful API. This makes the SQR accesible through both standard RESTful calls but also through a simple Web site.
Given the complexity of the SQI we decided to bind each operation to a particular Resource so that maintenance is made easier. The implementation features the following path structure:
- http://hostname:port/sqr/ : SQR index page
- http://hostname:port/sqr/requestBinding : Browse bindings on the ED, simple queries
- http://hostname:port/sqr/requestBindingIOPP : Browse bindings on the ED, template queries
- http://hostname:port/sqr/requestResDesc : Browse resource descriptions on the RD, simple and selector queries
- http://hostname:port/sqr/requestInformation : Request information
Using the REST API
The implementation contains a client API for developpers to access the standard REST API of the SQR. The API is available in the package com.sap.research.sensei.sqr.api of the software. We refer the reader to the code JavaDoc? for a description of the methods part of the client implementation.
The com.sap.research.sensei.sqr.test package features test cases for each usage scenario. Please refer to the JavaDoc? of each test for details.
