Spring Boot example (work in progress)

Author: Oracle Public Cloud User

MongoExamples/SpringBoot/.gitignore

@@ -0,0 +1 @@
+/target/

MongoExamples/SpringBoot/README.md

@@ -0,0 +1,83 @@
+# Microservice Example using Spring Boot and the Autonomous JSON Database
+
+This directory contains an example of how to create a SpringBoot microservice using the Autonomous Database. Spring Boot is a popular Java framework that can be used to create REST services with minimal coding. See [Spring Boot](https://spring.io/projects/spring-boot).  
+
+# Prerequisites
+
+This example works best if you run it from an OCI compute node what is in the same data center as the Autonomous Database it is connecting to.  Instructions on how to create an Autonomous Database and a compute node can be found here: [Using Oracle Database API for MongoDB](https://oracle.github.io/learning-library/data-management-library/database/json/mongodb-api/workshops/freetier/index.html). 
+* Lab 1 - shows how to create a compute node.  The compute node used in this lab can also be used to run this SpringBoot example.  
+* Lab 2 - shows how to provision an Autonomous JSON Database.  
+* Lab 3 - shows how to connect to your database from the compute node using `mongosh`
+
+Note an *always-free* database and compute node are sufficient to run this example.
+
+# Loading Data
+
+This example service accesses real data from a bike sharing company. Oracle is not affiliated with this company.  We use their data in this example because they have cleanly exposed JSON data about their bike sharing stations (see [https://github.com/NABSA/gbfs/blob/master/gbfs.md](https://github.com/NABSA/gbfs/blob/master/gbfs.md))
+
+Specifically, this example uses two of their data sets:
+
+* *stations* - JSON data about each bike sharing station including things like its name, location, maximum capacity, etc.
+* *status* - JSON data about the current state of a bike sharing station and includes data like the current number of bikes available.
+
+To initially load these data sets, we will use `mongoimport`. You can obtain mongoimport as follows:
+
+```
+wget https://fastdl.mongodb.org/tools/db/mongodb-database-tools-rhel70-x86_64-100.5.2.tgz
+tar -xvf mongodb-database-tools-rhel70-x86_64-100.5.2.tgz
+export PATH="`pwd`/mongodb-database-tools-rhel70-x86_64-100.5.2/bin/:$PATH"
+```
+
+Run the following commands on your compute node:
+
+```
+# substitute the actual URI of your database
+export URI=mongodb://XXXYYYZZZ-DEMODB.adb.us-ashburn-1.oraclecloudapps.com:27017/admin?authMechanism=PLAIN&authSource=$external&ssl=true&retryWrites=false&loadBalanced=true
+
+# use jq (https://stedolan.github.io/jq/) to unwrap the nested documents and change
+# the station_id field to _id
+curl https://gbfs.citibikenyc.com/gbfs/en/station_information.json | \
+jq -c '.data.stations[] | .["_id"] = .["station_id"] | del(.station_id)' | \
+mongoimport -u ADMIN -p <password> --collection station --uri $URI
+
+curl https://gbfs.citibikenyc.com/gbfs/en/station_status.json | \
+jq -c '.data.stations[]' | \
+mongoimport -u ADMIN -p <password> --collection status --uri $URI
+
+```
+
+If successful, you should have two collections in your database: station and status.  Note, you may want to run the status command a few times over time to get more interesting (varying) data to work with.  The data loaded is the state of the stations at the time the command is run.
+
+# Viewing the data
+
+You can view the data you just loaded in a web browser using Database Actions ([Lab 4](https://oracle.github.io/learning-library/data-management-library/database/json/mongodb-api/workshops/freetier/index.html?lab=dbactions))  or from the command line using `mongosh` ([Lab 3](https://oracle.github.io/learning-library/data-management-library/database/json/mongodb-api/workshops/freetier/index.html?lab=mongoshell)).  For example:
+
+```
+mongosh -u ADMIN -p <password> $URI
+admin> show collections
+station
+status
+
+admin> db.station.find({_id:120})
+[
+  {
+    _id: '120',
+    region_id: '71',
+    lon: -73.95928168,
+  ...
+  
+admin> db.station.updateOne({_id:120}, {$set:{capacity:24}});
+...
+admin> db.station.find({_id:120});
+```
+
+# Building the service
+
+[todo]
+
+# Running the service
+
+[todo]
+
+
+

MongoExamples/SpringBoot/pom.xml

@@ -0,0 +1,37 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>org.springframework.boot</groupId>
+    <artifactId>spring-boot-starter-parent</artifactId>
+    <version>2.6.5</version>
+    <relativePath />
+  </parent>
+  <groupId>com.oracle.database.mongo.example</groupId>
+  <artifactId>SpringBoot</artifactId>
+  <version>0.0.1</version>
+  <properties>
+    <java.version>16</java.version>
+  </properties>
+  <dependencies>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-data-mongodb</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-web</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-data-rest</artifactId>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-maven-plugin</artifactId>
+      </plugin>
+    </plugins>
+  </build>
+</project>

MongoExamples/SpringBoot/src/main/java/example/App.java

@@ -0,0 +1,15 @@
+package example;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.data.mongodb.repository.config.EnableMongoRepositories;
+
+@SpringBootApplication
+@EnableMongoRepositories
+public class App {
+
+    public static void main(String[] args) {
+        SpringApplication.run(App.class, args);
+    }
+
+}

MongoExamples/SpringBoot/src/main/java/example/AppConfig.java

@@ -0,0 +1,26 @@
+package example;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.mongodb.MongoDatabaseFactory;
+import org.springframework.data.mongodb.MongoTransactionManager;
+import org.springframework.data.mongodb.core.SimpleMongoClientDatabaseFactory;
+
+import com.mongodb.client.MongoClient;
+import com.mongodb.client.MongoClients;
+
+@Configuration
+public class AppConfig {
+    
+  public @Bean MongoDatabaseFactory mongoClient() {
+      String uri = "<connection string>";
+      MongoClient client = MongoClients.create(uri);
+      return new SimpleMongoClientDatabaseFactory(client, "admin");
+  }
+  
+  @Bean
+  MongoTransactionManager transactionManager(MongoDatabaseFactory dbFactory) {
+      return new MongoTransactionManager(dbFactory);
+  }
+  
+}

MongoExamples/SpringBoot/src/main/java/example/control/StationController.java

@@ -0,0 +1,43 @@
+package example.control;
+
+import static org.springframework.web.bind.annotation.RequestMethod.DELETE;
+
+import org.springframework.data.rest.webmvc.RepositoryRestController;
+import org.springframework.transaction.TransactionStatus;
+import org.springframework.transaction.support.TransactionCallbackWithoutResult;
+import org.springframework.transaction.support.TransactionTemplate;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+import example.repository.StationRepository;
+import example.repository.StatusRepository;
+
+@RepositoryRestController
+public class StationController {
+
+    private final StationRepository stationRepo;
+
+    private final StatusRepository statusRepo;
+
+    private final TransactionTemplate transaction;
+
+    public StationController(StationRepository stationRepo, StatusRepository statusRepo,
+            TransactionTemplate transaction) {
+        this.stationRepo = stationRepo;
+        this.statusRepo = statusRepo;
+        this.transaction = transaction;
+    }
+
+    @RequestMapping(method = DELETE, value = "/station/{id}")
+    public @ResponseBody void getRentalUrls(@PathVariable String id) {
+        transaction.execute(new TransactionCallbackWithoutResult() {
+            @Override
+            protected void doInTransactionWithoutResult(TransactionStatus status) {
+                stationRepo.deleteById(id);
+                statusRepo.deleteAllByStationId(id);
+            }
+        });
+    }
+
+}

MongoExamples/SpringBoot/src/main/java/example/model/Station.java

@@ -0,0 +1,116 @@
+package example.model;
+
+import java.util.List;
+import java.util.Map;
+
+import org.springframework.data.annotation.Id;
+import org.springframework.data.mongodb.core.mapping.Document;
+
+/**
+ * Bike station
+ * 
+ * @see https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_information
+ */
+@Document("station")
+public class Station {
+    
+    @Id
+    String id;
+    
+    String name;
+    
+    String region_id;
+    
+    double lon,lat;
+    
+    boolean eightd_has_key_dispenser;
+    
+    String legacy_id;
+    
+    List<String> rental_methods;
+    
+    String external_id;
+    
+    int capacity;
+    
+    String short_name;
+    
+    boolean electric_bike_surcharge_waiver;
+    
+    String station_type;
+    
+    List<String> eightd_station_services;
+
+    boolean has_kiosk;
+    
+    Map<String, String> rental_uris;
+    
+    public Station() {
+        
+    }
+
+	public String getId() {
+		return id;
+	}
+
+	public String getName() {
+		return name;
+	}
+
+	public String getRegion_id() {
+		return region_id;
+	}
+
+	public double getLon() {
+		return lon;
+	}
+
+	public double getLat() {
+		return lat;
+	}
+
+	public boolean isEightd_has_key_dispenser() {
+		return eightd_has_key_dispenser;
+	}
+
+	public String getLegacy_id() {
+		return legacy_id;
+	}
+
+	public List<String> getRental_methods() {
+		return rental_methods;
+	}
+
+	public String getExternal_id() {
+		return external_id;
+	}
+
+	public int getCapacity() {
+		return capacity;
+	}
+
+	public String getShort_name() {
+		return short_name;
+	}
+
+	public boolean isElectric_bike_surcharge_waiver() {
+		return electric_bike_surcharge_waiver;
+	}
+
+	public String getStation_type() {
+		return station_type;
+	}
+
+	public List<String> getEightd_station_services() {
+		return eightd_station_services;
+	}
+
+	public boolean isHas_kiosk() {
+		return has_kiosk;
+	}
+
+	public Map<String, String> getRental_uris() {
+		return rental_uris;
+	}
+
+}