In case the Syncope 2.0 deployment is based on Maven project, It is strongly advised to generate a new Maven project for 2.1 and to re-apply all the customizations and extensions made.
There is an issue with Syncope 2.1.0 (fixed for later releases), which requires to modify the sources of the generated Maven project. The following lines must be removed from <!-- TEST --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <scope>test</scope> </dependency> |
This change is primarily due to the introduction of default methods on interfaces.
All local classes extending default implementations such as DefaultPropagationActions, DefaultPullActions, DefaultPushActions, ... must be changed to implement the related interfaces, e.g. PropagationActions, PullActions, PushActions, ...
For each custom JAVA PullCorrelationRule add a configuration class in package org.apache.syncope.common.lib.policy
in common module of the project. For example, if you have a custom pull correlation rule class TestPullRule
create a configuration class TestPullRuleConf
like this:
package org.apache.syncope.common.lib.policy; import javax.xml.bind.annotation.XmlRootElement; import javax.xml.bind.annotation.XmlType; @XmlRootElement(name = "testPullRuleConf") @XmlType public class TestPullRuleConf extends AbstractCorrelationRuleConf implements PullCorrelationRuleConf { private static final long serialVersionUID = 429126085793346273L; } |
Then reference the latter class from your correlation rule code with the specific annotation like this:
package org.apache.syncope.core.persistence.jpa.dao; ... @PullCorrelationRuleConfClass(TestPullRuleConf.class) public class TestPullRule implements PullCorrelationRule { @Override public SearchCond getSearchCond(SyncDelta syncDelta, Provision provision) { // your custom pull search condition } } |
Various methods now return Optional, rather than nullable values as before; for example:
userTO.getPlainAttr("email").getUniqueValue() |
now becomes
userTO.getPlainAttr("email").get().getUniqueValue() |
Check the Javadocs to find out which methods are now returning Optional.
Ensure to copy the following values from Syncope 2.0's security.properties
into Syncope 2.1's:
Moreover, when the Java EE container running Syncope Core is down, remove all existing Access Tokens:
DELETE FROM AccessToken; |
Remove also all templates assigned to Realms and/or Pull tasks
DELETE FROM ANYTEMPLATEPULLTASK; DELETE FROM ANYTEMPLATEREALM; |
Note: if you want tamplates back you should re-create them once the procedure has finished successfully.
The procedure outlined here is only required if Syncope 2.0 was configured to use the Activiti user workflow adapter. |
The changes below will allow the new Flowable user workflow adapter to deal with the Activiti workflow definition from Syncope 2.0; more details are available in the Flowable website.
Once set, any update to the workflow definition will be automatically migrated to the new Flowable format.
Add to core/pom.xml
the following dependencies:
<dependency> <groupId>org.flowable</groupId> <artifactId>flowable5-compatibility</artifactId> <version>${flowable.version}</version> </dependency> <dependency> <groupId>org.flowable</groupId> <artifactId>flowable5-spring</artifactId> <version>${flowable.version}</version> </dependency> <dependency> <groupId>org.flowable</groupId> <artifactId>flowable5-spring-compatibility</artifactId> <version>${flowable.version}</version> </dependency> |
right after
<dependency> <groupId>org.apache.syncope.core</groupId> <artifactId>syncope-core-workflow-flowable</artifactId> <version>${syncope.version}</version> </dependency> |
In core/src/main/webapp/WEB-INF/web.xml
, replace
classpath*:/workflow*Context.xml |
with
classpath*:/workflowContext.xml classpath:/workflowFlowableContext.xml |
then download workflowFlowableContext.xml, save it under core/src/main/resources
and add
<bean id="flowable5CompabilityFactory" class="org.activiti.compatibility.spring.SpringFlowable5CompatibilityHandlerFactory"/> |
right before </beans>
and
<property name="flowable5CompatibilityEnabled" value="true" /> <property name="flowable5CompatibilityHandlerFactory" ref="flowable5CompabilityFactory"/> |
right after </property>
.
Add the following to core/src/main/resources/log4j2.xml
:
<asyncLogger name="org.activiti" additivity="false" level="ERROR"> <appender-ref ref="mainFile"/> <appender-ref ref="main"/> </asyncLogger> |
The steps to upgrade the internal storage to Syncope 2.1.0 are outlined in the Reference Guide.
There is an issue with Syncope 2.1.0 (fixed for later releases), which requires to add few SQL statements to the ones generated by the upgrade tool:
Do not forget to restart the Java EE container where Syncope Core is deployed, after executing the SQL statements above. |