https://github.com/openwms/org.openwms.core.uaa.lib

https://github.com/openwms/org.openwms.core.uaa.lib

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/openwms/org.openwms.core.uaa.lib
• Owner: openwms
• License: apache-2.0
• Created: 2023-12-13T08:13:21.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-12-29T09:31:56.000Z (4 months ago)
• Last Synced: 2024-12-29T10:18:54.258Z (4 months ago)
• Language: Java
• Homepage: https://openwms.github.io/org.openwms.core.uaa.lib/
• Size: 2.57 MB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Purpose

The OpenWMS.org UAA (User Account & Administration) Service deals with the administration of `Users` like creating new `Users`, updating

properties of existing ones or deleting them. Application permissions are not directly granted to `Users` explicitly, but to `Roles`

instead. `Users` are assigned to `Roles` and application permissions were granted to particular `Roles`. An administration API for `Roles`

and permissions is especially required for a UI application.

![classes][1]

An `User` has embedded `UserDetails`, and `Emails` assigned. However, the password history of the `User` is managed and compared against new

passwords. An `User` can be assigned to multiple `Roles`. A `Role` is a `SecurityObject` in general and has multiple `Grants` assigned. A

`Grant` is a permission that can be used in a client application.

# Resources

[![Build status](https://github.com/openwms/org.openwms.core.uaa/actions/workflows/master-build.yml/badge.svg)](https://github.com/openwms/org.openwms.core.uaa/actions/workflows/master-build.yml)

[![Quality](https://sonarcloud.io/api/project_badges/measure?project=org.openwms:org.openwms.core.uaa&metric=alert_status)](https://sonarcloud.io/dashboard?id=org.openwms:org.openwms.core.uaa)

[![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.core.uaa)](https://search.maven.org/search?q=a:org.openwms.core.uaa)

[![Docker pulls](https://img.shields.io/docker/pulls/openwms/org.openwms.core.uaa)](https://hub.docker.com/r/openwms/org.openwms.core.uaa)

[![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 more information about the service on the microservice [website...](https://openwms.github.io/org.openwms.core.uaa/)

# Build

Build a runnable fat jar with execution of all unit and in-memory database integrations:

```

$ mvnw package

```

Run the Sonar analysis:

```

$ mvnw package -Psonar

```

## Run

After the binary has been built it can be started from command line. No other infrastructure services are required to run this service.

```

$ java -jar target/openwms-core-uaa-exec.jar

```

In a distributed Cloud environment the service can itself register on a central discovery service - currently Eureka is supported only. This

behavior can be enabled by activating the Spring Profile `DISTRIBUTED`.

```

$ java -jar target/openwms-core-uaa-exec.jar --spring.profiles.active=DISTRIBUTED

```

Now the UAA service is registered at the discovery service at startup and can be looked up by other services by its name `uaa-service`.

## Release

```

$ mvn deploy -Prelease,gpg

```

### Release Documentation

```

$ mvn package -DsurefireArgs=-Dspring.profiles.active=ASYNCHRONOUS,TEST -Psonar

$ mvn site scm-publish:publish-scm

```

[1]: src/site/resources/images/ClassDiagram.svg