Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/openwms/org.openwms.common.service

Essential functionality on common resources like Locations, LocationGroups and TransportUnits
https://github.com/openwms/org.openwms.common.service

amqp cloud logistics microservices openwms rabbitmq spring spring-boot spring-cloud wms

Last synced: about 1 month ago
JSON representation

Essential functionality on common resources like Locations, LocationGroups and TransportUnits

Host: GitHub
URL: https://github.com/openwms/org.openwms.common.service
Owner: openwms
License: apache-2.0
Created: 2023-06-07T07:26:37.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-04-19T09:50:48.000Z (7 months ago)
Last Synced: 2024-05-02T01:11:19.493Z (7 months ago)
Topics: amqp, cloud, logistics, microservices, openwms, rabbitmq, spring, spring-boot, spring-cloud, wms
Language: Java
Homepage: https://openwms.github.io/org.openwms.common.service.lib/
Size: 9.76 MB
Stars: 1
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Purpose
The OpenWMS.org Common Service provides essential functionality to deal with `Locations`, `LocationGroups` and `TransportUnits`. For a
simple example, it offers an API to move a `TransportUnit` from a `Location` A to a `Location` B. Besides that, also other secondary
resources exist, like `TransportUnitTypes` or rule sets to define what type of `TransportUnit` can be put on what type of `Location`.

# Resources

[![Build status](https://github.com/openwms/org.openwms.common.service/actions/workflows/master-build.yml/badge.svg)](https://github.com/openwms/org.openwms.common.service/actions/workflows/master-build.yml)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
[![Maven central](https://img.shields.io/maven-central/v/org.openwms/org.openwms.common.service)](https://search.maven.org/search?q=a:org.openwms.common.service)
[![Docker pulls](https://img.shields.io/docker/pulls/openwms/org.openwms.common.service)](https://hub.docker.com/r/openwms/org.openwms.common.service)
[![Join the chat at https://gitter.im/openwms/org.openwms](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/openwms/org.openwms?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

**Find further Documentation on [Microservice Website](https://openwms.github.io/org.openwms.common.service)**

# Build
The module depends on OpenWMS.org CORE dependencies and one additional optional COMMON dependency that is only used in the enterprise
version and offers an additional API for the UI.

![MavenDependencies][1]

Build a runnable fat jar with the execution of all unit and in-memory database integration tests, but without a required [RabbitMQ](https://www.rabbitmq.com)
server to run:

```
$ ./mvnw package
```

To also build and run with [RabbitMQ](https://www.rabbitmq.com) support call:

```
$ ./mvnw package -DsurefireArgs=-Dspring.profiles.active=ASYNCHRONOUS,TEST
```

This requires a [RabbitMQ](https://www.rabbitmq.com) server running locally with default settings.

# Run
## Run On Command Line
After the binary has been built it can be started from command line. By default, no other infrastructure services are required to run this
service.

Run in standalone mode:
```
$ java -jar target/openwms-common-service-exec.jar
```

To load some sample data, add another profile `DEMO`:
```
$ java -jar target/openwms-common-service-exec.jar --spring.profiles.active=DEMO
```

In a distributed environment the service configuration is fetched from the central [OpenWMS.org Configuration Service](https://github.com/spring-labs/org.openwms.configuration).
This behavior can be enabled by activating the Spring Profile `DISTRIBUTED`. Additionally, it makes sense to enable asynchronous
communication that requires a running [RabbitMQ](https://www.rabbitmq.com) instance - just add another profile `ASYNCHRONOUS`. If the latter
is not applied all asynchronous AMQP endpoints are disabled and the service does not send any events nor does it receive application events
from remote services. The AMQP protocol with the [RabbitMQ](https://www.rabbitmq.com) is currently the only supported message broker. But
switching to others, like [HiveMQ (MQTT)](https://www.hivemq.com) or [Apacha Kafka](https://kafka.apache.org/) is not rocket science.

```
$ java -jar target/openwms-common-service-exec.jar --spring.profiles.active=DISTRIBUTED,ASYNCHRONOUS
```
This requires a [RabbitMQ](https://www.rabbitmq.com) server running locally with default settings.

With these profiles applied the OpenWMS.org Configuration Service is tried to be discovered at service startup. The service fails to start
if no instance of the configuration service is available after a configured amount of retries.

## Run as Docker Container
Instead of building the software from the sources and run it as Java program on the JVM it can also be fetched as a Docker image from
[Docker Hub](https://hub.docker.com/repository/docker/openwms/org.openwms.common.service) and started as a Docker container.

```
$ docker run openwms/org.openwms.common.service:latest
```

[1]: src/site/resources/images/maven-deps.drawio.png