# org.openwms.core.uaa

**Repository Path**: comk1/org.openwms.core.uaa

## Basic Information

- **Project Name**: org.openwms.core.uaa
- **Description**: 支持多租户的UAA服务
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2020-02-28
- **Last Updated**: 2022-05-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Purpose
The OpenWMS.org UAA (User Authentication & Administration) Service is built to fulfill two different requirements regarding the handling of
`Users` of the system.

First the service is capable to act as [OpenID Connect](http://openid.net/connect) authentication endpoint and can authenticate users
against a persistent database.

The second part deals with administration of `Users` like creating new `Users`, updating properties of existing ones or deleting them. Most
application permissions were not directly assigned to `Users` explicitly, but to `Roles` instead. `Users` are assigned to `Roles` and
application permissions were granted to particular `Roles`. Administration of `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` and a `Role` can consist of several `Users`. A `Role` is a `SecurityObject` in
general and has multiple `Grants` assigned. A `Grant` is a permission that can be referenced from a client application.

# Resources
[![Build status](https://travis-ci.com/openwms/org.openwms.core.uaa.svg?branch=master)](https://travis-ci.com/openwms/org.openwms.core.uaa)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
[![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)
[![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/)
# Deployment
The UAA is an essential component for all kind of applications and requires a high degree of availability. However, it is deployed in a
redundant setup in different locations, on different cloud platforms with different ISP.

| endpoints | billed | SLA |
| --------- | ------ | --- |
| https://openwms-core-uaa.herokuapp.com | no | Heroku SLA for Europe region depends on AWS Europe region | 
| https://openwms.org/uaa | no | no SLA |

# 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