syncope-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ilgro...@apache.org
Subject [syncope] 02/02: [SYNCOPE-1395] Adding docs
Date Fri, 16 Nov 2018 11:13:17 GMT
This is an automated email from the ASF dual-hosted git repository.

ilgrosso pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/syncope.git

commit 7520d15c8a617a0d20c4a5a3fe4d70c27025ce11
Author: Francesco Chicchiriccò <ilgrosso@apache.org>
AuthorDate: Fri Nov 16 12:12:32 2018 +0100

    [SYNCOPE-1395] Adding docs
---
 core/persistence-jpa-pgjsonb/pom.xml               |  2 +-
 .../src/main/resources/persistence-enhance.xml     | 31 ++++++++
 .../systemadministration/dbms.adoc                 | 91 +++++++++++++++++++---
 3 files changed, 113 insertions(+), 11 deletions(-)

diff --git a/core/persistence-jpa-pgjsonb/pom.xml b/core/persistence-jpa-pgjsonb/pom.xml
index 34426f5..a51caba 100644
--- a/core/persistence-jpa-pgjsonb/pom.xml
+++ b/core/persistence-jpa-pgjsonb/pom.xml
@@ -92,7 +92,7 @@ under the License.
           </dependency>
         </dependencies>
         <configuration>
-          <persistenceXmlFile>${project.basedir}/../persistence-jpa/src/main/resources/persistence-enhance.xml</persistenceXmlFile>

+          <persistenceXmlFile>src/main/resources/persistence-enhance.xml</persistenceXmlFile>

           <includes>org/apache/syncope/core/persistence/jpa/entity/**/*.class</includes>
           <connectionDriverName>org.springframework.jdbc.datasource.DriverManagerDataSource</connectionDriverName>
           <connectionProperties>
diff --git a/core/persistence-jpa-pgjsonb/src/main/resources/persistence-enhance.xml b/core/persistence-jpa-pgjsonb/src/main/resources/persistence-enhance.xml
new file mode 100644
index 0000000..718f229
--- /dev/null
+++ b/core/persistence-jpa-pgjsonb/src/main/resources/persistence-enhance.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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.
+-->
+<persistence xmlns="http://java.sun.com/xml/ns/persistence"
+             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+             xsi:schemaLocation="http://java.sun.com/xml/ns/persistence
+                                 http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd"
+             version="2.0">
+  
+  <persistence-unit name="Master">
+    <mapping-file>META-INF/spring-orm-pgjsonb.xml</mapping-file>
+    <validation-mode>NONE</validation-mode>
+  </persistence-unit>
+  
+</persistence>
diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/dbms.adoc
b/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/dbms.adoc
index d72113d..a1d1672 100644
--- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/dbms.adoc
+++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/dbms.adoc
@@ -27,14 +27,14 @@ updated.
 [NOTE]
 Apache Syncope {docVersion} is verified with PostgreSQL server >= 10.3 and JDBC driver
>= {postgresqlJDBC}.
 
-In `provisioning.properties`:
+In `provisioning.properties`, replace as follows:
 
 ....
 quartz.jobstore=org.quartz.impl.jdbcjobstore.PostgreSQLDelegate
 quartz.sql=tables_postgres.sql
 ....
 
-In `domains/Master.properties` (for the `Master` domain):
+In `domains/Master.properties` (for the `Master` domain), replace as follows:
 
 ....
 Master.driverClassName=org.postgresql.Driver
@@ -59,12 +59,83 @@ https://github.com/apache/syncope/tree/master/fit/core-reference/src/main/resour
 endif::[]
 and save it under `core/src/main/resources/`.
 
