com.paremus.ui:_index

The common parent pom for the Paremus REST UI server

License	License Fair Source License, version 0.9
Categories	Categories Dex General Purpose Libraries Utility
GroupId	GroupId com.paremus.ui
ArtifactId	ArtifactId _index
Last Version	Last Version 1.0.0
Release Date	Release Date Jun 18, 2020
Type	Type pom
Description	Description The common parent pom for the Paremus REST UI server
Project Organization	Project Organization Paremus Ltd

Download _index

Filename	Size
_index-1.0.0.pom	6 KB
Browse

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.paremus.ui/_index/ -->
<dependency>
    <groupId>com.paremus.ui</groupId>
    <artifactId>_index</artifactId>
    <version>1.0.0</version>
    <type>pom</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.paremus.ui/_index/
implementation 'com.paremus.ui:_index:1.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.paremus.ui/_index/
implementation ("com.paremus.ui:_index:1.0.0")

Apache Buildr

'com.paremus.ui:_index:pom:1.0.0'

Apache Ivy

<dependency org="com.paremus.ui" name="_index" rev="1.0.0">
  <artifact name="_index" type="pom" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.paremus.ui', module='_index', version='1.0.0')
)

Scala SBT

libraryDependencies += "com.paremus.ui" % "_index" % "1.0.0"

Leiningen

[com.paremus.ui/_index "1.0.0"]

Dependencies

compile (11)

Group / Artifact	Type	Version
com.paremus.ui : com.paremus.ui.client	jar	1.0.0
com.paremus.ui : com.paremus.ui.rest.app	jar	1.0.0
com.paremus.ui : com.paremus.ui.rest.config	jar	1.0.0
com.paremus.ui : com.paremus.ui.rest.fake	jar	1.0.0
org.apache.felix : org.apache.felix.http.servlet-api	jar	1.1.2
org.apache.aries.spec : org.apache.aries.javax.jax.rs-api	jar	1.0.4
com.fasterxml.jackson.core : jackson-databind	jar	2.9.8
com.fasterxml.jackson.jaxrs : jackson-jaxrs-json-provider	jar	2.9.8
org.apache.shiro : shiro-core	jar	1.4.0
org.apache.aries.jax.rs : org.apache.aries.jax.rs.shiro.authz	jar	1.0.2
org.apache.felix : org.apache.felix.metatype	jar	1.2.2

runtime (14)

Group / Artifact	Type	Version
org.apache.felix : org.apache.felix.http.jetty	jar	4.0.8
org.apache.aries.jax.rs : org.apache.aries.jax.rs.whiteboard	jar	1.0.4
org.apache.aries.jax.rs : org.apache.aries.jax.rs.jackson	jar	1.0.1
org.apache.commons : commons-configuration2	jar	2.5
com.paremus.build : bundle-testing-dependencies	pom	1.0.0
org.osgi : org.osgi.service.log	jar	1.4.0
org.apache.servicemix.specs : org.apache.servicemix.specs.jaxb-api-2.2	jar	2.9.0
org.apache.servicemix.specs : org.apache.servicemix.specs.jaxws-api-2.2	jar	2.9.0
org.apache.felix : org.apache.felix.webconsole	jar	4.3.12
org.apache.felix : org.apache.felix.webconsole.plugins.ds	jar	2.1.0
org.apache.felix : org.apache.felix.gogo.command	jar	1.0.2
org.apache.felix : org.apache.felix.gogo.runtime	jar	1.0.10
org.apache.felix : org.apache.felix.gogo.jline	jar	1.0.10
org.jline : jline	jar	3.5.1

Project Modules

There are no modules declared in this project.

The Paremus UI Server Repository

This repository contains core components for building a modular REST UI service.

Repository Contents

This repository contains:

_index

Generates OSGi index.xml containing all resources and dependencies needed to deploy. It is used to resolve com.paremus.ui.rest.app/app.bndrun and is published so other projects can easily extend the UI.

com.paremus.ui.client

Provides a Servlet to serve the Javascript client. During development the location of the client can be specified by setting the system property com.paremus.ui.client.dir to the client directory.

For production deployment the Javascript client is embedded as a resource in this bundle. It is obtained from the artifact published by the com.paremus.ui:js_client project.

com.paremus.ui.metaconfig

Aggregates Metatype services from remote nodes to provide a distributed configuration service.

Provides a service to map framework UUID into hostnames (for friendly presentation in UI).

Provides basic host information (model, memory, OS, etc), using JNI library (https://github.com/oshi/oshi)

com.paremus.ui.rest

Core REST services

API DTOs
AbstractResource that handles query filters and pagination
Login resource (default user/password is admin/admin)
Watch support using Server Sent Events
- UI is notified when watched resource changes
Event resources - generic watchable events

com.paremus.ui.rest.app

App setup/configuration.

app.bndrun for stand-alone testing.

com.paremus.ui.rest.config

Distributed config resource implemented using Metaconfig service.

com.paremus.ui.rest.fake

Fake (test) resources so UI can be tested standalone.

How to extend this repository

This repository contains some "core" rest services but also many fake/test resources.

To build a real UI server, you should resolve your project against the _index of this repository, but exclude com.paremus.ui.app and com.paremus.ui.rest.fake from the resolution. Instead provide your own app/setup and real implementations of the fake (or other) resources.

The Javascript UI is dynamically configurable (you can control which resources it shows from the UI server config), but it is not currently modular. If you want the UI client to show new resources, you need to extend the current UI client and rebuild the whole Javascript client project.

How to build this repository

This repository can be built using Maven 3.5.4 and Java 11.

Build profiles

By default the build will run with all tests, and lenient checks on copyright headers. To enable strict copyright checking (required for deployment) then the strict-license-check profile should be used, for example

mvn -P strict-license-check clean install

If you make changes and do encounter licensing errors then the license headers can be regenerated using the generate-licenses profile

mvn -P generate-licenses process-sources

end

Paremus

Versions

Version
1.0.0 Jun 18, 2020