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 2021/11/27 05:59:37 UTC
[syncope] 02/02: Fixing refs in the docs
This is an automated email from the ASF dual-hosted git repository.
ilgrosso pushed a commit to branch 2_1_X
in repository https://gitbox.apache.org/repos/asf/syncope.git
commit bb6d1f736d3d9ecd5eaa6304a17e797548365ff6
Author: Francesco Chicchiriccò <il...@apache.org>
AuthorDate: Sat Nov 27 06:59:24 2021 +0100
Fixing refs in the docs
---
.../reference-guide/architecture/core.adoc | 2 +-
.../asciidoc/reference-guide/concepts/domains.adoc | 2 +-
.../reference-guide/concepts/entitlements.adoc | 4 ++--
.../reference-guide/concepts/extensions.adoc | 2 +-
.../concepts/provisioning/pull.adoc | 4 ++--
.../workingwithapachesyncope/restfulservices.adoc | 12 ++++++-----
src/site/xdoc/mailing-lists.xml | 25 ++--------------------
7 files changed, 16 insertions(+), 35 deletions(-)
diff --git a/src/main/asciidoc/reference-guide/architecture/core.adoc b/src/main/asciidoc/reference-guide/architecture/core.adoc
index f4aa66e..8e6f1ee 100644
--- a/src/main/asciidoc/reference-guide/architecture/core.adoc
+++ b/src/main/asciidoc/reference-guide/architecture/core.adoc
@@ -90,7 +90,7 @@ All data (users, groups, attributes, resources, ...) is internally managed at a
https://en.wikipedia.org/wiki/Java_Persistence_API[JPA 2.2^] approach based on http://openjpa.apache.org[Apache OpenJPA^].
The data is persisted into an underlying
database, referred to as *_Internal Storage_*. Consistency is ensured via the comprehensive
-https://docs.spring.io/spring/docs/5.1.x/spring-framework-reference/data-access.html#transaction[transaction management^]
+https://docs.spring.io/spring-framework/docs/5.2.x/spring-framework-reference/data-access.html#transaction[transaction management^]
provided by the Spring Framework.
Globally, this offers the ability to easily scale up to a million entities and at the same time allows great portability
diff --git a/src/main/asciidoc/reference-guide/concepts/domains.adoc b/src/main/asciidoc/reference-guide/concepts/domains.adoc
index 9ffdbd3..80792fa 100644
--- a/src/main/asciidoc/reference-guide/concepts/domains.adoc
+++ b/src/main/asciidoc/reference-guide/concepts/domains.adoc
@@ -22,7 +22,7 @@ Domains are built to facilitate https://en.wikipedia.org/wiki/Multitenancy[multi
Domains allow the physical separation of all data managed by Apache Syncope, by storing the data for different domains
into different database instances. Therefore, Apache Syncope can facilitate Users, Groups, Any Objects,
-External Resources, Policies, Tasks, etc. from different domains (e.g. tenants) in a single <<core,core>> instance.
+External Resources, Policies, Tasks, etc. from different domains (e.g. tenants) in a single <<core>> instance.
By default, a single `Master` domain is defined, which also bears the configuration for additional domains.
diff --git a/src/main/asciidoc/reference-guide/concepts/entitlements.adoc b/src/main/asciidoc/reference-guide/concepts/entitlements.adoc
index c2a0dfa..52d972a 100644
--- a/src/main/asciidoc/reference-guide/concepts/entitlements.adoc
+++ b/src/main/asciidoc/reference-guide/concepts/entitlements.adoc
@@ -21,7 +21,7 @@
Entitlements are basically strings describing the right to perform an operation on Syncope.
The components in the <<logic,logic layer>> are annotated with
-http://projects.spring.io/spring-security/[Spring Security^] to implement declarative security; in the following
+https://spring.io/projects/spring-security[Spring Security^] to implement declarative security; in the following
code snippet taken from
ifeval::["{snapshotOrRelease}" == "release"]
https://github.com/apache/syncope/blob/syncope-{docVersion}/core/logic/src/main/java/org/apache/syncope/core/logic/RealmLogic.java[RealmLogic^]
@@ -30,7 +30,7 @@ ifeval::["{snapshotOrRelease}" == "snapshot"]
https://github.com/apache/syncope/blob/2_1_X/core/logic/src/main/java/org/apache/syncope/core/logic/RealmLogic.java[RealmLogic^]
endif::[]
, the
-http://docs.spring.io/spring-security/site/docs/4.2.x/reference/htmlsingle/#el-common-built-in[`hasRole` expression^]
+https://docs.spring.io/spring-security/site/docs/5.2.x/reference/html5/#el-common-built-in[`hasRole` expression^]
is used together with one of the standard entitlements to restrict access only to Users owning the `REALM_LIST`
entitlement.
diff --git a/src/main/asciidoc/reference-guide/concepts/extensions.adoc b/src/main/asciidoc/reference-guide/concepts/extensions.adoc
index 44a222e..f1c7742 100644
--- a/src/main/asciidoc/reference-guide/concepts/extensions.adoc
+++ b/src/main/asciidoc/reference-guide/concepts/extensions.adoc
@@ -155,7 +155,7 @@ This extension provides an alternate internal search engine for <<users-groups-a
https://www.elastic.co/[Elasticsearch^] cluster.
[WARNING]
-This extension supports Elasticsearch server versions starting from 6.x.
+This extension supports Elasticsearch server versions starting from 7.x.
[TIP]
As search operations are central for different aspects of the <<provisioning,provisioning process>>, the global
diff --git a/src/main/asciidoc/reference-guide/concepts/provisioning/pull.adoc b/src/main/asciidoc/reference-guide/concepts/provisioning/pull.adoc
index 4c6fa43..38b50c1 100644
--- a/src/main/asciidoc/reference-guide/concepts/provisioning/pull.adoc
+++ b/src/main/asciidoc/reference-guide/concepts/provisioning/pull.adoc
@@ -60,10 +60,10 @@ The Identity Store can be queried in different ways, depending on the _pull mode
FULL RECONCILIATION:: The complete list of entities available is processed.
FILTERED RECONCILIATION:: The subset matching the filter (provided by the selected implementation of
ifeval::["{snapshotOrRelease}" == "release"]
-https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/pushpull/ReconciliationFilterBuilder.java[ReconciliationFilterBuilder^])
+https://github.com/apache/syncope/blob/syncope-{docVersion}/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/pushpull/ReconFilterBuilder.java[ReconFilterBuilder^])
endif::[]
ifeval::["{snapshotOrRelease}" == "snapshot"]
-https://github.com/apache/syncope/blob/2_1_X/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/pushpull/ReconciliationFilterBuilder.java[ReconciliationFilterBuilder^])
+https://github.com/apache/syncope/blob/2_1_X/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/pushpull/ReconFilterBuilder.java[ReconFilterBuilder^])
endif::[]
of all available entities is processed.
INCREMENTAL:: Only the actual modifications performed since the last pull task execution are considered. This mode
diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices.adoc
index c9bdbec..93a0235 100644
--- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices.adoc
+++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices.adoc
@@ -46,7 +46,7 @@ The <<swagger,Swagger extension>> might also help greatly when working with REST
==== REST Authentication and Authorization
-The <<core>> authentication and authorization is based on http://projects.spring.io/spring-security/[Spring Security^].
+The <<core>> authentication and authorization is based on https://spring.io/projects/spring-security[Spring Security^].
As an initial step, authentication is required to obtain, in the `X-Syncope-Token` HTTP header, the
unique signed https://en.wikipedia.org/wiki/JSON_Web_Token[JSON Web Token^] to include in all subsequent requests.
@@ -94,7 +94,7 @@ The set of RESTful services provided by Apache Syncope can be divided as:
. endpoints disclosing information about the given Syncope deployment (available <<schema,schema>>, configured
<<extensions,extensions>>, Groups, ...), requiring some sort of shared authentication defined by the
`anonymousKey` value in the `security.properties` file - for more information, read about Spring Security's
-http://docs.spring.io/spring-security/site/docs/4.2.x/reference/htmlsingle/#anonymous[Anonymous Authentication^];
+https://docs.spring.io/spring-security/site/docs/5.2.x/reference/html5/#anonymous[Anonymous Authentication^];
. endpoints for self-service (self-update, password change, ...), requiring user authentication and no entitlements;
. endpoints for administrative operations, requiring user authentication with authorization granted by the related
<<entitlements,entitlements>>, handed over to users via <<roles,roles>>.
@@ -649,8 +649,8 @@ int count = userService.search(new AnyQuery.Builder().page(0).size(0).build()).g
PagedResult<UserTO> matchingUsers = userService.search(
new AnyQuery.Builder().realm(SyncopeConstants.ROOT_REALM).
- fiql(SyncopeClient.getUserSearchConditionBuilder().is("username").equalTo("ros*ini").query()).
- build()); // <2>
+ fiql(SyncopeClient.getUserSearchConditionBuilder().is("username").
+ equalTo("ros*ini").query()).build()); // <2>
PagedResult<UserTO> matchingUsers = userService.search(
new AnyQuery.Builder().realm(SyncopeConstants.ROOT_REALM).
@@ -721,12 +721,14 @@ List<BatchResponseItem> batchResponseItems = batchResponse.getItems(); // <6>
====
[source,java]
----
-Pair<Map<String, Set<String>>, UserTO> self = client.self();
+Triple<Map<String, Set<String>>, List<String>, UserTO> self = client.self();
UserTO userTO = self.getRight(); // <1>
Map<String, Set<String>> realm2entitlements = self.getLeft(); // <2>
+List<String> delegations = self.getMiddle(); // <3>
----
<1> http://syncope.apache.org/apidocs/2.1/org/apache/syncope/common/lib/to/UserTO.html[UserTO^] of the requesting user
<2> for each <<realms,realm>>, the owned <<entitlements,entitlements>>
+<3> <<delegation,delegations>> assigned to the requesting user
====
.Change user status
diff --git a/src/site/xdoc/mailing-lists.xml b/src/site/xdoc/mailing-lists.xml
index 1fb8845..9046a34 100644
--- a/src/site/xdoc/mailing-lists.xml
+++ b/src/site/xdoc/mailing-lists.xml
@@ -56,16 +56,6 @@ under the License.
<a href="http://syncope.markmail.org/">syncope.markmail.org</a>
</td>
</tr>
- <tr class="a">
- <td>-</td>
- <td>-</td>
- <td>-</td>
- <td>-</td>
- <td>-</td>
- <td>
- <a href="http://syncope-user.1051894.n5.nabble.com/">syncope-user.1051894.n5.nabble.com</a>
- </td>
- </tr>
<tr class="b">
<td>-</td>
<td>-</td>
@@ -94,16 +84,6 @@ under the License.
<a href="http://syncope.markmail.org/">syncope.markmail.org</a>
</td>
</tr>
- <tr class="b">
- <td>-</td>
- <td>-</td>
- <td>-</td>
- <td>-</td>
- <td>-</td>
- <td>
- <a href="http://syncope-dev.1063484.n5.nabble.com/">syncope-dev.1063484.n5.nabble.com</a>
- </td>
- </tr>
<tr class="a">
<td>-</td>
<td>-</td>
@@ -156,11 +136,10 @@ under the License.
<section name="IRC">
<p>
- Join the <strong>#apache-syncope</strong> channel on FreeNode.
+ Join the <strong>#apache-syncope</strong> channel on <a href="https://libera.chat/">Libera.Chat</a>.
</p>
<p>
- Communication archives are <a href="http://wilderness.apache.org/channels/#logs-%23apache-syncope">available</a>
- for reference.
+ Join the <strong>#syncope</strong> channel on <a href="https://the-asf.slack.com/archives/CEUPMC04T">Slack</a>.
</p>
</section>
</body>