diff options
| author |   Dinh Danh Le <dinh.danh.le@ericsson.com> | 2018-08-20 17:25:25 +0100 |
|---|---|---|
| committer | Dinh Danh Le <dinh.danh.le@ericsson.com> | 2018-08-20 17:26:14 +0100 |
| commit | e633cd8e2e4bd0dc20a8727a3c35eaacf00a136f (patch) | |
| tree | e248dfa9766815fd0b7a6852253a393c65fb5d7d /plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/event-protocols.adoc | |
| parent | 3191984be03dd5c880ef3cfa56cd77ffa33ab624 (diff) | |
Updating docs for Plugins module
Change-Id: Ia0837cf2f86c42eea71c3f71e8cd99d684912485
Signed-off-by: Dinh Danh Le <dinh.danh.le@ericsson.com>
Issue-ID: POLICY-867
Diffstat (limited to 'plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/event-protocols.adoc')
| -rw-r--r-- | plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/event-protocols.adoc | 38 |
1 files changed, 38 insertions, 0 deletions
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 new file mode 100644 index 000000000..603167194 --- /dev/null +++ b/plugins/plugins-event/plugins-event-protocol/src/site-docs/adoc/fragments/event-protocols.adoc @@ -0,0 +1,38 @@ +// +// ============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. |