diff options
| author |   ramverma <ram.krishna.verma@ericsson.com> | 2018-07-31 18:25:39 +0100 |
|---|---|---|
| committer | ramverma <ram.krishna.verma@ericsson.com> | 2018-07-31 18:27:31 +0100 |
| commit | af74a6270d6ab6badf04a97495a6ef8ccded9b4b (patch) | |
| tree | 2c7a536e54207a0870ca2008ce457a64de917ab9 /src/site-docs/adoc/fragments/apex-policy-model/concept-event.adoc | |
| parent | 9e318f20f2e64970bf3c2e3a5532c516231a6f8a (diff) | |
Adding first set of apex-pdp document changes
Adding document changes for auth, context, core, model, services & the
main apex-pdp module.
Change-Id: Id0d026baa258f1dc6998978f9911f3c4a73b5b3b
Issue-ID: POLICY-867
Signed-off-by: ramverma <ram.krishna.verma@ericsson.com>
Diffstat (limited to 'src/site-docs/adoc/fragments/apex-policy-model/concept-event.adoc')
| -rw-r--r-- | src/site-docs/adoc/fragments/apex-policy-model/concept-event.adoc | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/src/site-docs/adoc/fragments/apex-policy-model/concept-event.adoc b/src/site-docs/adoc/fragments/apex-policy-model/concept-event.adoc new file mode 100644 index 000000000..fdd8d7f5b --- /dev/null +++ b/src/site-docs/adoc/fragments/apex-policy-model/concept-event.adoc @@ -0,0 +1,28 @@ +// +// ============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) +// + +== Concept: Event + +An __Event__ defines the structure of a message that passes into or out of an APEX engine or that passes between two states in an APEX engine. +APEX supports message reception and sending in many formats and all messages are translated into an __Event__ prior to processing by an APEX engine. +Event concepts are keyed with an `ArtifactKey` key. +The parameters of an event are held as a map of __EventField__ concept instances with each parameter indexed by the __LocalName__ of its `ReferenceKey`. +An __Event__ has three fields: + +* The __NameSpace__ identifies the domain of application of the event +* The __Source__ of the event identifies the system that emitted the event +* The __Target__ of the event identifies the system that the event was sent to + +A __PolicyModel__ contains a map of all the events known to a given policy model. +Although an empty model may have no events in its event map, any sane policy model must have at least one __Event__ defined. + |