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 --- .../configuration/um-00-introduction.adoc | 14 ++++++++++ .../configuration/um-01-config-general-format.adoc | 14 ++++++++++ .../um-02-config-service-parameters.adoc | 14 ++++++++++ .../um-03-config-interfaces-general.adoc | 14 ++++++++++ .../user-manual/configuration/um-04-executors.adoc | 24 ++++++++++++++++ .../user-manual/configuration/um-05-context.adoc | 16 +++++++++++ .../configuration/um-06-carriertech.adoc | 32 ++++++++++++++++++++++ .../configuration/um-07-eventprotols.adoc | 24 ++++++++++++++++ .../configuration/um-99-config-example.adoc | 14 ++++++++++ 9 files changed, 166 insertions(+) create mode 100644 src/site/asciidoc/user-manual/configuration/um-00-introduction.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-01-config-general-format.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-02-config-service-parameters.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-03-config-interfaces-general.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-04-executors.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-05-context.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-06-carriertech.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-07-eventprotols.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-99-config-example.adoc (limited to 'src/site/asciidoc/user-manual/configuration') diff --git a/src/site/asciidoc/user-manual/configuration/um-00-introduction.adoc b/src/site/asciidoc/user-manual/configuration/um-00-introduction.adoc new file mode 100644 index 000000000..6c8b9a5f2 --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-00-introduction.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-config/introduction.adoc[] diff --git a/src/site/asciidoc/user-manual/configuration/um-01-config-general-format.adoc b/src/site/asciidoc/user-manual/configuration/um-01-config-general-format.adoc new file mode 100644 index 000000000..4401f4c06 --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-01-config-general-format.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-general-format.adoc[] diff --git a/src/site/asciidoc/user-manual/configuration/um-02-config-service-parameters.adoc b/src/site/asciidoc/user-manual/configuration/um-02-config-service-parameters.adoc new file mode 100644 index 000000000..b12c84a7d --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-02-config-service-parameters.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-service-parameters.adoc[] \ No newline at end of file diff --git a/src/site/asciidoc/user-manual/configuration/um-03-config-interfaces-general.adoc b/src/site/asciidoc/user-manual/configuration/um-03-config-interfaces-general.adoc new file mode 100644 index 000000000..d82894de7 --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-03-config-interfaces-general.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-interfaces-general.adoc[] \ No newline at end of file diff --git a/src/site/asciidoc/user-manual/configuration/um-04-executors.adoc b/src/site/asciidoc/user-manual/configuration/um-04-executors.adoc new file mode 100644 index 000000000..82e34746f --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-04-executors.adoc @@ -0,0 +1,24 @@ +// +// ============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) +// + +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] diff --git a/src/site/asciidoc/user-manual/configuration/um-05-context.adoc b/src/site/asciidoc/user-manual/configuration/um-05-context.adoc new file mode 100644 index 000000000..099639d27 --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-05-context.adoc @@ -0,0 +1,16 @@ +// +// ============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) +// + +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] diff --git a/src/site/asciidoc/user-manual/configuration/um-06-carriertech.adoc b/src/site/asciidoc/user-manual/configuration/um-06-carriertech.adoc new file mode 100644 index 000000000..316d88d3e --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-06-carriertech.adoc @@ -0,0 +1,32 @@ +// +// ============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) +// + +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] diff --git a/src/site/asciidoc/user-manual/configuration/um-07-eventprotols.adoc b/src/site/asciidoc/user-manual/configuration/um-07-eventprotols.adoc new file mode 100644 index 000000000..cdb0df80c --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-07-eventprotols.adoc @@ -0,0 +1,24 @@ +// +// ============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) +// + +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] diff --git a/src/site/asciidoc/user-manual/configuration/um-99-config-example.adoc b/src/site/asciidoc/user-manual/configuration/um-99-config-example.adoc new file mode 100644 index 000000000..d429d2fb6 --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-99-config-example.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-example.adoc[] \ No newline at end of file -- cgit 1.2.3-korg