You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by il...@apache.org on 2017/10/10 06:37:07 UTC
[18/18] syncope git commit: [SYNCOPE-956] Updating docs
[SYNCOPE-956] Updating docs
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/f08a17b1
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/f08a17b1
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/f08a17b1
Branch: refs/heads/master
Commit: f08a17b1b8b619390556b229f293ee53d0d85527
Parents: 2ebcff2
Author: Francesco Chicchiriccò <il...@apache.org>
Authored: Tue Oct 3 13:48:33 2017 +0200
Committer: Francesco Chicchiriccò <il...@apache.org>
Committed: Tue Oct 10 08:34:14 2017 +0200
----------------------------------------------------------------------
.../reference-guide/concepts/concepts.adoc | 2 ++
.../concepts/implementations.adoc | 28 ++++++++++++++++++++
.../reference-guide/concepts/policies.adoc | 2 +-
.../concepts/provisioning/propagation.adoc | 2 +-
.../concepts/provisioning/pull.adoc | 2 +-
.../concepts/provisioning/push.adoc | 2 +-
.../reference-guide/concepts/realms.adoc | 2 +-
.../workingwithapachesyncope/customization.adoc | 4 +--
8 files changed, 37 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/f08a17b1/src/main/asciidoc/reference-guide/concepts/concepts.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/concepts/concepts.adoc b/src/main/asciidoc/reference-guide/concepts/concepts.adoc
index 8aff5b7..b5ac17d 100644
--- a/src/main/asciidoc/reference-guide/concepts/concepts.adoc
+++ b/src/main/asciidoc/reference-guide/concepts/concepts.adoc
@@ -46,4 +46,6 @@ include::audit.adoc[]
include::domains.adoc[]
+include::implementations.adoc[]
+
include::extensions.adoc[]
http://git-wip-us.apache.org/repos/asf/syncope/blob/f08a17b1/src/main/asciidoc/reference-guide/concepts/implementations.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/concepts/implementations.adoc b/src/main/asciidoc/reference-guide/concepts/implementations.adoc
new file mode 100644
index 0000000..7737359
--- /dev/null
+++ b/src/main/asciidoc/reference-guide/concepts/implementations.adoc
@@ -0,0 +1,28 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+=== Implementations
+
+Starting with Apache Syncope 2.1, it is possible to provide implementations suitable for <<customization,customization>>
+as:
+
+. Java classes
+. http://www.groovy-lang.org/[Groovy^] classes
+
+While the former shows some advantages about execution performance, the latter is extremely useful as it allows for
+runtime updates, freeing from the hassle to redeploy when something needs to be changed.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/f08a17b1/src/main/asciidoc/reference-guide/concepts/policies.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/concepts/policies.adoc b/src/main/asciidoc/reference-guide/concepts/policies.adoc
index 694bfa4..e842834 100644
--- a/src/main/asciidoc/reference-guide/concepts/policies.adoc
+++ b/src/main/asciidoc/reference-guide/concepts/policies.adoc
@@ -256,7 +256,7 @@ according to the available <<mapping,mapping>>.
[TIP]
====
-Custom pull correlation rules can be provided by implementing the
+Custom pull correlation rules can be provided by <<implementations,implementing>> the
ifeval::["{snapshotOrRelease}" == "release"]
https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/pushpull/PullCorrelationRule.java[PullCorrelationRule^]
endif::[]
http://git-wip-us.apache.org/repos/asf/syncope/blob/f08a17b1/src/main/asciidoc/reference-guide/concepts/provisioning/propagation.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/concepts/provisioning/propagation.adoc b/src/main/asciidoc/reference-guide/concepts/provisioning/propagation.adoc
index 9c066f1..afba13f 100644
--- a/src/main/asciidoc/reference-guide/concepts/provisioning/propagation.adoc
+++ b/src/main/asciidoc/reference-guide/concepts/provisioning/propagation.adoc
@@ -65,7 +65,7 @@ interface can be provided, in case the required behavior does not fit into the p
===== PropagationActions
The propagation process can be decorated with custom logic to be invoked around task execution, by associating
-external resources to one or more implementations of the
+external resources to one or more <<implementations,implementations>> of the
ifeval::["{snapshotOrRelease}" == "release"]
https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/propagation/PropagationActions.java[PropagationActions^]
endif::[]
http://git-wip-us.apache.org/repos/asf/syncope/blob/f08a17b1/src/main/asciidoc/reference-guide/concepts/provisioning/pull.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/concepts/provisioning/pull.adoc b/src/main/asciidoc/reference-guide/concepts/provisioning/pull.adoc
index 8f5f9c7..2a7813e 100644
--- a/src/main/asciidoc/reference-guide/concepts/provisioning/pull.adoc
+++ b/src/main/asciidoc/reference-guide/concepts/provisioning/pull.adoc
@@ -89,7 +89,7 @@ further modification in Apache Syncope to such Users will be <<propagation,propa
===== PullActions
The pull process can be decorated with custom logic to be invoked around task execution, by associating
-pull tasks to one or more implementations of the
+pull tasks to one or more <<implementations,implementations>> of the
ifeval::["{snapshotOrRelease}" == "release"]
https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/pushpull/PullActions.java[PullActions^]
endif::[]
http://git-wip-us.apache.org/repos/asf/syncope/blob/f08a17b1/src/main/asciidoc/reference-guide/concepts/provisioning/push.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/concepts/provisioning/push.adoc b/src/main/asciidoc/reference-guide/concepts/provisioning/push.adoc
index 30f3fd4..03d3705 100644
--- a/src/main/asciidoc/reference-guide/concepts/provisioning/push.adoc
+++ b/src/main/asciidoc/reference-guide/concepts/provisioning/push.adoc
@@ -54,7 +54,7 @@ by default, unmatching entities are pushed to Identity Stores, and matching enti
===== PushActions
The push process can be decorated with custom logic to be invoked around task execution, by associating
-push tasks to one or more implementations of the
+push tasks to one or more <<implementations,implementations>> of the
ifeval::["{snapshotOrRelease}" == "release"]
https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/pushpull/PushActions.java[PushActions^]
endif::[]
http://git-wip-us.apache.org/repos/asf/syncope/blob/f08a17b1/src/main/asciidoc/reference-guide/concepts/realms.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/concepts/realms.adoc b/src/main/asciidoc/reference-guide/concepts/realms.adoc
index 3742dcf..b79d075 100644
--- a/src/main/asciidoc/reference-guide/concepts/realms.adoc
+++ b/src/main/asciidoc/reference-guide/concepts/realms.adoc
@@ -74,7 +74,7 @@ with LDAP and Active Directory.
==== LogicActions
When Users, Groups or Any Objects get created, updated or deleted in a realm, custom logic can be invoked by
-associating the given realm with one or more implementations of the
+associating the given realm with one or more <<implementations,implementations>> of the
ifeval::["{snapshotOrRelease}" == "release"]
https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/LogicActions.java[LogicActions^]
endif::[]
http://git-wip-us.apache.org/repos/asf/syncope/blob/f08a17b1/src/main/asciidoc/reference-guide/workingwithapachesyncope/customization.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/customization.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/customization.adoc
index b7c9b57..be9ed94 100644
--- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/customization.adoc
+++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/customization.adoc
@@ -177,8 +177,8 @@ When providing custom Java classes implementing the defined interfaces or extend
implementations, their package *must* be rooted under `org.apache.syncope.core`, otherwise they will not be available
at runtime.
-Besides replacing existing classes as explained <<override-behavior,above>>, new implementations can be provided under
-`core/src/main/java` for the following components:
+Besides replacing existing classes as explained <<override-behavior,above>>, new <<implementations,implementations>> can
+be provided - under `core/src/main/java` if Java - for the following components:
* <<propagationactions,propagation>>, <<pushactions,push>>, <<pullactions,pull>> and <<logicactions,logic>> actions
* <<push-correlation-rules,push>> / <<pull-correlation-rules,pull>> correlation rules