[SYNCOPE-1069] Fixing docs Signed-off-by: Francesco Chicchiriccò <ilgro...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/dd034efb Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/dd034efb Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/dd034efb Branch: refs/heads/master Commit: dd034efbed63740853de1335a12a17de73547ea9 Parents: d76ed3e Author: Francesco Chicchiriccò <ilgro...@apache.org> Authored: Thu Apr 20 16:43:23 2017 +0200 Committer: Francesco Chicchiriccò <ilgro...@apache.org> Committed: Thu Apr 20 16:44:41 2017 +0200 ---------------------------------------------------------------------- archetype/pom.xml | 1 + .../src/main/resources/jboss/restCXFContext.xml | 2 + .../src/main/resources/jboss/web.xml | 9 +++- .../src/main/webapp/WEB-INF/web.xml | 8 ++- .../workingwithapachesyncope/customization.adoc | 14 ++++-- .../systemadministration/highavailability.adoc | 51 ++++++++++++++++++-- .../systemadministration/javaeecontainer.adoc | 17 +++++-- 7 files changed, 88 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/syncope/blob/dd034efb/archetype/pom.xml ---------------------------------------------------------------------- diff --git a/archetype/pom.xml b/archetype/pom.xml index 3441d61..0833550 100644 --- a/archetype/pom.xml +++ b/archetype/pom.xml @@ -137,6 +137,7 @@ under the License. <directory>../core/persistence-jpa/src/main/resources</directory> <excludes> <exclude>*Context.xml</exclude> + <exclude>domains.xml</exclude> <exclude>META-INF/spring-persistence.xml</exclude> </excludes> <targetPath>${project.build.outputDirectory}/archetype-resources/core/src/main/resources</targetPath> http://git-wip-us.apache.org/repos/asf/syncope/blob/dd034efb/fit/core-reference/src/main/resources/jboss/restCXFContext.xml ---------------------------------------------------------------------- diff --git a/fit/core-reference/src/main/resources/jboss/restCXFContext.xml b/fit/core-reference/src/main/resources/jboss/restCXFContext.xml index dd6c88c..ad9306d 100644 --- a/fit/core-reference/src/main/resources/jboss/restCXFContext.xml +++ b/fit/core-reference/src/main/resources/jboss/restCXFContext.xml @@ -99,6 +99,7 @@ under the License. <list> <value>/WEB-INF/lib/syncope-common-rest-api-${syncope.version}-javadoc.jar</value> <value>/WEB-INF/lib/syncope-ext-camel-rest-api-${syncope.version}-javadoc.jar</value> + <value>/WEB-INF/lib/syncope-ext-saml2sp-rest-api-${syncope.version}-javadoc.jar</value> </list> </property> </bean> @@ -110,6 +111,7 @@ under the License. <list> <value>/WEB-INF/lib/syncope-common-rest-api-${syncope.version}-javadoc.jar</value> <value>/WEB-INF/lib/syncope-ext-camel-rest-api-${syncope.version}-javadoc.jar</value> + <value>/WEB-INF/lib/syncope-ext-saml2sp-rest-api-${syncope.version}-javadoc.jar</value> </list> </property> </bean> http://git-wip-us.apache.org/repos/asf/syncope/blob/dd034efb/fit/core-reference/src/main/resources/jboss/web.xml ---------------------------------------------------------------------- diff --git a/fit/core-reference/src/main/resources/jboss/web.xml b/fit/core-reference/src/main/resources/jboss/web.xml index 25bc692..bc6f1fd 100644 --- a/fit/core-reference/src/main/resources/jboss/web.xml +++ b/fit/core-reference/src/main/resources/jboss/web.xml @@ -28,8 +28,13 @@ under the License. <context-param> <param-name>contextConfigLocation</param-name> <param-value> - classpath*:/*Context.xml - /WEB-INF/classes/restCXFContext.xml + classpath*:/coreContext.xml + classpath*:/securityContext.xml + classpath*:/logicContext.xml + classpath:/restCXFContext.xml + classpath*:/persistenceContext.xml + classpath*:/provisioning*Context.xml + classpath*:/workflow*Context.xml </param-value> </context-param> http://git-wip-us.apache.org/repos/asf/syncope/blob/dd034efb/fit/core-reference/src/main/webapp/WEB-INF/web.xml ---------------------------------------------------------------------- diff --git a/fit/core-reference/src/main/webapp/WEB-INF/web.xml b/fit/core-reference/src/main/webapp/WEB-INF/web.xml index b358a27..49a82fe 100644 --- a/fit/core-reference/src/main/webapp/WEB-INF/web.xml +++ b/fit/core-reference/src/main/webapp/WEB-INF/web.xml @@ -28,7 +28,13 @@ under the License. <context-param> <param-name>contextConfigLocation</param-name> <param-value> - classpath*:/*Context.xml + classpath*:/coreContext.xml + classpath*:/securityContext.xml + classpath*:/logicContext.xml + classpath*:/restCXFContext.xml + classpath*:/persistenceContext.xml + classpath*:/provisioning*Context.xml + classpath*:/workflow*Context.xml </param-value> </context-param> http://git-wip-us.apache.org/repos/asf/syncope/blob/dd034efb/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 146542b..9afafa9 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/customization.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/customization.adoc @@ -243,19 +243,25 @@ endif::[] , you will also need to replace the following text in `core/src/main/webapp/WEB-INF/web.xml`, .... -classpath*:/*Context.xml +classpath*:/coreContext.xml +classpath*:/securityContext.xml +classpath*:/logicContext.xml +classpath*:/restCXFContext.xml +classpath*:/persistenceContext.xml +classpath*:/provisioning*Context.xml +classpath*:/workflow*Context.xml .... with .... -classpath:/coreContext.xml +classpath*:/coreContext.xml classpath:/securityContext.xml classpath*:/logicContext.xml classpath*:/restCXFContext.xml classpath*:/persistenceContext.xml -classpath*:/provisioningContext.xml -classpath*:/workflowContext.xml +classpath*:/provisioning*Context.xml +classpath*:/workflow*Context.xml .... to be sure that `core/src/main/resources/securityContext.xml` is picked up. + http://git-wip-us.apache.org/repos/asf/syncope/blob/dd034efb/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/highavailability.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/highavailability.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/highavailability.adoc index b3df0e1..37a1dd5 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/highavailability.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/highavailability.adoc @@ -18,11 +18,53 @@ // ==== High-Availability -When deploying multiple Apache Syncope instances with a single database or database cluster, it is of +When deploying multiple Syncope <<core>> instances with a single database or database cluster, it is of fundamental importance that the contained OpenJPA instances are correctly configured for http://openjpa.apache.org/builds/2.4.2/apache-openjpa/docs/ref_guide_event.html[remote event notification^]. + Such configuration, in fact, allows the OpenJPA data cache to remain synchronized when deployed in multiple JVMs, thus -enforcing data consistency across all Apache Syncope instances. +enforcing data consistency across all Syncope Core instances. + +Replace + +.... +classpath*:/coreContext.xml +classpath*:/securityContext.xml +classpath*:/logicContext.xml +classpath*:/restCXFContext.xml +classpath*:/persistenceContext.xml +classpath*:/provisioning*Context.xml +classpath*:/workflow*Context.xml +.... + +with + +.... +classpath*:/coreContext.xml +classpath*:/securityContext.xml +classpath*:/logicContext.xml +classpath*:/restCXFContext.xml +classpath*:persistenceContext.xml +classpath*:/provisioning*Context.xml +classpath*:/workflow*Context.xml +.... + +in `core/src/main/webapp/WEB-INF/web.xml`. + +Download +ifeval::["{snapshotOrRelease}" == "release"] +https://github.com/apache/syncope/blob/syncope-{docVersion}/core/persistence-jpa/src/main/resources/persistenceContext.xml[persistenceContext.xml^] +endif::[] +ifeval::["{snapshotOrRelease}" == "snapshot"] +https://github.com/apache/syncope/tree/master/core/persistence-jpa/src/main/resources/persistenceContext.xml[persistenceContext.xml^] +endif::[] +and +ifeval::["{snapshotOrRelease}" == "release"] +https://github.com/apache/syncope/blob/syncope-{docVersion}/core/persistence-jpa/src/main/resources/domains.xml[domains.xml^] +endif::[] +ifeval::["{snapshotOrRelease}" == "snapshot"] +https://github.com/apache/syncope/tree/master/core/persistence-jpa/src/main/resources/domains.xml[domains.xml^] +endif::[] +then save both under `core/src/main/resources/`. The default configuration in `domains.xml` is @@ -36,14 +78,15 @@ see the OpenJPA documentation for reference. [WARNING] ==== -The OpenJPA documentation refers to direct configuration under `META-INF/persistence.xml`; for example: +The OpenJPA documentation's XML snippets refer to a different configuration style; for example, when used in +`domains.xml`, this: [source,xml] .... <property name="openjpa.RemoteCommitProvider" value="tcp(Addresses=10.0.1.10;10.0.1.11)"/> .... -while for use in `domains.xml`, this becomes: +becomes: [source,xml] .... http://git-wip-us.apache.org/repos/asf/syncope/blob/dd034efb/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/javaeecontainer.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/javaeecontainer.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/javaeecontainer.adoc index c2e7f58..865045c 100644 --- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/javaeecontainer.adoc +++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/systemadministration/javaeecontainer.adoc @@ -136,14 +136,25 @@ as additional dependencies in `core/pom.xml`, `console/pom.xml` and `enduser/pom Replace .... - classpath*:/*Context.xml +classpath*:/coreContext.xml +classpath*:/securityContext.xml +classpath*:/logicContext.xml +classpath*:/restCXFContext.xml +classpath*:/persistenceContext.xml +classpath*:/provisioning*Context.xml +classpath*:/workflow*Context.xml .... with .... - /WEB-INF/classes/restCXFContext.xml - classpath*:/*Context.xml +classpath*:/coreContext.xml +classpath*:/securityContext.xml +classpath*:/logicContext.xml +classpath*:restCXFContext.xml +classpath*:/persistenceContext.xml +classpath*:/provisioning*Context.xml +classpath*:/workflow*Context.xml .... in `core/src/main/webapp/WEB-INF/web.xml`.
