From 0cf967c0239a8ab9c8b8831b700b72d9a08f7b03 Mon Sep 17 00:00:00 2001
From: liamfallon <liam.fallon@est.tech>
Date: Fri, 16 Oct 2020 13:09:11 +0100
Subject: Remove apex asciidoc documents

Apex documentation has now all been ported to use the ONAP recommended
rst format. This review removes the old asciidoc documents.

Issue-ID: POLICY-2824
Change-Id: I562bd344cb7d6ff36e7d54bdb8f95e3b656468f8
Signed-off-by: liamfallon <liam.fallon@est.tech>
---
 .../site-docs/adoc/fragments/ct-websocket-io.adoc  | 75 ----------------------
 1 file changed, 75 deletions(-)
 delete mode 100644 plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-websocket/src/site-docs/adoc/fragments/ct-websocket-io.adoc

(limited to 'plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-websocket/src/site-docs/adoc/fragments/ct-websocket-io.adoc')

diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-websocket/src/site-docs/adoc/fragments/ct-websocket-io.adoc b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-websocket/src/site-docs/adoc/fragments/ct-websocket-io.adoc
deleted file mode 100644
index 8a19cdd32..000000000
--- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-websocket/src/site-docs/adoc/fragments/ct-websocket-io.adoc
+++ /dev/null
@@ -1,75 +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)
-//
-
-== Websocket (WS) IO
-
-APEX supports the Websockets as input as well as output.
-WS IO is supported by the APEX Websocket plugin.
-This carrier technology does only support uni-directional communication.
-APEX will not send events to a Websocket input and any event sent to a Websocket output will result in an error log.
-
-The input can be configured as client (APEX connects to an existing Websocket server) or server (APEX starts a Websocket server).
-The same applies to the output.
-Input and output can both use a client or a server configuration, or separate configurations (input as client and output as server, input as server and output as client).
-Each configuration should use its own dedicated port to avoid any communication loops.
-The configuration of a Websocket client is the same for input and output.
-The configuration of a Websocket server is the same for input and output.
-
-
-=== Websocket Client
-
-APEX will connect to a given Websocket server.
-As input, it will receive events from the server but not send any events.
-As output, it will send events to the server and any event received from the server will result in an error log.
-
-[source%nowrap,json]
-----
-"carrierTechnologyParameters" : {
-  "carrierTechnology" : "WEBSOCKET", <1>
-  "parameterClassName" :
-  "org.onap.policy.apex.plugins.event.carrier.websocket.WEBSOCKETCarrierTechnologyParameters",
-  "parameters" : {
-    "host" : "localhost", <2>
-    "port" : 42451 <3>
-  }
-}
-----
-
-<1> set Websocket as carrier technology
-<2> the host name on which a Websocket server is running
-<3> the port of that Websocket server
-
-
-
-=== Websocket Server
-
-APEX will start a Websocket server, which will accept any Websocket clients to connect.
-As input, it will receive events from the server but not send any events.
-As output, it will send events to the server and any event received from the server will result in an error log.
-
-[source%nowrap,json]
-----
-"carrierTechnologyParameters" : {
-  "carrierTechnology" : "WEBSOCKET", <1>
-  "parameterClassName" :
-  "org.onap.policy.apex.plugins.event.carrier.websocket.WEBSOCKETCarrierTechnologyParameters",
-  "parameters" : {
-    "wsClient" : false, <2>
-    "port"     : 42450 <3>
-  }
-}
-----
-
-<1> set Websocket as carrier technology
-<2> disable client, so that APEX will start a Websocket server
-<3> the port for the Websocket server APEX will start
-- 
cgit 1.2.3-korg