+===== PostgreSQL (JSONB)
+
+[NOTE]
+With the configurations reported below, Apache Syncope will leverage the
+https://www.postgresql.org/docs/current/datatype-json.html[JSONB^] column type for attribute
storage.
+
+[NOTE]
+Apache Syncope {docVersion} is verified with PostgreSQL server >= 10.3 and JDBC driver
>= {postgresqlJDBC}.
+
+In `persistence.properties`, replace as follows:
+
+....
+entity.factory=org.apache.syncope.core.persistence.jpa.entity.PGJPAEntityFactory
+plainSchema.dao=org.apache.syncope.core.persistence.jpa.dao.PGJPAPlainSchemaDAO
+plainAttr.dao=org.apache.syncope.core.persistence.jpa.dao.PGJPAPlainAttrDAO
+plainAttrValue.dao=org.apache.syncope.core.persistence.jpa.dao.PGJPAPlainAttrValueDAO
+any.search.dao=org.apache.syncope.core.persistence.jpa.dao.PGJPAAnySearchDAO
+user.dao=org.apache.syncope.core.persistence.jpa.dao.PGJPAUserDAO
+group.dao=org.apache.syncope.core.persistence.jpa.dao.PGJPAGroupDAO
+anyObject.dao=org.apache.syncope.core.persistence.jpa.dao.PGJPAAnyObjectDAO
+conf.dao=org.apache.syncope.core.persistence.jpa.dao.PGJPAConfDAO
+....
+
+In `provisioning.properties`, replace as follows:
+
+....
+quartz.jobstore=org.quartz.impl.jdbcjobstore.PostgreSQLDelegate
+quartz.sql=tables_postgres.sql
+....
+
+In `domains/Master.properties` (for the `Master` domain), replace as follows:
+
+....
+Master.driverClassName=org.postgresql.Driver
+Master.url=jdbc:postgresql://localhost:5432/syncope?stringtype=unspecified
+Master.schema=
+Master.username=syncope
+Master.password=syncope
+Master.databasePlatform=org.apache.openjpa.jdbc.sql.PostgresDictionary
+Master.orm=META-INF/spring-orm-pgjsonb.xml
+....
+
+[WARNING]
+This assumes that you have a PostgreSQL instance running on localhost, listening on its default
port 5432 with a
+database `syncope` fully accessible by user `syncope` with password `syncope`.
+
+Download
+ifeval::["{snapshotOrRelease}" == "release"]
+https://github.com/apache/syncope/blob/syncope-{docVersion}/fit/core-reference/src/main/resources/pgjsonb/indexes.xml[indexes.xml^]
+endif::[]
+ifeval::["{snapshotOrRelease}" == "snapshot"]
+https://github.com/apache/syncope/tree/master/fit/core-reference/src/main/resources/pgjsonb/indexes.xml[indexes.xml^]
+endif::[]
+and
+ifeval::["{snapshotOrRelease}" == "release"]
+https://github.com/apache/syncope/blob/syncope-{docVersion}/fit/core-reference/src/main/resources/pgjsonb/views.xml[views.xml^]
+endif::[]
+ifeval::["{snapshotOrRelease}" == "snapshot"]
+https://github.com/apache/syncope/tree/master/fit/core-reference/src/main/resources/pgjsonb/views.xml[views.xml^]
+endif::[]
+then save both under `core/src/main/resources/`.
+
+Download
+ifeval::["{snapshotOrRelease}" == "release"]
+https://github.com/apache/syncope/blob/syncope-{docVersion/core/persistence-jpa-pgjsonb/src/test/resources/domains/MasterContent.xml[MasterContent.xml^]
+endif::[]
+ifeval::["{snapshotOrRelease}" == "snapshot"]
+https://github.com/apache/syncope/blob/master/core/persistence-jpa-pgjsonb/src/test/resources/domains/MasterContent.xml[MasterContent.xml^]
+endif::[]
+and save it under `core/src/test/resources/`.
+
 ===== MySQL
 
 [NOTE]
 Apache Syncope {docVersion} is verified with MySQL server >= 5.7 and JDBC driver >=
{mysqlJDBC}.
 
-In `provisioning.properties`:
+In `provisioning.properties`, replace as follows:
 
 ....
 quartz.jobstore=org.quartz.impl.jdbcjobstore.StdJDBCDelegate
@@ -75,7 +146,7 @@ quartz.sql=tables_mysql_innodb.sql
 This assumes that the InnoDB engine is enabled in your MySQL instance - if this is not the
case, then change the value
 for `quartz.sql` to `tables_mysql.sql`.
 
-In `domains/Master.properties` (for the `Master` domain):
+In `domains/Master.properties` (for the `Master` domain), replace as follows:
 
 ....
 Master.driverClassName=com.mysql.jdbc.Driver
@@ -104,7 +175,7 @@ This assumes that you have a MySQL instance running on localhost, listening
on i
 [NOTE]
 Apache Syncope {docVersion} is verified with MariaDB server >= 10.3.7 and JDBC driver
>= {mariadbJDBC}.
 
-In `provisioning.properties`:
+In `provisioning.properties`, replace as follows:
 
 ....
 quartz.jobstore=org.quartz.impl.jdbcjobstore.StdJDBCDelegate
@@ -115,7 +186,7 @@ quartz.sql=tables_mariadb.sql
 This assumes that the InnoDB engine is enabled in your MariaDB instance - if this is not
the case, then change the value
 for `quartz.sql` to `tables_mariadb.sql`.
 
-In `domains/Master.properties` (for the `Master` domain):
+In `domains/Master.properties` (for the `Master` domain), replace as follows:
 
 ....
 Master.driverClassName=org.mariadb.jdbc.Driver
@@ -139,14 +210,14 @@ This assumes that you have a MariaDB instance running on localhost,
listening on
 [NOTE]
 Apache Syncope {docVersion} is verified with Oracle database >= 11g and JDBC driver >=
ojdbc8 12.2.0.1.
 
-In `provisioning.properties`:
+In `provisioning.properties`, replace as follows:
 
 ....
 quartz.jobstore=org.quartz.impl.jdbcjobstore.oracle.OracleDelegate
 quartz.sql=tables_oracle.sql
 ....
 
-In `domains/Master.properties` (for the `Master` domain):
+In `domains/Master.properties` (for the `Master` domain), replace as follows:
 
 ....
 Master.driverClassName=oracle.jdbc.OracleDriver
@@ -168,14 +239,14 @@ This assumes that you have an Oracle instance running on localhost,
listening on
 [NOTE]
 Apache Syncope {docVersion} is verified with MS SQL server >= 2017 and JDBC driver >=
{sqlserverJDBC}8.
 
-In `provisioning.properties`:
+In `provisioning.properties`, replace as follows:
 
 ....
 quartz.jobstore=org.quartz.impl.jdbcjobstore.MSSQLDelegate
 quartz.sql=tables_sqlServer.sql
 ....
 
-In `domains/Master.properties` (for the `Master` domain):
+In `domains/Master.properties` (for the `Master` domain), replace as follows:
 
 ....
 Master.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver


Mime
View raw message