org.dcm4che3.conf.api.upgrade

Class UpgradeScript.UpgradeContext

java.lang.Object

org.dcm4che3.conf.api.upgrade.UpgradeScript.UpgradeContext

Enclosing interface:

UpgradeScript

public static class UpgradeScript.UpgradeContext
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
private ConfigurationMetadata	configMetaData
private Configuration	configuration
private DicomConfiguration	dicomConfiguration
private String	fromVersion
private static Logger	log
private Properties	properties
private Map<String,Object>	scriptConfig
private String	toVersion
private UpgradeScript.UpgradeScriptMetadata	upgradeScriptMetadata

Constructor Summary

Constructors

Constructor and Description
UpgradeContext()
UpgradeContext(String fromVersion, String toVersion, Properties properties, Map<String,Object> scriptConfig, Configuration configuration, DicomConfiguration dicomConfiguration)
UpgradeContext(String fromVersion, String toVersion, Properties properties, Map<String,Object> scriptConfig, Configuration configuration, DicomConfiguration dicomConfiguration, UpgradeScript.UpgradeScriptMetadata upgradeScriptMetadata)
UpgradeContext(String fromVersion, String toVersion, Properties properties, Map<String,Object> scriptConfig, Configuration configuration, DicomConfiguration dicomConfiguration, UpgradeScript.UpgradeScriptMetadata upgradeScriptMetadata, ConfigurationMetadata configMetaData)

Method Summary

Modifier and Type	Method and Description
void	forkScript(Class<? extends UpgradeScript> forkedScript, String scriptVersion) Allows to "fork" another script from the currently executed script. This feature allows to refactor an existing script (script A) by extracting a part of it into a new script (script B).
Configuration	getConfiguration()
DicomConfiguration	getDicomConfiguration()
Object	getFromVersion()
Properties	getProperties()
Map<String,Object>	getScriptConfig()
Object	getToVersion()
UpgradeScript.UpgradeScriptMetadata	getUpgradeScriptMetadata()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

private static final Logger log

fromVersion

private String fromVersion

toVersion

private String toVersion

properties

private Properties properties

scriptConfig

private Map<String,Object> scriptConfig

configuration

private Configuration configuration

dicomConfiguration

private DicomConfiguration dicomConfiguration

upgradeScriptMetadata

private UpgradeScript.UpgradeScriptMetadata upgradeScriptMetadata

configMetaData

private ConfigurationMetadata configMetaData

Constructor Detail

UpgradeContext

public UpgradeContext()

UpgradeContext

public UpgradeContext(String fromVersion,
                      String toVersion,
                      Properties properties,
                      Map<String,Object> scriptConfig,
                      Configuration configuration,
                      DicomConfiguration dicomConfiguration)

UpgradeContext

public UpgradeContext(String fromVersion,
                      String toVersion,
                      Properties properties,
                      Map<String,Object> scriptConfig,
                      Configuration configuration,
                      DicomConfiguration dicomConfiguration,
                      UpgradeScript.UpgradeScriptMetadata upgradeScriptMetadata)

UpgradeContext

public UpgradeContext(String fromVersion,
                      String toVersion,
                      Properties properties,
                      Map<String,Object> scriptConfig,
                      Configuration configuration,
                      DicomConfiguration dicomConfiguration,
                      UpgradeScript.UpgradeScriptMetadata upgradeScriptMetadata,
                      ConfigurationMetadata configMetaData)

Method Detail

getFromVersion

public Object getFromVersion()

getToVersion

public Object getToVersion()

getConfiguration

public Configuration getConfiguration()

getDicomConfiguration

public DicomConfiguration getDicomConfiguration()

getProperties

public Properties getProperties()

getScriptConfig

public Map<String,Object> getScriptConfig()

getUpgradeScriptMetadata

public UpgradeScript.UpgradeScriptMetadata getUpgradeScriptMetadata()

forkScript

public void forkScript(Class<? extends UpgradeScript> forkedScript,
                       String scriptVersion)

Allows to "fork" another script from the currently executed script.

This feature allows to refactor an existing script (script A) by extracting a part of it into a new script (script B).

To facilitate a simpler design, this method will pre-set some version for that new script (B), so the new script will "think" that it's not the first time it's executed. This covers the case when upgrading from an older version of A (when A+B was still a single script), so B will not think that it's a "clean installation"

CAUTION: It is important that B appears after A in upgrade-settings.json

Parameters:

forkedScript - The B script.

scriptVersion - The version to set for the B script.