Difference between revisions of "Interaction with SDI-Service"
(→Interaction) |
(→Interaction) |
||
| Line 5: | Line 5: | ||
=Interaction= | =Interaction= | ||
Thanks to the [[SDI-Service]] application can gather details on SDI facilities offered by the infrastructure. Every response returned by the service is contextualized by the request's '''gcube-token''' meaning : | Thanks to the [[SDI-Service]] application can gather details on SDI facilities offered by the infrastructure. Every response returned by the service is contextualized by the request's '''gcube-token''' meaning : | ||
| − | + | *Configuration is related to the '''context''' (INFRASTRUCTURE, VO or VRE) of the request | |
| − | + | *Credentials and accessible data spaces are related to the current '''ROLES''' associated with the authenticated calling user | |
Invocations to [[SDI-Service]] may trigger on-the-fly initialization of SDI resources, where needed. | Invocations to [[SDI-Service]] may trigger on-the-fly initialization of SDI resources, where needed. | ||
Revision as of 11:30, 4 July 2017
SDI-Service is a REST service aimed to offer a simplified interface to SDI administration over the infrastructure and to most common use cases in dealing with geospatial data. This page illustrates the interface exposed by the service and how to interact with it.
Contents
Interaction
Thanks to the SDI-Service application can gather details on SDI facilities offered by the infrastructure. Every response returned by the service is contextualized by the request's gcube-token meaning :
- Configuration is related to the context (INFRASTRUCTURE, VO or VRE) of the request
- Credentials and accessible data spaces are related to the current ROLES associated with the authenticated calling user
Invocations to SDI-Service may trigger on-the-fly initialization of SDI resources, where needed.
REST Invocation
SDI-Service is a SmartGears web application offering a REST interface, thus it can be invoked with simple HTTP requests. Every HTTP request to the service must contain a proper gcube-token property (as HTTP header or as query string parameter) in order to be authenticated and authorized. See #REST Interface for interface description.
JAVA Clients
For Java applications, a client library is distributed along with the service. The library facilitates the interaction with the service, automatically dealing with token and providing both an object model and a better fault management (see #Client library for more details). Such library is distributed as a maven artifact with the following coordinates
<groupId>org.gcube.spatial.data</groupId> <artifactId>sdi-library</artifactId>
REST Interface
This section describes the interfaces exposed by SDI-Service and how to interact with it with HTTP requests. It is required that every request is authorized, meaning that it must contain a proper gcube token (see details here).
Exposed Interfaces
The base path for every request is : https://<HOSTNAME>/sdi-service/gcube/service/
