alexandrebruxelle / org.openwms.common.service

OpenWMS COMMON Services for Locations, LocationGroups, TransportUnits etc.

Purpose

The OpenWMS.org Common Service provides essential functionality to deal with Locations, LocationGroups and TransportUnits. An example often referred to is the ability to move a TransportUnit from a Location A to a Location B. Beside this also other secondary resources like TransportUnitTypes or rulesets like the PlacingRule to define what kind of TransportUnit can be put on what type of Location are managed by this service.

Resources

Find further Documentation on Microservice Website

Build

Build a runnable fat jar with the execution of all unit and in-memory database integration tests, but without a required RabbitMQ server to run:

$ ./mvnw package

To also build and run with RabbitMQ support call:

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

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. This behavior can be enabled by activating the Spring Profile DISTRIBUTED. Additionally it makes sense to enable asynchronous communication that requires a running RabbitMQ 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 is currently the only supported message broker. But switching to others, like HiveMQ (MQTT) or Apacha Kafka, is not rocket science.

$ java -jar target/openwms-common-service-exec.jar --spring.profiles.active=DISTRIBUTED,ASYNCHRONOUS

This requires a RabbitMQ 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 and started as a Docker container.

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