IBM Cloud Object Storage is a web-scale platform that stores unstructured data — from petabyte to exabyte — with reliability, security, availability and disaster recovery without replication.
This project demonstrates a simple Lagom service that includes a Read-Side processor that publishes Account Extracts into IBM Cloud Object Storage.
- User creates 5 transactions locally.
- The client interact with IBM Cloud Object Storage via S3 API.
This example is a simple banking application that allows you to simulate depositing and withdrawing money from one account. The example propagates account transactions from the write-side (AccountEntity) to the read-side (AccountExtractProcessor) as events stored in a Cassandra database. On every 5 transactions, the service generates an account extract and uploads it to a Cloud Object Storage bucket. Extracts can be downloaded for local visualization.
Note: theAccountExtractRepository, that holds extracts in-memory, is not thread-safe and therefore its code is only suitable for demonstrations.
- IBM Cloud Object Storage: Build and deliver cost effective apps and services with high reliability and fast speed to market in an unstructured cloud data store.
- Lagom: An open source framework built with the shifting from monoliths to microservices-driven application architecture in mind.
- Cloud: Accessing computer and information technology resources through the Internet.
- Java: A secure, object-oriented programming language for creating applications.
To build and run this example, you need:
- git
- Java SE 8 JDK
- Maven 3.2.1+ to build and run the Lagom project (3.5.0 recommended)
- A service instance of IBM Cloud Object Storage
- Download and set up the Lagom service
- Start the Lagom sample application
- Generate some traffic on the Lagom service
- Stop Lagom and clean IBM Cloud Object Storage
Follow these steps to get a local copy of this project and configure it with the Cloud Object Storage credentials and settings.
- Open a command line shell and clone the example repository:
git clone https://github.com/IBM/Lagom-object-storage - Change into the example's root directory:
cd Lagom-object-storage - Supply the configuration:
- Copy the
account-impl/src/main/resources/cloud-object-storage.conf.templatefile toaccount-impl/src/main/resources/cloud-object-storage.conf. - Open
account-impl/src/main/resources/cloud-object-storage.confin a text editor and fill in the necessary information. Details are provided in the file itself. The credentials to the object storage can be found on the IBM Cloud console. Check the video for more information.
- Copy the
In the command line where you downloaded the Lagom service, start the Lagom development environment from the root of the cloned directory, Lagom-object-storage:
mvn lagom:runAll
You should see some console output, including these lines:
...
[INFO] Service gateway is running at http://localhost:9000
...
[INFO] (Service started, press enter to stop and go back to the console...)
These messages indicate that the service has started correctly.
To keep things simple, the example does not have a GUI but exposes a REST API. You can use any REST client or http tool to interact with the application. The rest of this guide will use curl syntax to document the calls. You can adapt it to your REST client of choice.
The example account number is 123-456-890. The Lagom service provides APIs to check the balance and to deposit or withdraw money. Use the REST calls below to create transactions. Be sure not to withdraw more money than the account balance. Then, retrieve the extract from the Cloud Object Storage bucket.
To check the balance and generate transactions, use calls to the following endpoints:
- To check the account balance:
curl http://localhost:9000/api/account/123-4567-890/balance
- To deposit money:
curl -H "Content-Type: application/json" -XPOST http://localhost:9000/api/account/123-4567-890/deposit --data '{ "amount": 100 }'
- To withdraw money:
curl -H "Content-Type: application/json" -XPOST http://localhost:9000/api/account/123-4567-890/withdraw --data '{ "amount": 100 }'
- To retrieve an extract:
curl http://localhost:9000/api/account/123-4567-890/extract/1
Extracts are retrieved by number (#1 in above example). The extract has a status: ARCHIVED meaning it is uploaded to Cloud Object Storage and is being retrieved from there or CURRENT indicating that this is currently being built in-memory and it's not yet uploaded.
- After the 5th operation you should see a INFO logging similar to:
14:04:39.293 [info] com.lightbend.lagom.account.impl.readside.AccountExtractRepositoryImpl [] - Extract 123-4567-890#1 has 5 transactions.
14:04:39.293 [info] com.lightbend.lagom.account.impl.readside.AccountExtractRepositoryImpl [] - Archiving extract: 123-4567-890#1
At this point, Extract 123-4567-890#1 has been archived to Cloud Object Storage bucket. You can retrieve it by calling:
curl http://localhost:9000/api/account/123-4567-890/extract/1
You can also navigate to the Cloud Object Storage bucket in IBM Cloud and verify the presence of the file.
To stop running the service:
- Press "Enter" in the console running the Lagom development environment to stop the service.
- At this point you may want to remove the uploaded files from you Cloud Object Storage or simply delete the bucket or account if there were only created for running this demo.
To understand more about how the example was configured to work with Cloud Object Storage, review the following files in this project's source code:
pom.xmlandaccount-impl/pom.xml— dependency configurationapplication.conf— database connection configurationAccountEntity.java— database-neutral persistent entity implementationAccountExtractProcessor.java— the read-side processor that consumes events fromAccountEntityand forward toAccountExtractRepository.AccountExtractRepositoryImpl.java- the repository that accumulatesAccount Extractsin before archiving in Cloud Object Storage.Storage.java- theStoragecomponent is a facade to Alpakka S3 connector that is used to communicate with the Cloud Object Storage endpoint.
- Lagom: First Impressions and Initial Comparison to Spring Cloud: A blogpost going further in depth about Lagom.
- Guide to Reactive Microservices Using Lagom Framework: Implementation of an example application using a reactive microservices driven architecture.
- Meet Lagom, the latest monolith killer: A brief blogpost introduction to Lagom.
This code pattern is licensed under the Apache Software License, Version 2. Separate third party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the Developer Certificate of Origin, Version 1.1 (DCO) and the Apache Software License, Version 2.