aries-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cschnei...@apache.org
Subject aries-rsa git commit: Add documentation
Date Thu, 17 Mar 2016 23:37:36 GMT
Repository: aries-rsa
Updated Branches:
  refs/heads/master 62ccc27b7 -> 52ca04702


Add documentation


Project: http://git-wip-us.apache.org/repos/asf/aries-rsa/repo
Commit: http://git-wip-us.apache.org/repos/asf/aries-rsa/commit/52ca0470
Tree: http://git-wip-us.apache.org/repos/asf/aries-rsa/tree/52ca0470
Diff: http://git-wip-us.apache.org/repos/asf/aries-rsa/diff/52ca0470

Branch: refs/heads/master
Commit: 52ca04702c03e5a6fd971e9b9a2e8485b79f043d
Parents: 62ccc27
Author: Christian Schneider <chris@die-schneider.net>
Authored: Fri Mar 18 00:37:13 2016 +0100
Committer: Christian Schneider <chris@die-schneider.net>
Committed: Fri Mar 18 00:37:13 2016 +0100

----------------------------------------------------------------------
 rsa/Readme.md              |  8 ++++++++
 topology-manager/Readme.md | 22 ++++++++++++++++++++++
 2 files changed, 30 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/aries-rsa/blob/52ca0470/rsa/Readme.md
----------------------------------------------------------------------
diff --git a/rsa/Readme.md b/rsa/Readme.md
new file mode 100644
index 0000000..7378589
--- /dev/null
+++ b/rsa/Readme.md
@@ -0,0 +1,8 @@
+# Remote Service Admin
+
+Is called by the Topology Manager to expose local services as remote endpoints and create
local proxy services as
+clients for remote endpoints.
+
+Aries RSA has a custom [SPI DistributionProvider](https://github.com/apache/aries-rsa/blob/master/spi/src/main/java/org/apache/aries/rsa/spi/DistributionProvider.java)
that allows to easily create new transports and serializations. 
+The RemoteServiceAdmin bundle tracks such provider services and relays the actual creation
of endpoints and proxies to 
+suitable providers.

http://git-wip-us.apache.org/repos/asf/aries-rsa/blob/52ca0470/topology-manager/Readme.md
----------------------------------------------------------------------
diff --git a/topology-manager/Readme.md b/topology-manager/Readme.md
new file mode 100644
index 0000000..1552a65
--- /dev/null
+++ b/topology-manager/Readme.md
@@ -0,0 +1,22 @@
+# Topology Manager
+
+Listens to local services and decides which to expose. It can also add properties to change
the way services are exposed.
+For the services to be exported it calls RemoteServiceAdmin.exportService to do the actual
export. Then notifies
+EndpointListeners about the new Endpoint.
+Listens for service requests from consumers and creates EndpointListeners for these interests.
+
+The TopologyManager by default exposes all suitably marked local services for export and
imports all service interests 
+with matching remote Endpoints. 
+
+## ExportPolicy
+
+This behaviour can be customized by exposing a service implementing the [ExportPolicy interface](https://github.com/apache/aries-rsa/blob/master/spi/src/main/java/org/apache/aries/rsa/spi/ExportPolicy.java).
+It can be used to implement system wide governance rules.
+
+Some examples what could be done:
+
+* Enhancing all exposed remote endpoints with SSL, basic auth, logging
+* Exporting OSGi services with annotations for JAX-WS or JAX-RS even when not specially marked
for export
+
+According to its role the TopologyManager does not directly implement the enhancements above.
It simply enhances the 
+service properties and creates the necessary calls to a suitable RemoteServiceAdmin.


Mime
View raw message