summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortkogut <tomasz.kogut@nokia.com>2021-03-12 11:07:53 +0100
committertkogut <tomasz.kogut@nokia.com>2021-03-16 14:17:02 +0100
commiteb4cf54acb2a7ed9d3052c3bf73aebe48aeafd4b (patch)
treee210c35dbe3307b888900bce5407494cd9d541a7 /docs
parent6d97c51031d2a4658661ca41ff2ebbbd0e1faf11 (diff)
Update documentation regarding authorized topics configuration in dmaap-client.
Issue-ID: DCAEGEN2-2670 Signed-off-by: tkogut <tomasz.kogut@nokia.com> Change-Id: I772af8e7e95fcf15252dd7bd7b1fd777573e5a30
Diffstat (limited to 'docs')
-rw-r--r--docs/sections/sdk/apis.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/sections/sdk/apis.rst b/docs/sections/sdk/apis.rst
index 8f20a0ab..823027f2 100644
--- a/docs/sections/sdk/apis.rst
+++ b/docs/sections/sdk/apis.rst
@@ -291,6 +291,54 @@ The default custom persistent connection configuration (connectionPool=16, maxLi
ImmutableDmaapConnectionPoolConfig.builder().build()
+***************************************
+Configure request for authorized topics
+***************************************
+
+* publisher:
+
+.. code-block:: java
+
+ final MessageRouterSink sink = ImmutableMessageRouterSink.builder()
+ .aafCredentials(ImmutableAafCredentials.builder()
+ .username("username")
+ .password("password").build())
+ .
+ .
+ .
+ .build();
+
+ final MessageRouterPublishRequest request = ImmutableMessageRouterPublishRequest.builder()
+ .sinkDefinition(sink)
+ .
+ .
+ .
+ .build();
+
+* subscriber:
+
+.. code-block:: java
+
+ final MessageRouterSource sourceDefinition = ImmutableMessageRouterSource.builder()
+ .aafCredentials(ImmutableAafCredentials.builder()
+ .username("username")
+ .password("password")
+ .build())
+ .
+ .
+ .
+ .build();
+
+ final MessageRouterSubscribeRequest request = ImmutableMessageRouterSubscribeRequest.builder()
+ .sourceDefinition(sourceDefinition)
+ .
+ .
+ .
+ .build();
+
+AAF Credentials are optional for subscribe/publish requests.
+Username and password are used for basic authentication header during sending HTTP request to dmaap-mr.
+
hvvesclient-producer - a reference Java implementation of High Volume VES Collector client
------------------------------------------------------------------------------------------
This library is used in xNF simulator which helps us test HV VES Collector in CSIT tests. You may use it as a reference when implementing your code in non-JVM language or directly when using Java/Kotlin/etc.