cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cschnei...@apache.org
Subject cxf-dosgi git commit: Document common project
Date Wed, 10 Aug 2016 14:14:50 GMT
Repository: cxf-dosgi
Updated Branches:
  refs/heads/master 04b7948a2 -> e87305ec1


Document common project

Project: http://git-wip-us.apache.org/repos/asf/cxf-dosgi/repo
Commit: http://git-wip-us.apache.org/repos/asf/cxf-dosgi/commit/e87305ec
Tree: http://git-wip-us.apache.org/repos/asf/cxf-dosgi/tree/e87305ec
Diff: http://git-wip-us.apache.org/repos/asf/cxf-dosgi/diff/e87305ec

Branch: refs/heads/master
Commit: e87305ec10fe55d38e500767f39b19490fbb8803
Parents: 04b7948
Author: Christian Schneider <chris@die-schneider.net>
Authored: Wed Aug 10 16:14:39 2016 +0200
Committer: Christian Schneider <chris@die-schneider.net>
Committed: Wed Aug 10 16:14:39 2016 +0200

----------------------------------------------------------------------
 common/Readme.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cxf-dosgi/blob/e87305ec/common/Readme.md
----------------------------------------------------------------------
diff --git a/common/Readme.md b/common/Readme.md
new file mode 100644
index 0000000..6d948c4
--- /dev/null
+++ b/common/Readme.md
@@ -0,0 +1,39 @@
+# CXF DOSGi common
+
+Handles communication with the HttpService and Intents.
+
+## HttpServiceManager
+
+In case a custom http context is used the providers will register a custom servlet.
+Besides this the HttpServiceManager also handles the creation of a default address if none
is given and the conversion from the relative address specified on the service property to
a fully qualified address.
+
+Configs
+
+Key             | Default | Description
+----------------|---------|------------
+httpBase        |         | Start of the addres like http://myserver:8181
+cxfServletAlias | /cxf     | Name of the cxf servlet alias
+
+The absolute address of a service is determined by :
+
+\[httpBase\]\[cxfservletAlias\]\[relative address\]
+
+## IntentManager
+
+The IntentManager service tracks intent services and allows to apply these to a client or
endpoint.
+
+An intent is marked by the service property `org.apache.cxf.dosgi.IntentName`. The value
of this property represents the name of the intent that the user can specify on his service
to refer to the intent.
+
+An intent can be of the following types.
+
+### IntentTypes
+
+* org.apache.cxf.feature.Feature
+* org.apache.cxf.databinding.DataBinding
+* org.apache.cxf.binding.BindingConfiguration
+* javax.ws.rs.ext.ExceptionMapper
+* javax.ws.rs.ext.MessageBodyReader
+* javax.ws.rs.ext.MessageBodyWriter
+* Callable<List<Object>>
+
+The Callable allows to publish a intent service that returns a List of intents. So several
intents can be grouped with one name.


Mime
View raw message