renamed vipra-rest to vipra-backend

renamed vipra-rest to vipra-backend
moved endpoint from /vipra-rest to /vipra
set rest endpoint to /rest
merged vipra-backend and vipra-ws
updated build.sh
deleted tasks file, useless
added project readmes

build.sh

@@ -52,9 +52,9 @@ fi
 
 echo "" >> $LOG
 echo "-------------------------------" >> $LOG
-echo "compiling vipra-rest" | tee -a $LOG
+echo "compiling vipra-backend" | tee -a $LOG
 echo "-------------------------------" >> $LOG
-$MVN -f ./vipra-rest/pom.xml package >> $LOG 2>&1
+$MVN -f ./vipra-backend/pom.xml package >> $LOG 2>&1
 if [ $? -ne 0 ]; then
         echo "error"
         exit 1

tasks.todo

- ☐ topic/word network
- ☐ enable topic editing/labeling
\ No newline at end of file

vipra-rest/.project → vipra-backend/.project

 <?xml version="1.0" encoding="UTF-8"?>
 <projectDescription>
-	<name>vipra-rest</name>
+	<name>vipra-backend</name>
 	<comment></comment>
 	<projects>
 		<project>vipra-cmd</project>

vipra-rest/.settings/org.eclipse.wst.common.component → vipra-backend/.settings/org.eclipse.wst.common.component

 <?xml version="1.0" encoding="UTF-8"?><project-modules id="moduleCoreId" project-version="1.5.0">
-    <wb-module deploy-name="vipra-rest">
+    <wb-module deploy-name="vipra-backend">
         <wb-resource deploy-path="/" source-path="/target/m2e-wtp/web-resources"/>
         <wb-resource deploy-path="/" source-path="/src/main/webapp" tag="defaultRootSource"/>
         <wb-resource deploy-path="/WEB-INF/classes" source-path="/src/main/java"/>
@@ -7,7 +7,7 @@
         <dependent-module archiveName="util-0.0.1-SNAPSHOT.jar" deploy-path="/WEB-INF/lib" handle="module:/resource/vipra-util/vipra-util">
             <dependency-type>uses</dependency-type>
         </dependent-module>
-        <property name="java-output-path" value="/vipra-rest/target/classes"/>
-        <property name="context-root" value="vipra-rest"/>
+        <property name="java-output-path" value="/vipra-backend/target/classes"/>
+        <property name="context-root" value="vipra"/>
     </wb-module>
 </project-modules>

vipra-backend/README.md

+# Backend Service
+
+This project contains the Vipra backend services. These services include:
+
+* REST service (`de.vipra.rest` packages)
+* WebSocket (`de.vipra.ws` packages)
+
+## REST Service
+
+The REST service is used by the frontend UI project to query and modify data in the database and search index. It offers multiple REST conform resources for CRUD operations. A full specification in the form of a WADL file can be found under: [application.wadl](http://localhost:8080/vipra/rest/application.wadl)
+
+## WebSocket
+
+The WebSocket is used by the frontend UI project to obtain instant updates on changed data.
\ No newline at end of file

vipra-rest/pom.xml → vipra-backend/pom.xml

@@ -3,11 +3,11 @@
 	<modelVersion>4.0.0</modelVersion>
 
 	<groupId>de.vipra</groupId>
-	<artifactId>rest</artifactId>
+	<artifactId>backend</artifactId>
 	<version>0.0.1-SNAPSHOT</version>
 	<packaging>war</packaging>
 
-	<name>Vipra REST Backend</name>
+	<name>Vipra Backend</name>
 	<url>http://maven.apache.org</url>
 
 	<properties>
@@ -52,6 +52,11 @@
 			<artifactId>javax.servlet-api</artifactId>
 			<version>${servletVersion}</version>
 		</dependency>
+		<dependency>
+			<groupId>javax.websocket</groupId>
+			<artifactId>javax.websocket-api</artifactId>
+			<version>1.1</version>
+		</dependency>
 
 		<!-- Logging -->
 		<dependency>
@@ -99,7 +104,7 @@
 	</dependencies>
 
 	<build>
-		<finalName>vipra-rest</finalName>
+		<finalName>vipra</finalName>
 		<plugins>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>