Skip to content

Migration guide v6.4.0

Olivier Perrin edited this page Apr 24, 2024 · 30 revisions

Breaking Change Breaking changes for all users

Code cleanup

In this release, an effort was made to reduce the project's technical debt. This work introduced some breaking changes.

Jackson

To avoid unsafe Jackson deserialization (see https://rules.sonarsource.com/java/RSPEC-4544/ ), classes implementing the interface BusRef now have to add the Jackson annotation @JsonTypeName(".<ClassName>") (with <ClassName> replaced by the class name. Note the presence of the . before the class name.). For instance IdBasedBusRef is annotated with @JsonTypeName(".IdBasedBusRef").

Removal of deprecated methods, and its impact

Following deprecated methods have been deleted:

  • PlatformConfig.setDefaultConfig
  • PlatformConfig.moduleExists
  • PlatformConfig.getModuleConfig
  • PlatformConfigNamedProvider.findBackwardsCompatible
  • PlatformConfigNamedProvider.findDefaultBackwardsCompatible
  • StandbyAutomaton.getHighVoltageSetPoint
  • StandbyAutomaton.setHighVoltageSetPoint
  • StandbyAutomaton.getLowVoltageSetPoint
  • StandbyAutomaton.setLowVoltageSetPoint
  • StandbyAutomatonAdder.withHighVoltageSetPoint
  • StandbyAutomatonAdder.withLowVoltageSetPoint
  • UndirectedGraph.getMaxVertex (If you override this method, rename it as getVertexCapacity().)

Because of the PlatformConfigNamedProvider. ...BackwardsCompatible methods' deprecation, "default" keyword will not be supported anymore in configuration files. Thus check that you use "default-impl-name" instead of "default" in your configuration, especially in load-flow and dynamic-simulation sections.

Behavior change

The list returned by CandidateComputations.getComputationsNames() is now immutable.


Custom IIDM Impl Breaking changes for custom IIDM implementations maintainers

TODO

Clone this wiki locally