Merge "Remove apex asciidoc documents"

6 files changed, 0 insertions, 237 deletions

diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/site-docs/adoc/fragments/ep-jms.adoc b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/site-docs/adoc/fragments/ep-jms.adoc
deleted file mode 100644
index aa33a2b8f..000000000
--- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/site-docs/adoc/fragments/ep-jms.adoc
+++ /dev/null
@@ -1,51 +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)
-//
-
-== JMS Event
-
-The event protocol for JMS is provided by the APEX JMS plugin.
-The plugin supports encoding as JSON text or as object.
-There is no difference in the configuration for the input and output interface.
-
-=== JMS Text
-
-If used as input, APEX will take a JMS message and extract a JSON string, then proceed as if a JSON event was received.
-If used as output, APEX will take the event produced by a policy, create a JSON string, and then wrap it into a JMS message.
-
-The configuration for JMS text is as follows:
-
-[source%nowrap,json]
-----
-"eventProtocolParameters":{
-  "eventProtocol" : "JMSTEXT",
-  "parameterClassName" :
-    "org.onap.policy.apex.plugins.event.protocol.jms.JMSTextEventProtocolParameters"
-}
-----
-
-
-=== JMS Object
-
-If used as input, APEX will will take a JMS message, extract a Java Bean from the `ObjectMessage` message, construct an APEX event and put the bean on the APEX event as a parameter.
-If used as output, APEX will take the event produced by a policy, create a Java Bean and send it as a JMS message.
-
-The configuration for JMS object is as follows:
-
-[source%nowrap,json]
-----
-"eventProtocolParameters":{
-  "eventProtocol" : "JMSOBJECT",
-  "parameterClassName" :
-    "org.onap.policy.apex.plugins.event.protocol.jms.JMSObjectEventProtocolParameters"
-}
-----
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/site-docs/adoc/fragments/ep-xml.adoc b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/site-docs/adoc/fragments/ep-xml.adoc
deleted file mode 100644
index 316a1ab12..000000000
--- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/site-docs/adoc/fragments/ep-xml.adoc
+++ /dev/null
@@ -1,33 +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)
-//
-
-== XML Event
-
-The event protocol for XML is provided by the APEX XML plugin.
-There is no difference in the configuration for the input and output interface.
-
-If used as input, APEX will consume events as XML and map them to policy trigger events.
-Not well-formed XML and not understood trigger events will be rejected.
-If used as output, APEX produce XML encoded events from the event a policy produces.
-Those events will always be well-formed according to the definition in the policy model.
-
-The following code shows the configuration.
-
-[source%nowrap,json]
-----
-"eventProtocolParameters":{
-  "eventProtocol" : "XML",
-  "parameterClassName" :
-      "org.onap.policy.apex.plugins.event.protocol.xml.XMLEventProtocolParameters"
-}
-----
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/site-docs/adoc/fragments/ep-yaml.adoc b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/site-docs/adoc/fragments/ep-yaml.adoc
deleted file mode 100644
index 90c3812af..000000000
--- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/site-docs/adoc/fragments/ep-yaml.adoc
+++ /dev/null
@@ -1,33 +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)
-//
-
-== YAML Event
-
-The event protocol for YAML is provided by the APEX YAML plugin.
-There is no difference in the configuration for the input and output interface.
-
-If used as input, APEX will consume events as YAML and map them to policy trigger events.
-Not well-formed YAML and not understood trigger events will be rejected.
-If used as output, APEX produce YAML encoded events from the event a policy produces.
-Those events will always be well-formed according to the definition in the policy model.
-
-The following code shows the configuration.
-
-[source%nowrap,json]
-----
-"eventProtocolParameters":{
-  "eventProtocol" : "XML",
-  "parameterClassName" :
-      "org.onap.policy.apex.plugins.event.protocol.yaml.YamlEventProtocolParameters"
-}
-----
diff --git a/plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/ep-apex.adoc b/plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/ep-apex.adoc
deleted file mode 100644
index 16d41ac89..000000000
--- a/plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/ep-apex.adoc
+++ /dev/null
@@ -1,28 +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)
-//
-
-== APEX Event
-
-The event protocol for APEX events does not require a specific plugin, it is supported by default.
-Furthermore, there is no difference in the configuration for the input and output interface.
-
-For input and output APEX uses APEX events.
-
-The following JSON shows the configuration.
-
-[source%nowrap,json]
-----
-"eventProtocolParameters":{
-  "eventProtocol" : "APEX"
-}
-----
diff --git a/plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/ep-json.adoc b/plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/ep-json.adoc
deleted file mode 100644
index 107858dc2..000000000
--- a/plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/ep-json.adoc
+++ /dev/null
@@ -1,54 +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)
-//
-
-== JSON Event
-
-The event protocol for JSON encoding does not require a specific plugin, it is supported by default.
-Furthermore, there is no difference in the configuration for the input and output interface.
-
-For an input, APEX requires a well-formed JSON string.
-Well-formed here means according to the definitions of a policy.
-Any JSON string that is not defined as a trigger event (consume) will not be consumed (errors will be thrown).
-For output JSON events, APEX will always produce valid JSON strings according to the definition in the policy model.
-
-The following JSON shows the configuration.
-
-[source%nowrap,json]
-----
-"eventProtocolParameters":{
-  "eventProtocol" : "JSON"
-}
-----
-
-For JSON events, there are a few more optional parameters, which allow to define a mapping for standard event fields.
-An APEX event must have the fields `name`, `version`, `source`, and `target` defined.
-Sometimes it is not possible to configure a trigger or actioning system to use those fields.
-However, they might be in an event generated outside APEX (or used outside APEX) just with different names.
-To configure APEX to map between the different event names, simply add the following parameters to a JSON event:
-
-[source%nowrap,json]
-----
-"eventProtocolParameters":{
-  "eventProtocol" : "JSON",
-  "nameAlias"     : "policyName", <1>
-  "versionAlias"  : "policyVersion", <2>
-  "sourceAlias"   : "from", <3>
-  "targetAlias"   : "to", <4>
-  "nameSpaceAlias": "my.name.space" <5>
-}
-----
-<1> mapping for the `name` field, here from a field called `policyName`
-<2> mapping for the `version` field, here from a field called `policyVersion`
-<3> mapping for the `source` field, here from a field called `from` (only for an input event)
-<4> mapping for the `target` field, here from a field called `to` (only for an output event)
-<5> mapping for the `nameSpace` field, here from a field called `my.name.space`
diff --git a/plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/event-protocols.adoc b/plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/event-protocols.adoc
deleted file mode 100644
index 603167194..000000000
--- a/plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/event-protocols.adoc
+++ /dev/null
@@ -1,38 +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)
-//
-
-== Event Protocols, Format and Encoding
-
-Event protocols define what event formats APEX can receive (input) and should send (output).
-They can be used in any combination for input and output, unless further restricted by a carrier technology plugin (for instance for JMS output).
-There can only be 1 event protocol per event plugin.
-
-Supported _input_ event protocols are:
-
-- JSON, the event as a JSON string
-- APEX, an APEX event
-- JMS object, the event as a JMS object,
-- JMS text, the event as a JMS text,
-- XML, the event as an XML string,
-- YAML, the event as YAML text
-
-Supported _output_ event protocols are:
-
-- JSON, the event as a JSON string
-- APEX, an APEX event
-- JMS object, the event as a JMS object,
-- JMS text, the event as a JMS text,
-- XML, the event as an XML string,
-- YAML, the event as YAML text
-
-New event protocols can be added as plugins to APEX or developed outside APEX and added to an APEX deployment.