You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by cs...@apache.org on 2016/07/06 10:00:08 UTC
[3/3] cxf-dosgi git commit: Cleanups in constants and adding
documentation
Cleanups in constants and adding documentation
Project: http://git-wip-us.apache.org/repos/asf/cxf-dosgi/repo
Commit: http://git-wip-us.apache.org/repos/asf/cxf-dosgi/commit/7f75cc06
Tree: http://git-wip-us.apache.org/repos/asf/cxf-dosgi/tree/7f75cc06
Diff: http://git-wip-us.apache.org/repos/asf/cxf-dosgi/diff/7f75cc06
Branch: refs/heads/master
Commit: 7f75cc0672bb24704a82b742c9f5ec4dcf7a4049
Parents: 052cccc
Author: Christian Schneider <ch...@die-schneider.net>
Authored: Wed Jul 6 11:59:57 2016 +0200
Committer: Christian Schneider <ch...@die-schneider.net>
Committed: Wed Jul 6 11:59:57 2016 +0200
----------------------------------------------------------------------
Readme.md | 32 ++++++++++++++++++++
provider-rs/Readme.md | 16 ++++++++++
.../dosgi/dsw/handlers/rest/RsConstants.java | 4 ---
provider-ws/Readme.md | 31 +++++++++++++++++++
.../cxf/dosgi/dsw/handlers/ws/WsConstants.java | 10 ------
5 files changed, 79 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cxf-dosgi/blob/7f75cc06/Readme.md
----------------------------------------------------------------------
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..731dfa4
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,32 @@
+# CXF DOSGi
+
+Provides CXF based Distribution providers for [Aries Remote Service Admin (RSA)](http://aries.apache.org/modules/rsa.html).
+
+## Distribution Providers
+
+* cxf-dosgi-provider-ws SOAP transport
+* cxf-dosgi.provider-rs REST transport
+
+## Intents
+
+A service can list the named intents it requires. It will then only be exported / imported
+once all the intents are available. This allows for example security restrictions or logging.
+
+Example
+
+* service.exported.intents=logging
+
+See [](common "common module").
+
+## Build
+
+mvn clean install
+
+## Deployment
+
+CXF DOSGi can be deployed in three different ways
+
+* Multi bundle distro (deprecated)
+* Karaf feature
+* Bndtools pom repository
+
http://git-wip-us.apache.org/repos/asf/cxf-dosgi/blob/7f75cc06/provider-rs/Readme.md
----------------------------------------------------------------------
diff --git a/provider-rs/Readme.md b/provider-rs/Readme.md
new file mode 100644
index 0000000..e387952
--- /dev/null
+++ b/provider-rs/Readme.md
@@ -0,0 +1,16 @@
+# CXF DOSGi provider RS
+
+REST based transport for Aries RSA. The exported service must be annotated with JAX-RS annotations to map the methods to HTTP verbs.
+
+# Properties
+
+* service.exported.interfaces Interfaces to be exported or * to export all
+* service.exported.configs org.apache.cxf.rs
+* org.apache.cxf.rs.address http://localhost:9090/greeter for CXF jetty transport or /greeter for servlet transport
+* org.apache.cxf.rs.httpservice.context Can be set to use a specific http context
+* org.apache.cxf.rs.httpservice.context.properties.* Properties wih this prefix will be set as properties of the factory. They can be used to configure features
+* org.apache.cxf.rs.wadl.location
+
+# Sample
+
+See sample greeter-rest
http://git-wip-us.apache.org/repos/asf/cxf-dosgi/blob/7f75cc06/provider-rs/src/main/java/org/apache/cxf/dosgi/dsw/handlers/rest/RsConstants.java
----------------------------------------------------------------------
diff --git a/provider-rs/src/main/java/org/apache/cxf/dosgi/dsw/handlers/rest/RsConstants.java b/provider-rs/src/main/java/org/apache/cxf/dosgi/dsw/handlers/rest/RsConstants.java
index 9d13064..a6c4ceb 100644
--- a/provider-rs/src/main/java/org/apache/cxf/dosgi/dsw/handlers/rest/RsConstants.java
+++ b/provider-rs/src/main/java/org/apache/cxf/dosgi/dsw/handlers/rest/RsConstants.java
@@ -23,11 +23,7 @@ public final class RsConstants {
public static final String RS_CONFIG_TYPE = "org.apache.cxf.rs";
public static final String RS_ADDRESS_PROPERTY = RS_CONFIG_TYPE + ".address";
public static final String RS_HTTP_SERVICE_CONTEXT = RS_CONFIG_TYPE + ".httpservice.context";
- public static final String RS_DATABINDING_PROP_KEY = RS_CONFIG_TYPE + ".databinding";
public static final String RS_CONTEXT_PROPS_PROP_KEY = RS_CONFIG_TYPE + ".context.properties";
- public static final String RS_PROVIDER_PROP_KEY = RS_CONFIG_TYPE + ".provider";
- public static final String RS_PROVIDER_EXPECTED_PROP_KEY = RS_PROVIDER_PROP_KEY + ".expected";
- public static final String RS_PROVIDER_GLOBAL_PROP_KEY = RS_PROVIDER_PROP_KEY + ".globalquery";
public static final String RS_WADL_LOCATION = RS_CONFIG_TYPE + ".wadl.location";
private RsConstants() {
http://git-wip-us.apache.org/repos/asf/cxf-dosgi/blob/7f75cc06/provider-ws/Readme.md
----------------------------------------------------------------------
diff --git a/provider-ws/Readme.md b/provider-ws/Readme.md
new file mode 100644
index 0000000..e698ae2
--- /dev/null
+++ b/provider-ws/Readme.md
@@ -0,0 +1,31 @@
+# CXF DOSGi provider WS
+
+SOAP based transport for Aries RSA.
+
+# Properties
+
+
+* service.exported.interfaces Interfaces to be exported or * to export all
+* service.exported.configs org.apache.cxf.ws
+* org.apache.cxf.ws.address http://localhost:9090/greeter for CXF jetty transport or /greeter for servlet transport
+* org.apache.cxf.ws.httpservice.context Can be set to use a specific http context
+* org.apache.cxf.ws.context.properties.* Properties wih this prefix will be set as properties of the factory. They can be used to configure features
+
+# Modes
+
+This transport has two modes: Simple and JAX-WS. If the service is annotated using @Webservice
+then JAX-WS mode is used else simple mode is used.
+
+## Simple
+
+This mode uses the CXF simple frontend and the Aegis Databinding. It can export almost any service but is not much configureable. Aegis is also not very popular anymore. So this
+mode is more for exporting existing services and small tests.
+
+## JAX-WS
+
+If the service is annotated using @Webservice then the JAX-WS mode is activated. It uses
+the CXF JAX-WS frontend and the JAXB databinding. It can be customized using the usual annotations.
+
+# Samples
+
+See sample greeter
http://git-wip-us.apache.org/repos/asf/cxf-dosgi/blob/7f75cc06/provider-ws/src/main/java/org/apache/cxf/dosgi/dsw/handlers/ws/WsConstants.java
----------------------------------------------------------------------
diff --git a/provider-ws/src/main/java/org/apache/cxf/dosgi/dsw/handlers/ws/WsConstants.java b/provider-ws/src/main/java/org/apache/cxf/dosgi/dsw/handlers/ws/WsConstants.java
index 6e32f1f..45c6ab8 100644
--- a/provider-ws/src/main/java/org/apache/cxf/dosgi/dsw/handlers/ws/WsConstants.java
+++ b/provider-ws/src/main/java/org/apache/cxf/dosgi/dsw/handlers/ws/WsConstants.java
@@ -23,18 +23,8 @@ public final class WsConstants {
public static final String WS_ADDRESS_PROPERTY = WS_CONFIG_TYPE + ".address";
public static final String WS_PORT_PROPERTY = WS_CONFIG_TYPE + ".port";
public static final String WS_HTTP_SERVICE_CONTEXT = WS_CONFIG_TYPE + ".httpservice.context";
-
- public static final String WS_FRONTEND_PROP_KEY = WS_CONFIG_TYPE + ".frontend";
- public static final String WS_FRONTEND_JAXWS = "jaxws";
- public static final String WS_FRONTEND_SIMPLE = "simple";
-
public static final String WS_CONTEXT_PROPS_PROP_KEY = WS_CONFIG_TYPE + ".context.properties";
- public static final String WS_DATABINDING_PROP_KEY = WS_CONFIG_TYPE + ".databinding";
- public static final String WS_DATABINDING_BEAN_PROP_KEY = WS_DATABINDING_PROP_KEY + ".bean";
- public static final String WS_DATA_BINDING_JAXB = "jaxb";
- public static final String WS_DATA_BINDING_AEGIS = "aegis";
-
public static final String WS_WSDL_SERVICE_NAMESPACE = WS_CONFIG_TYPE + ".service.ns";
public static final String WS_WSDL_SERVICE_NAME = WS_CONFIG_TYPE + ".service.name";
public static final String WS_WSDL_PORT_NAME = WS_CONFIG_TYPE + ".port.name";