https://github.com/engineering-research-and-development/semantic-asset-registry
Semantic Asset Registry to manipulate RDF ontologies
https://github.com/engineering-research-and-development/semantic-asset-registry
Last synced: 2 months ago
JSON representation
Semantic Asset Registry to manipulate RDF ontologies
- Host: GitHub
- URL: https://github.com/engineering-research-and-development/semantic-asset-registry
- Owner: Engineering-Research-and-Development
- Created: 2018-03-05T10:08:27.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-06-07T18:04:20.000Z (almost 4 years ago)
- Last Synced: 2025-01-27T21:24:45.817Z (4 months ago)
- Language: Java
- Homepage:
- Size: 17.4 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/BEinCPPS/asset-registry-for-cpps)
# Semantic Asset Registry (SAR)
## Description of the component
The **Semantic Asset Registry (SAR)** is a web-based, integrated platform for the management of Virtualized Asset based on [asset-registry-for-cpps](https://github.com/BEinCPPS/asset-registry-for-cpps) project. This Specific Enabler is targeted to the business user, who is not required to have IT expertise, nor an in-depth knowledge of ontology-related concepts and technologies.
Semantic Asset Registry is based on several open source components, covering different functional areas; on top of these, it adds a rich layer of web-based, custom front-end functionalities which integrates low-level services into a unified, user-friendly experience.
Semantic Asset Registry is delivered as a module that allows the user to manipulate ontologies adding classes and templates and create, manipulate and delete Assets.
GI
This Semantic Asset Registry release contains two modules, **Semantic Asset Registry** and **Semantic Asset Registry API**.
### Semantic Asset Registry
Semantic Asset Registry is a web application that exploits cam-service APIs. SAR allows user to create, manipulate and delete Assets using a web interface.
### Semantic Asset Registry API
Semantic Asset Registry API component exposes its own public, proprietary REST-based web API. By means of API calls, the reference ontology, the asset repository and the service registry can be queried by external applications. The usual CRUD operations will be allowed on Class, Assets, Domains and Attributes.
## Developer environment
This procedure assumes that you have [Apache Tomcat](https://tomcat.apache.org/download-80.cgi) (version >= **7**)
and [RDF4J 2.0M2](http://rdf4j.org/download/) installed in your environment.
Before start using application you must have RDF4J up and running, we also need to create a new repository in it.
We will refer to this repository as ``````.
• Open a web browser and navigate to your rdf4j:
```
:/rdf4j-workbench/
```
• Click on new repository, on top left, and fill id and title.
• Click next, select persistence mode and finally click finish.
If creation is successful the user will be redirected to repository summary.
+ **A.** Your project structure is as follows:
```
|__ cam
|__ cam-service
```
+ **B.** Install Semantic Asset Registry:
1. Open a terminal window and go to the root folder of SAR project .
2. Type the command: mvn package.
3. Copy the war in ```target/``` to ```/webapps```.
4. Browse to ```:/SAR ``` to start using application.
+ **C.** Install Semantic Asset Registry API:
```bash
$ cd cam-service
$ mvn package -P prod
```
To skip Unit Tests use ``-DskipTests`` maven parameter.
+ **D.** Integration Test (This test uses **Sesame Repository in Memory** and **Apache Tomcat 7 Maven embedded**):
```bash
$ cd cam-service
$ mvn package
$ mvn verify
```
The default port in order to use Semantic Asset Registry API with Sesame repo is 8080, feel free to change this parameter inside the file pom.xml.
Change sesame repository properties with your sesame installation:
```bash
sesame.url
sesame.repository ()
sesame.namespace
```
Copy the SARAPI.war into a Tomcat installation.
```bash
$ cp ./cam-service/target/sarAPI.war ./apache-tomcat-8.0.33/webapps
```
## Authentication
In the latest version of the project, authentication is **mandatory** for every type of environment.
Semantic Asset Registry Project uses [OAuth2](https://oauth.net/2/) by means of the *Fiware enabler* **[Identity Management - KeyRock](https://catalogue.fiware.org/enablers/identity-management-keyrock)** for authentication and authorization.
**Identity Manager - KeyRock** could be installed with different possibilities as explained in the official [Github page](https://github.com/ging/fiware-idm).
### Basic configuration
The **fastest way** to have a working idM instance in your environment, is using the *Docker image*, following this [guide](https://github.com/ging/fiware-idm/blob/master/extras/docker/README.md).
>In particular way, follow the section '*Run the container from the last release in Docker Hub*'.
#### IdM OAuth2 configuration
**1**. Follow this [link](http://localhost:8000) to access to idM and authenticate with user and password of your installation (`idm/idm`in Docker image).
in **Home** page, in **Applications** section, **Register** a new application with these data (*):
| Data | Value |
| ------------- |:---------------------------------------------:|
| Name | Semantic Asset Registry (SAR) |
| URL | http://localhost:8080/CAM |
| Callback URL | http://localhost:8080/CAM/oauth_callback.html |
**2**. Click next to register data.
**3**. In **Applications** section open SAR Application and in **OAuth2 Credentials** copy your **Client ID**.
>(*) SAR local installation on Tomcat standard port.
#### SAR OAuth2 configuration
**1**. In **cam** folder edit the following properties in [pom.xml](https://github.com/is3labengrd/semantic-asset-registry/blob/master/cam/pom.xml):
```bash
oAuth
http://localhost:8000
your Client ID
```
**2**. From the same folder launch the command `mvn package`
**3**. In **cam-service** folder edit the following properties in [pom.xml](https://github.com/is3labengrd/semantic-asset-registry/blob/master/cam-service/pom.xml):
```bash
OAUTH2
http://localhost:8000
http://localhost:5000
IDM_USER
IDM_PWD
```
>You can edit only the properties in `prod` profile.
**4**. From the same folder launch the command `mvn package -P prod`
**5**. Copy the `SAR.war` and `SARAPI.war` in your Tomcat webapps installation
```bash
$ cp ./cam-service/target/SARAPI.war ./apache-tomcat-8.0.33/webapps && ./cam/target/sar.war ./apache-tomcat-8.0.33/webapps
```
**Note**: This project uses [Travis-Ci](https://travis-ci.org/) for continuous integration.