From af74a6270d6ab6badf04a97495a6ef8ccded9b4b Mon Sep 17 00:00:00 2001 From: ramverma Date: Tue, 31 Jul 2018 18:25:39 +0100 Subject: 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 --- .../adoc/guides/APEX-Developer-Guide.adoc | 92 +++++++++ src/site-docs/adoc/guides/APEX-Install-Guide.adoc | 52 +++++ src/site-docs/adoc/guides/APEX-Introduction.adoc | 45 +++++ src/site-docs/adoc/guides/APEX-Policy-Guide.adoc | 83 ++++++++ src/site-docs/adoc/guides/APEX-Publications.adoc | 65 ++++++ src/site-docs/adoc/guides/APEX-User-Manual.adoc | 217 +++++++++++++++++++++ src/site-docs/adoc/guides/HowTo-APEX.adoc | 55 ++++++ src/site-docs/adoc/guides/HowTo-Build-APEX.adoc | 50 +++++ src/site-docs/adoc/guides/HowTo-Codestyle.adoc | 65 ++++++ src/site-docs/adoc/guides/HowTo-Configuration.adoc | 96 +++++++++ src/site-docs/adoc/guides/HowTo-Logging.adoc | 50 +++++ src/site-docs/adoc/guides/HowTo-MyFirstPolicy.adoc | 63 ++++++ src/site-docs/adoc/guides/HowTo-PolicyLogic.adoc | 44 +++++ src/site-docs/adoc/guides/HowTo-Websockets.adoc | 54 +++++ .../adoc/guides/Tech-APEX-PolicyModel.adoc | 62 ++++++ 15 files changed, 1093 insertions(+) create mode 100644 src/site-docs/adoc/guides/APEX-Developer-Guide.adoc create mode 100644 src/site-docs/adoc/guides/APEX-Install-Guide.adoc create mode 100644 src/site-docs/adoc/guides/APEX-Introduction.adoc create mode 100644 src/site-docs/adoc/guides/APEX-Policy-Guide.adoc create mode 100644 src/site-docs/adoc/guides/APEX-Publications.adoc create mode 100644 src/site-docs/adoc/guides/APEX-User-Manual.adoc create mode 100644 src/site-docs/adoc/guides/HowTo-APEX.adoc create mode 100644 src/site-docs/adoc/guides/HowTo-Build-APEX.adoc create mode 100644 src/site-docs/adoc/guides/HowTo-Codestyle.adoc create mode 100644 src/site-docs/adoc/guides/HowTo-Configuration.adoc create mode 100644 src/site-docs/adoc/guides/HowTo-Logging.adoc create mode 100644 src/site-docs/adoc/guides/HowTo-MyFirstPolicy.adoc create mode 100644 src/site-docs/adoc/guides/HowTo-PolicyLogic.adoc create mode 100644 src/site-docs/adoc/guides/HowTo-Websockets.adoc create mode 100644 src/site-docs/adoc/guides/Tech-APEX-PolicyModel.adoc (limited to 'src/site-docs/adoc/guides') diff --git a/src/site-docs/adoc/guides/APEX-Developer-Guide.adoc b/src/site-docs/adoc/guides/APEX-Developer-Guide.adoc new file mode 100644 index 000000000..ee54433f0 --- /dev/null +++ b/src/site-docs/adoc/guides/APEX-Developer-Guide.adoc @@ -0,0 +1,92 @@ +// +// ============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 Developer Guide +Sven van_der_Meer ; Liam Fallon ; John Keeney + +:revdate: 2017-07-31 +:revremark: for APEX {release-version} +:version-label!: +:description: A short guide to develop inside the APEX system +:keywords: APEX, documentation, development, Java +:experimental: + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 4 +:icons: font + + +== Build APEX from Source + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/introduction.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/standard.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/checkstyle.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-tests.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-all-tests.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-all-components.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/documentation.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/site.adoc[leveloffset=+1] + + +== APEX Codestyle + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/02-rules.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/10-plugin-jautodoc.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/20-configure-eclipse-templates.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/21-configure-jautodoc-templates.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/31-run-checkstyle-maven.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/32-configure-checkstyle-eclipse.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/33-configure-checkstyle-blueprint.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/41-using-jautodoc.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/42-using-checkstyle.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/50-disable-eclispe-formatting.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/51-supress-checkstyle.adoc[leveloffset=+1] + +== apex-apps.utilities + +include::{adsite-tools-common-dir}/site-docs/adoc/fragments/example-cli.adoc[leveloffset=+1] + +include::{adsite-tools-common-dir}/site-docs/adoc/fragments/example-cli-version.adoc[leveloffset=+1] + diff --git a/src/site-docs/adoc/guides/APEX-Install-Guide.adoc b/src/site-docs/adoc/guides/APEX-Install-Guide.adoc new file mode 100644 index 000000000..e3a9891b0 --- /dev/null +++ b/src/site-docs/adoc/guides/APEX-Install-Guide.adoc @@ -0,0 +1,52 @@ +// +// ============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 Installation Guide +Sven van_der_Meer ; Liam Fallon ; John Keeney + +:revdate: 2017-07-25 +:revremark: for APEX {release-version} +:version-label!: +:description: A short guide to install the APEX policy engine +:keywords: APEX, documentation, install + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 4 +:icons: font + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/requirements.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/get-source.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/build-apex.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/layout.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/configure.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/verify.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-monitoring.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-resteditor.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/docker.adoc[] diff --git a/src/site-docs/adoc/guides/APEX-Introduction.adoc b/src/site-docs/adoc/guides/APEX-Introduction.adoc new file mode 100644 index 000000000..4e50c9bdf --- /dev/null +++ b/src/site-docs/adoc/guides/APEX-Introduction.adoc @@ -0,0 +1,45 @@ +// +// ============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) +// + += A short Introduction to APEX +Sven van_der_Meer ; Liam Fallon ; John Keeney + +:revdate: 2017-09-05 +:revremark: for APEX {release-version} +:version-label!: +:description: A short introduction to the APEX policy Engine and System +:keywords: APEX, documentation, engine, applications, editors + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/introduction.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/configuration-matrix.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/policy-matrix.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/upee-deployment.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/upee-clustering.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/resources.adoc[] diff --git a/src/site-docs/adoc/guides/APEX-Policy-Guide.adoc b/src/site-docs/adoc/guides/APEX-Policy-Guide.adoc new file mode 100644 index 000000000..54913b22b --- /dev/null +++ b/src/site-docs/adoc/guides/APEX-Policy-Guide.adoc @@ -0,0 +1,83 @@ +// +// ============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 Policy Guide +Sven van_der_Meer ; Liam Fallon ; John Keeney + +:revdate: 2017-08-10 +:revremark: for APEX {release-version} +:version-label!: +:description: A short guide to Policies, including programming logic +:keywords: APEX, documentation, policy, programming, logic +:experimental: + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 4 +:icons: font + +== APEX Policy Matrix + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/policy-matrix.adoc[leveloffset=+1] + + +== APEX Policy Model + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/introduction.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concepts-keys.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-policymodel.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-datatype.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-event.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-eventfield.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-contextmap.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-contextitem.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-contextitemtemplate.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-task.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-taskparameter.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-logic.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-policy.adoc[leveloffset=+2] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-state.adoc[leveloffset=+2] + + +== Writing Logic + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/task-logic.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/task-selection-logic.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/logic-cheatsheet.adoc[leveloffset=+1] + + +== Policy Examples + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/policy-examples.adoc[leveloffset=+1] + diff --git a/src/site-docs/adoc/guides/APEX-Publications.adoc b/src/site-docs/adoc/guides/APEX-Publications.adoc new file mode 100644 index 000000000..592b2abba --- /dev/null +++ b/src/site-docs/adoc/guides/APEX-Publications.adoc @@ -0,0 +1,65 @@ +// +// ============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 Publications +Sven van_der_Meer ; Liam Fallon ; John Keeney + +:revdate: 2017-08-11 +:revremark: for APEX {release-version} +:version-label!: +:description: A list of APEX related publications +:keywords: APEX, documentation, publications, research + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/apex.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/cnsm-2015.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2016.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/im-2017a.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/im-2017b.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018a.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018c.adoc[leveloffset=+1] + + + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/policy-general.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/monami-2012.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/im-2013.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/monami-2013.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/cnsm-2014.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/5g-2015.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018b.adoc[leveloffset=+1] + + + diff --git a/src/site-docs/adoc/guides/APEX-User-Manual.adoc b/src/site-docs/adoc/guides/APEX-User-Manual.adoc new file mode 100644 index 000000000..f732c4397 --- /dev/null +++ b/src/site-docs/adoc/guides/APEX-User-Manual.adoc @@ -0,0 +1,217 @@ +// +// ============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 User Manual +Sven van_der_Meer ; Liam Fallon ; John Keeney + +:revdate: 2017-07-26 +:revremark: for APEX {release-version} +:version-label!: +:description: The comprehensive APEX User Manual +:keywords: APEX, documentation, install, configure, validate, verify, test, run, logg + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + + + +== Installation + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/requirements.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/get-source.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/build-apex.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/layout.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/configure.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/verify.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-monitoring.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-resteditor.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/docker.adoc[leveloffset=+1] + + +== APEX Configurations Explained + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-config/introduction.adoc[leveloffset=+1] + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-general-format.adoc[leveloffset=+1] + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-service-parameters.adoc[leveloffset=+1] + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-interfaces-general.adoc[leveloffset=+1] + + +include::{adsite-plugins-executor-dir}/site-docs/adoc/fragments/executors.adoc[leveloffset=+1] + +include::{adsite-plugins-executor-javascript-dir}/site-docs/adoc/fragments/javascript-config.adoc[leveloffset=+2] + +include::{adsite-plugins-executor-jython-dir}/site-docs/adoc/fragments/jython-config.adoc[leveloffset=+2] + +include::{adsite-plugins-executor-jruby-dir}/site-docs/adoc/fragments/jruby-config.adoc[leveloffset=+2] + +include::{adsite-plugins-executor-java-dir}/site-docs/adoc/fragments/java-config.adoc[leveloffset=+2] + +include::{adsite-plugins-executor-mvel-dir}/site-docs/adoc/fragments/mvel-config.adoc[leveloffset=+2] + + +include::{adsite-plugins-context-dir}/site-docs/adoc/fragments/context.adoc[leveloffset=+1] + +include::{adsite-plugins-context-schema-avro-dir}/site-docs/adoc/fragments/ctx-schema-avro-config.adoc[leveloffset=+2] + + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/carriertech.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/ct-standard-io.adoc[leveloffset=+2] + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/ct-file-io.adoc[leveloffset=+2] + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/ct-eventrequestor-io.adoc[leveloffset=+2] + +include::{adsite-plugins-event-carrier-kafka-dir}/site-docs/adoc/fragments/ct-kafka-io.adoc[leveloffset=+2] + +include::{adsite-plugins-event-carrier-jms-dir}/site-docs/adoc/fragments/ct-jms-io.adoc[leveloffset=+2] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ct-websocket-io.adoc[leveloffset=+2] + +include::{adsite-plugins-event-carrier-restclient-dir}/site-docs/adoc/fragments/ct-restclient-io.adoc[leveloffset=+2] + +include::{adsite-plugins-event-carrier-restserver-dir}/site-docs/adoc/fragments/ct-restserver-io.adoc[leveloffset=+2] + +include::{adsite-plugins-event-carrier-restrequestor-dir}/site-docs/adoc/fragments/ct-restrequestor-io.adoc[leveloffset=+2] + + +include::{adsite-plugins-event-protocol-dir}/site-docs/adoc/fragments/event-protocols.adoc[leveloffset=+1] + +include::{adsite-plugins-event-protocol-dir}/site-docs/adoc/fragments/ep-json.adoc[leveloffset=+2] + +include::{adsite-plugins-event-protocol-dir}/site-docs/adoc/fragments/ep-apex.adoc[leveloffset=+2] + +include::{adsite-plugins-event-protocol-jms-dir}/site-docs/adoc/fragments/ep-jms.adoc[leveloffset=+2] + +include::{adsite-plugins-event-protocol-yaml-dir}/site-docs/adoc/fragments/ep-yaml.adoc[leveloffset=+2] + +include::{adsite-plugins-event-protocol-xml-dir}/site-docs/adoc/fragments/ep-xml.adoc[leveloffset=+2] + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-example.adoc[leveloffset=+1] + + +== Engine and Applications of the APEX System + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/introduction.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/engine.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/cli-editor.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/rest-editor.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/eng-monitoring.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/eng-deployment.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/full-client.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/application-launcher.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/app-tpl-event-json.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/app-model-2-cli.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/app-ws.adoc[leveloffset=+1] + + +== My First Policy + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/01-introduction.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/02-data-models.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/03-policy-step1.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/031-s1-new-model.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/032-s1-new-events.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/033-s1-new-policy.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/034-s1-test-policy.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/035-s1-clieditor.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/04-policy-step2.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/041-s2-extend-model.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/042-s2-test-policy.adoc[leveloffset=+1] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/043-s2-clieditor.adoc[leveloffset=+1] + + +== APEX Logging + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/introduction.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/logback-status.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/logging-3pps.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/rolling-file-appenders.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/example-logic.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/example-server.adoc[leveloffset=+1] + + + +== Building a System with Websocket Backend + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ws-intro.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ws-java.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ws-foss.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/engine-config-bcp.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-00.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-01-vpn-wsconfig.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-02-start-engine.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-03-start-echo-client.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-04-start-console-client.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-05-send-events.adoc[leveloffset=+1] + diff --git a/src/site-docs/adoc/guides/HowTo-APEX.adoc b/src/site-docs/adoc/guides/HowTo-APEX.adoc new file mode 100644 index 000000000..6e32cf43b --- /dev/null +++ b/src/site-docs/adoc/guides/HowTo-APEX.adoc @@ -0,0 +1,55 @@ +// +// ============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 HowTo: Engine and Applications +Sven van_der_Meer + +:revdate: 2017-07-26 +:revremark: for APEX {release-version} +:version-label!: +:description: A HowTo use the APEX engine and the APEX applications +:keywords: APEX, documentation, engine, applications, editors + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/introduction.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/engine.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/cli-editor.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/rest-editor.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/eng-monitoring.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/eng-deployment.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/full-client.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/application-launcher.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/app-tpl-event-json.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/app-model-2-cli.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/app-ws.adoc[] \ No newline at end of file diff --git a/src/site-docs/adoc/guides/HowTo-Build-APEX.adoc b/src/site-docs/adoc/guides/HowTo-Build-APEX.adoc new file mode 100644 index 000000000..e7aa02472 --- /dev/null +++ b/src/site-docs/adoc/guides/HowTo-Build-APEX.adoc @@ -0,0 +1,50 @@ +// +// ============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 HowTo: Build from Source +Sven van_der_Meer + +:revdate: 2017-07-31 +:revremark: for APEX {release-version} +:version-label!: +:description: A HowTo build APEX from source +:keywords: APEX, documentation, build, Maven + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/introduction.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/standard.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/checkstyle.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-tests.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-all-tests.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-all-components.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/documentation.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/site.adoc[] + diff --git a/src/site-docs/adoc/guides/HowTo-Codestyle.adoc b/src/site-docs/adoc/guides/HowTo-Codestyle.adoc new file mode 100644 index 000000000..f84a64662 --- /dev/null +++ b/src/site-docs/adoc/guides/HowTo-Codestyle.adoc @@ -0,0 +1,65 @@ +// +// ============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 HowTo: Codestyle for Java Projects +Liam Fallon , Sven van_der_Meer + +:revdate: 2017-07-31 +:revremark: for APEX {release-version} +:version-label!: +:description: A HowTo on codestyle and Eclipse/Maven configuration for checks +:keywords: APEX, documentation, codestyle, javadoc, codecheck, jautodoc, Eclipse, Maven +:experimental: + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/02-rules.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/10-plugin-jautodoc.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/20-configure-eclipse-templates.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/21-configure-jautodoc-templates.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/31-run-checkstyle-maven.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/32-configure-checkstyle-eclipse.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/33-configure-checkstyle-blueprint.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/41-using-jautodoc.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/42-using-checkstyle.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/50-disable-eclispe-formatting.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/51-supress-checkstyle.adoc[] + \ No newline at end of file diff --git a/src/site-docs/adoc/guides/HowTo-Configuration.adoc b/src/site-docs/adoc/guides/HowTo-Configuration.adoc new file mode 100644 index 000000000..c766aaaa3 --- /dev/null +++ b/src/site-docs/adoc/guides/HowTo-Configuration.adoc @@ -0,0 +1,96 @@ +// +// ============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 HowTo: Configuration +Sven van_der_Meer + +:revdate: 2017-07-25 +:revremark: for APEX {release-version} +:version-label!: +:description: A HowTo configure APEX +:keywords: APEX, documentation, configuration + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-config/introduction.adoc[] + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-general-format.adoc[] + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-service-parameters.adoc[] + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-interfaces-general.adoc[] + + +include::{adsite-plugins-executor-dir}/site-docs/adoc/fragments/executors.adoc[] + +include::{adsite-plugins-executor-javascript-dir}/site-docs/adoc/fragments/javascript-config.adoc[leveloffset=+1] + +include::{adsite-plugins-executor-jython-dir}/site-docs/adoc/fragments/jython-config.adoc[leveloffset=+1] + +include::{adsite-plugins-executor-jruby-dir}/site-docs/adoc/fragments/jruby-config.adoc[leveloffset=+1] + +include::{adsite-plugins-executor-java-dir}/site-docs/adoc/fragments/java-config.adoc[leveloffset=+1] + +include::{adsite-plugins-executor-mvel-dir}/site-docs/adoc/fragments/mvel-config.adoc[leveloffset=+1] + + +include::{adsite-plugins-context-dir}/site-docs/adoc/fragments/context.adoc[] + +include::{adsite-plugins-context-schema-avro-dir}/site-docs/adoc/fragments/ctx-schema-avro-config.adoc[leveloffset=+1] + + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/carriertech.adoc[] + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/ct-standard-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/ct-file-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/ct-eventrequestor-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-kafka-dir}/site-docs/adoc/fragments/ct-kafka-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-jms-dir}/site-docs/adoc/fragments/ct-jms-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ct-websocket-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-restclient-dir}/site-docs/adoc/fragments/ct-restclient-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-restserver-dir}/site-docs/adoc/fragments/ct-restserver-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-restrequestor-dir}/site-docs/adoc/fragments/ct-restrequestor-io.adoc[leveloffset=+1] + + +include::{adsite-plugins-event-protocol-dir}/site-docs/adoc/fragments/event-protocols.adoc[] + +include::{adsite-plugins-event-protocol-dir}/site-docs/adoc/fragments/ep-json.adoc[leveloffset=+1] + +include::{adsite-plugins-event-protocol-dir}/site-docs/adoc/fragments/ep-apex.adoc[leveloffset=+1] + +include::{adsite-plugins-event-protocol-jms-dir}/site-docs/adoc/fragments/ep-jms.adoc[leveloffset=+1] + +include::{adsite-plugins-event-protocol-yaml-dir}/site-docs/adoc/fragments/ep-yaml.adoc[leveloffset=+1] + +include::{adsite-plugins-event-protocol-xml-dir}/site-docs/adoc/fragments/ep-xml.adoc[leveloffset=+1] + + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-example.adoc[] + diff --git a/src/site-docs/adoc/guides/HowTo-Logging.adoc b/src/site-docs/adoc/guides/HowTo-Logging.adoc new file mode 100644 index 000000000..4a86813e5 --- /dev/null +++ b/src/site-docs/adoc/guides/HowTo-Logging.adoc @@ -0,0 +1,50 @@ +// +// ============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 HowTo: Logging +Sven van_der_Meer + +:revdate: 2017-07-25 +:revremark: for APEX {release-version} +:version-label!: +:description: A HowTo configure APEX logging +:keywords: APEX, documentation, logging, SLF4j + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/introduction.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/logback-status.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/logging-3pps.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/rolling-file-appenders.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/example-logic.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/example-server.adoc[] + diff --git a/src/site-docs/adoc/guides/HowTo-MyFirstPolicy.adoc b/src/site-docs/adoc/guides/HowTo-MyFirstPolicy.adoc new file mode 100644 index 000000000..8f1ec7e2f --- /dev/null +++ b/src/site-docs/adoc/guides/HowTo-MyFirstPolicy.adoc @@ -0,0 +1,63 @@ +// +// ============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 HowTo: My First Policy +John Keeney , Liam Fallon , Sven van_der_Meer + +:revdate: 2017-08-09 +:revremark: for APEX {release-version} +:version-label!: +:description: A short guide to create a sample policy for APEX +:keywords: APEX, documentation, sample, my first policy +:experimental: + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:coderay-linenums-mode: table +:pygments-linenums-mode: table +:source-highlighter: coderay +:toc: + +:toclevels: 5 +:icons: font + + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/01-introduction.adoc[] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/02-data-models.adoc[] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/03-policy-step1.adoc[] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/031-s1-new-model.adoc[] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/032-s1-new-events.adoc[] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/033-s1-new-policy.adoc[] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/034-s1-test-policy.adoc[] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/035-s1-clieditor.adoc[] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/04-policy-step2.adoc[] + + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/041-s2-extend-model.adoc[] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/042-s2-test-policy.adoc[] + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/043-s2-clieditor.adoc[] + diff --git a/src/site-docs/adoc/guides/HowTo-PolicyLogic.adoc b/src/site-docs/adoc/guides/HowTo-PolicyLogic.adoc new file mode 100644 index 000000000..e5c6a250f --- /dev/null +++ b/src/site-docs/adoc/guides/HowTo-PolicyLogic.adoc @@ -0,0 +1,44 @@ +// +// ============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 HowTo: Policy Logic +John Keeney + +:revdate: 2017-08-10 +:revremark: for APEX {release-version} +:version-label!: +:description: A HowTo write policy logic +:keywords: APEX, documentation, policy, logic, task, task selection + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/task-logic.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/task-selection-logic.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/logic-cheatsheet.adoc[] + +== Policy Examples + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/policy-examples.adoc[leveloffset=+1] + diff --git a/src/site-docs/adoc/guides/HowTo-Websockets.adoc b/src/site-docs/adoc/guides/HowTo-Websockets.adoc new file mode 100644 index 000000000..03c770942 --- /dev/null +++ b/src/site-docs/adoc/guides/HowTo-Websockets.adoc @@ -0,0 +1,54 @@ +// +// ============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 HowTo: Websockets +Sven van_der_Meer + +:revdate: 2017-07-25 +:revremark: for APEX {release-version} +:version-label!: +:description: A HowTo connect Websocket Consumer and Producer to APEX +:keywords: APEX, documentation, Websocket + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + + + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ws-intro.adoc[] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ws-java.adoc[] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ws-foss.adoc[] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/engine-config-bcp.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-00.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-01-vpn-wsconfig.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-02-start-engine.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-03-start-echo-client.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-04-start-console-client.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-05-send-events.adoc[] diff --git a/src/site-docs/adoc/guides/Tech-APEX-PolicyModel.adoc b/src/site-docs/adoc/guides/Tech-APEX-PolicyModel.adoc new file mode 100644 index 000000000..8ae92674a --- /dev/null +++ b/src/site-docs/adoc/guides/Tech-APEX-PolicyModel.adoc @@ -0,0 +1,62 @@ +// +// ============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 Policy Model +Sven van_der_Meer ; Liam Fallon ; John Keeney + +:revdate: 2017-09-05 +:revremark: for APEX {release-version} +:version-label!: +:description: The APEX Policy Model +:keywords: APEX, documentation, engine, policy model + +Version: {release-version} + +Version Date: {revdate} + +Version Notes: {revremark} + +:pygments-linenums-mode: table +:toc: +:toclevels: 5 +:icons: font + + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/introduction.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concepts-keys.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-policymodel.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-datatype.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-event.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-eventfield.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-contextmap.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-contextitem.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-contextitemtemplate.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-task.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-taskparameter.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-logic.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-policy.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-state.adoc[] + -- cgit 1.2.3-korg