diff options
author | Jim Hahn <jrh3@att.com> | 2020-10-16 14:17:43 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2020-10-16 14:17:43 +0000 |
commit | 5190c58837149c4599182d211d8ae5bd83003d34 (patch) | |
tree | 6186091f088a43623a2b9ebf9b203fc33e90825a /plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient | |
parent | c293413c1c46d3c59ff8a855d683f4614bbe644a (diff) | |
parent | 0cf967c0239a8ab9c8b8831b700b72d9a08f7b03 (diff) |
Merge "Remove apex asciidoc documents"
Diffstat (limited to 'plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient')
-rw-r--r-- | plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs/adoc/fragments/ct-restclient-io.adoc | 63 |
1 files changed, 0 insertions, 63 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 deleted file mode 100644 index 64782a8bc..000000000 --- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/site-docs/adoc/fragments/ct-restclient-io.adoc +++ /dev/null @@ -1,63 +0,0 @@ -// -// ============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) |