Name: Lagom-object-storage
Owner: International Business Machines
Description: null
Created: 2018-05-17 22:34:21.0
Updated: 2018-05-22 22:40:17.0
Pushed: 2018-05-23 17:43:05.0
Homepage: null
Size: 28
Language: Java
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
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.
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.
To build and run this example, you need:
Follow these steps to get a local copy of this project and configure it with the Cloud Object Storage credentials and settings.
clone https://github.com/IBM/Lagom-object-storage.git
agom-object-storage
account-impl/src/main/resources/cloud-object-storage.conf.template
file to account-impl/src/main/resources/cloud-object-storage.conf
.account-impl/src/main/resources/cloud-object-storage.conf
in a text editor and fill in the necessary information. Details are provided in the file itself.In the command line shell where you downloaded the Lagom service, start the Lagom development environment from the lagom-cloud-object-storage-example
directory:
lagom:runAll
You should see some console output, including these lines:
O] Service gateway is running at http://localhost:9000
O] (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:
http://localhost:9000/api/account/123-4567-890/balance
To deposit money:
-H "Content-Type: application/json" -XPOST http://localhost:9000/api/account/123-4567-890/deposit --data '{ "amount": 100 }'
To withdraw money:
-H "Content-Type: application/json" -XPOST http://localhost:9000/api/account/123-4567-890/withdraw --data '{ "amount": 100 }'
To retrieve an extract:
http://localhost:9000/api/account/123-4567-890/extract/1
Extract 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 operations you should see a INFO logging similar to:
4:39.293 [info] com.lightbend.lagom.account.impl.readside.AccountExtractRepositoryImpl [] - Extract 123-4567-890#1 has 5 transactions.
4: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:
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:
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.xml
and account-impl/pom.xml
? dependency configurationapplication.conf
? database connection configurationAccountEntity.java
? database-neutral persistent entity implementationAccountExtractProcessor.java
? the read-side processor that consumes events from AccountEntity
and forward to AccountExtractRepository
.AccountExtractRepositoryImpl.java
- the repository that accumulates Account Extracts
in before archiving in Cloud Object Storage.Storage.java
- the Storage
component is a facade to Alpakka S3 connector that is used to communicate with the Cloud Object Storage endpoint.