Matthias Wessendorf matzew

User Management via Keycloak for the AeroGear Unfied Push Server

Introduction

The goal of this document is to describe how the User Management (based on Keycloak) will be implemented in the UnifiedPush Server. Currently there is only one user (admin) created by default when installing UPS. Having the possibility to create multiple (non-admin) users via the Keycloak Admin Console is a Must Have. Some roles should also be introduced.

Roles / Permissions

1. Install Forge

Instructions can be found here : http://forge.jboss.org/docs/using/

2. Install feature branch of ag-controller

AG Controller scaffolding needs some features only available in a branch : Clone this repo :

https://github.com/sebastienblanc/aerogear-controller

and check out this branch :

Below is a comparison of the method usage proposed by each lib for handling paged resources.

RestEasy Integration with AeroGear Controller

This document is intended to describe AeroGear Controllers integration with RestEasy.

Background

Currently, the routes that AeroGear Controller can handle are "one way" in the sense that they go through AeroGear Controller are forwarded to a view, which can be populated by a data model provided by the Controller for the route in question.
For example:

route()
      .from("/customers/{id}")
 .on(RequestMethod.GET)

What is a pipeline ?

A pipeline represents a set of n connections to a server. The pipeline class offers some simple 'management' APIs to work with containing 'pipe' objects. Basically it allows you to add or remove new connections to the pipeline.

What is a pipe ?

A pipe represents one connection to a server. The pipe API is basically an abstraction layer for any server side connection, which all allows you to simply 'read' from, or 'write' to a server connection. However, technical details like RESTful APIs (e.g. HTTP PUT or HTTT GET) are not exposed on the pipeline and pipe APIs. In the future you can have different type of pipe objects (-> connections). The default (and CURRENTLY only supported) type is a REST connection.

Below is an example from our JavaScript lib:

	apiVersion: console.openshift.io/v1
	kind: ConsoleQuickStart
	metadata:
	name: serverless-cli
	spec:
	displayName: Serverless CLI
	description: todo
	durationMinutes: 10
	tags:
	- knative

	node1:
	image: hauptmedia/mariadb:10.1
	hostname: node1
	ports:
	- 13306:3306
	environment:
	- MYSQL_ROOT_PASSWORD=unifiedpush
	- REPLICATION_PASSWORD=unifiedpush
	- MYSQL_DATABASE=unifiedpush
	- MYSQL_USER=unifiedpush

	var express = require('express');
	var router = express.Router();

	// my few includes
	require('./foo_1')(router);
	require('./foo_2')(router);

	module.exports = router;

	var leaguePipe = AeroGear.Pipeline();
	pipeline.add( "leagues", {
	baseURL: "http://soccer.org/",
	}).leagues;

	//READ "teams" for league "seattle":
	// http://soccer.org/leagues/seattle/teams
	leaguePipe.read({
	id: "seattle",
	resource: "/teams",

	class Pipeline {
	PipeBuilder add() {
	return new PipeBuilder(this);
	}
	}

	class Pipebuilder {
	PipeBuilder withUrl(..)
	....
	....