You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@aries.apache.org by cs...@apache.org on 2020/04/05 06:59:47 UTC
[aries-jax-rs-whiteboard] branch pr-test created (now a8e9806)
This is an automated email from the ASF dual-hosted git repository.
cschneider pushed a change to branch pr-test
in repository https://gitbox.apache.org/repos/asf/aries-jax-rs-whiteboard.git.
at a8e9806 Document configuration properties (thanks to Ray)
This branch includes the following new commits:
new a8e9806 Document configuration properties (thanks to Ray)
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[aries-jax-rs-whiteboard] 01/01: Document configuration properties
(thanks to Ray)
Posted by cs...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
cschneider pushed a commit to branch pr-test
in repository https://gitbox.apache.org/repos/asf/aries-jax-rs-whiteboard.git
commit a8e9806043b9c71d8705fbe25ec30652ee96d99e
Author: Christian Schneider <cs...@adobe.com>
AuthorDate: Sun Apr 5 08:59:34 2020 +0200
Document configuration properties (thanks to Ray)
---
README.md | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/README.md b/README.md
index e93ab2a..b2c6025 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,25 @@
Aries JAX-RS Whiteboard is the reference implementation of the [OSGi JAX-RS Services Whiteboard 1.0](https://osgi.org/specification/osgi.cmpn/7.0.0/service.jaxrs.html).
+
+## Configuration
+
+The whiteboard is configured using configuration admin.
+
+PID | Purpose
+-------------------------------------------| -------
+org.apache.aries.jax.rs.whiteboard.default | Default JAX-RS Whiteboard instance
+org.apache.aries.jax.rs.whiteboard | Factory PID for creating additional JAX-RS Whiteboard instances
+
+Property | Default | Description
+------------------------------------|------------------------|--------------------------------------------------------
+enabled | true | Enable or disable the whiteboard instance
+default.application.base | / | Default path for applications
+application.base.prefix | "" | Prefix for application base
+osgi.http.whiteboard.target | (osgi.http.endpoint=*) | Select the http whiteboard service if there are several
+osgi.http.whiteboard.context.select | | Select the http whiteboard context to be used
+hide-service-list-page | true | Hide the CXF service list
+
## Integrations
The `integrations` folder contains OSGi enabled integrations for a variety of useful libraries that you might want to use with JAX-RS. In many cases these are just adding OSGi lifecycle and configuration to existing JAX-RS enabled libraries.