summaryrefslogtreecommitdiffstats
path: root/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs
diff options
context:
space:
mode:
authorDinh Danh Le <dinh.danh.le@ericsson.com>2018-08-05 09:54:13 +0100
committerDinh Danh Le <dinh.danh.le@ericsson.com>2018-08-05 09:57:29 +0100
commit669915c559fb9bcd4a8f8d5239f0b9b6ab33436b (patch)
tree0d0dec28fad650390a9dd6fe2df1e8b00e9e3f22 /plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs
parent0f0f41071ae3c6c7896c7770b0139c9c40866330 (diff)
Adding Apex docs for Plugins module
Change-Id: Icf68473b472a5896972de5b07b275682a77a1c9f Signed-off-by: Dinh Danh Le <dinh.danh.le@ericsson.com> Issue-ID: POLICY-867
Diffstat (limited to 'plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs')
-rw-r--r--plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs/adoc/fragments/ct-restclient-io.adoc63
1 files changed, 63 insertions, 0 deletions
diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs/adoc/fragments/ct-restclient-io.adoc b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs/adoc/fragments/ct-restclient-io.adoc
new file mode 100644
index 000000000..64782a8bc
--- /dev/null
+++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs/adoc/fragments/ct-restclient-io.adoc
@@ -0,0 +1,63 @@
+//
+// ============LICENSE_START=======================================================
+// Copyright (C) 2016-2018 Ericsson. All rights reserved.
+// ================================================================================
+// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
+// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
+//
+// SPDX-License-Identifier: CC-BY-4.0
+// ============LICENSE_END=========================================================
+//
+// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+//
+
+== REST Client IO
+
+APEX can act as REST client on the input as well as on the output interface.
+The media type is `application/json`, so this plugin does only work with the JSON Event protocol.
+
+=== REST Client Input
+
+APEX will connect to a given URL to receive events, but not send any events.
+The server is polled, i.e. APEX will do an HTTP GET, take the result, and then do the next GET.
+Any required timing needs to be handled by the server configured via the URL.
+For instance, the server could support a wait timeout via the URL as `?timeout=100ms`.
+
+[source%nowrap,json]
+----
+"carrierTechnologyParameters" : {
+ "carrierTechnology" : "RESTCLIENT", <1>
+ "parameterClassName" :
+ "org.onap.policy.apex.plugins.event.carrier.restclient.RESTClientCarrierTechnologyParameters",
+ "parameters" : {
+ "url" : "http://example.org:8080/triggers/events", <2>
+ }
+}
+----
+
+<1> set REST client as carrier technology
+<2> the URL of the HTTP server for events
+
+
+=== REST Client Output
+
+APEX will connect to a given URL to send events, but not receive any events.
+The default HTTP operation is POST (no configuration required).
+To change it to PUT simply add the configuration parameter (as shown in the example below).
+
+[source%nowrap,json]
+----
+"carrierTechnologyParameters" : {
+ "carrierTechnology" : "RESTCLIENT", <1>
+ "parameterClassName" :
+ "org.onap.policy.apex.plugins.event.carrier.restclient.RESTClientCarrierTechnologyParameters",
+ "parameters" : {
+ "url" : "http://example.com:8888/actions/events", <2>
+ "httpMethod" : "PUT" <3>
+ }
+}
+----
+
+<1> set REST client as carrier technology
+<2> the URL of the HTTP server for events
+<3> use HTTP PUT (remove this line to use HTTP POST)