org.dcm4che3.conf.dicom

Class CommonDicomConfiguration

java.lang.Object

org.dcm4che3.conf.dicom.CommonDicomConfiguration

All Implemented Interfaces:

Closeable, AutoCloseable, DicomConfiguration, DicomConfigurationManager, ExtendedDicomConfiguration, TransferCapabilityConfigExtension, ConfigurationManager

Direct Known Subclasses:

CommonDicomConfigurationWithHL7

public class CommonDicomConfiguration
extends Object
implements DicomConfigurationManager, TransferCapabilityConfigExtension

Author:

Roman K

Nested Class Summary

Nested classes/interfaces inherited from interface org.dcm4che3.conf.api.DicomConfiguration

DicomConfiguration.DicomConfigBatch

Field Summary

Fields

Modifier and Type	Field and Description
private AlternativeTCLoader	alternativeTCLoader
private TypeSafeConfiguration<DicomConfigurationRoot>	config
private Map<Class,List<Class>>	extensionsByClass
private static Logger	log
protected Configuration	lowLevelConfig
private Map<Device,Object>	readOnlyDevices see preventDeviceModifications(org.dcm4che3.net.Device)
private BeanVitalizer	vitalizer

Fields inherited from interface org.dcm4che3.conf.api.internal.DicomConfigurationManager

METADATA_ROOT_PATH

Constructor Summary

Constructors

Constructor and Description
CommonDicomConfiguration(Configuration configStorage, Map<Class,List<Class>> extensionsByClass)
CommonDicomConfiguration(Configuration configurationStorage, Map<Class,List<Class>> extensionsByClass, boolean doCacheTCGroups)

Method Summary

Modifier and Type	Method and Description
static void	addCustomAdapters(BeanVitalizer defaultBeanVitalizer)
void	close()
boolean	configurationExists() Indicates whether the configuration backend is initialized
static BeanVitalizer	createDefaultDicomVitalizer()
protected Map<String,Object>	createDeviceConfigNode(Device device)
protected HashMap<String,Object>	createInitialConfigRootNode()
ApplicationEntity	findApplicationEntity(String aet) Looks up an application entity by name
ApplicationEntity	findApplicationEntityByUUID(String uuid) Looks up an application entity by UUID
Device	findDevice(String name) Looks up a device by name
Device	findDevice(String name, DicomConfigOptions options) Allows to use extended options
Device	findDeviceByUUID(String uuid) Looks up a device by UUID
Configuration	getConfigurationStorage()
<T> T	getDicomConfigurationExtension(Class<T> clazz) Get an extension of configuration
<T> List<Class<? extends T>>	getExtensionClassesByBaseClass(Class<T> clazz) Returns a list of registered extensions for a specified base extension class
TCConfiguration	getTransferCapabilityConfig()
TypeSafeConfiguration<DicomConfigurationRoot>	getTypeSafeConfiguration()
BeanVitalizer	getVitalizer()
private void	handleReadOnlyDeviceModification()
List<String>	listAllAETitles() Returns all AE names from all devices from the configuration backend
DeviceInfo[]	listDeviceInfos(DeviceInfo keys) Query for Devices with specified attributes.
String[]	listDeviceNames() Returns all device names from the configuration backend
void	merge(Device device) Replaces the full configuration of a device in the configuration backend with the configuration of the provided device.
void	persist(Device device) Stores the full configuration of a device in the configuration backend.
void	persistTransferCapabilityConfig(TCConfiguration tcConfig)
void	preventDeviceModifications(Device d) Remembers a weak reference to the provided device so that any subsequent call to persist or merge for this specific instance is made, an error is logged.
boolean	purgeConfiguration()
void	refreshTCGroups() Triggers a reload of TC groups
boolean	registerAETitle(String aet)
void	removeDevice(String name) Removes the device and its configuration from the configuration storage fully.
void	runBatch(DicomConfiguration.DicomConfigBatch dicomConfigBatch) Provides support for batching configuration changes.
void	sync() Invalidates any present cached state for the configuration storage view of the client.
void	unregisterAETitle(String aet)

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

readOnlyDevices

private final Map<Device,Object> readOnlyDevices

see preventDeviceModifications(org.dcm4che3.net.Device)

lowLevelConfig

protected final Configuration lowLevelConfig

vitalizer

private final BeanVitalizer vitalizer

extensionsByClass

private final Map<Class,List<Class>> extensionsByClass

config

private final TypeSafeConfiguration<DicomConfigurationRoot> config

alternativeTCLoader

private AlternativeTCLoader alternativeTCLoader

Constructor Detail

CommonDicomConfiguration

public CommonDicomConfiguration(Configuration configurationStorage,
                                Map<Class,List<Class>> extensionsByClass,
                                boolean doCacheTCGroups)

CommonDicomConfiguration

public CommonDicomConfiguration(Configuration configStorage,
                                Map<Class,List<Class>> extensionsByClass)

Method Detail

getExtensionClassesByBaseClass

public <T> List<Class<? extends T>> getExtensionClassesByBaseClass(Class<T> clazz)

Returns a list of registered extensions for a specified base extension class

Specified by:

getExtensionClassesByBaseClass in interface ConfigurationManager

Type Parameters:

T -

Parameters:

clazz -

Returns:

addCustomAdapters

public static void addCustomAdapters(BeanVitalizer defaultBeanVitalizer)

createInitialConfigRootNode

protected HashMap<String,Object> createInitialConfigRootNode()

getTypeSafeConfiguration

public TypeSafeConfiguration<DicomConfigurationRoot> getTypeSafeConfiguration()

Specified by:

getTypeSafeConfiguration in interface ExtendedDicomConfiguration

configurationExists

public boolean configurationExists()
                            throws ConfigurationException

Description copied from interface: ExtendedDicomConfiguration

Indicates whether the configuration backend is initialized

Specified by:

configurationExists in interface ExtendedDicomConfiguration

Returns:

Throws:

ConfigurationException

purgeConfiguration

public boolean purgeConfiguration()
                           throws ConfigurationException

Specified by:

purgeConfiguration in interface ExtendedDicomConfiguration

Throws:

ConfigurationException

preventDeviceModifications

public void preventDeviceModifications(Device d)

Description copied from interface: DicomConfigurationManager

Remembers a weak reference to the provided device so that any subsequent call to persist or merge for this specific instance is made, an error is logged. This is a safeguard against misusing a singleton injected device and making direct modifications on it. In future, logging an error will be replaced with throwing an exception

Specified by:

preventDeviceModifications in interface DicomConfigurationManager

refreshTCGroups

public void refreshTCGroups()

Description copied from interface: DicomConfigurationManager

Triggers a reload of TC groups

Specified by:

refreshTCGroups in interface DicomConfigurationManager

registerAETitle

public boolean registerAETitle(String aet)
                        throws ConfigurationException

Specified by:

registerAETitle in interface ExtendedDicomConfiguration

Throws:

ConfigurationException

unregisterAETitle

public void unregisterAETitle(String aet)
                       throws ConfigurationException

Specified by:

unregisterAETitle in interface ExtendedDicomConfiguration

Throws:

ConfigurationException

findApplicationEntity

public ApplicationEntity findApplicationEntity(String aet)
                                        throws ConfigurationException

Description copied from interface: DicomConfiguration

Looks up an application entity by name

Specified by:

findApplicationEntity in interface DicomConfiguration

Parameters:

aet - application entity name

Returns:

Throws:

ConfigurationException

findApplicationEntityByUUID

public ApplicationEntity findApplicationEntityByUUID(String uuid)
                                              throws ConfigurationException

Description copied from interface: DicomConfiguration

Looks up an application entity by UUID

Specified by:

findApplicationEntityByUUID in interface DicomConfiguration

Parameters:

uuid - UUID

Returns:

Throws:

ConfigurationException

findDeviceByUUID

public Device findDeviceByUUID(String uuid)
                        throws ConfigurationException

Description copied from interface: DicomConfiguration

Looks up a device by UUID

Specified by:

findDeviceByUUID in interface DicomConfiguration

Parameters:

uuid - UUID

Returns:

Throws:

ConfigurationException

findDevice

public Device findDevice(String name,
                         DicomConfigOptions options)
                  throws ConfigurationException

Description copied from interface: ExtendedDicomConfiguration

Allows to use extended options

Specified by:

findDevice in interface ExtendedDicomConfiguration

Throws:

ConfigurationException

findDevice

public Device findDevice(String name)
                  throws ConfigurationException

Description copied from interface: DicomConfiguration

Looks up a device by name

Specified by:

findDevice in interface DicomConfiguration

Parameters:

name - device name

Returns:

Throws:

ConfigurationException

listDeviceInfos

public DeviceInfo[] listDeviceInfos(DeviceInfo keys)
                             throws ConfigurationException

Description copied from interface: ExtendedDicomConfiguration

Query for Devices with specified attributes.

Specified by:

listDeviceInfos in interface ExtendedDicomConfiguration

Parameters:

keys - Device attributes which shall match or null to get information for all configured Devices

Returns:

array of DeviceInfo objects for configured Devices with matching attributes

Throws:

ConfigurationException

listDeviceNames

public String[] listDeviceNames()
                         throws ConfigurationException

Description copied from interface: DicomConfiguration

Returns all device names from the configuration backend

Specified by:

listDeviceNames in interface DicomConfiguration

Returns:

Device names

Throws:

ConfigurationException

listAllAETitles

public List<String> listAllAETitles()
                             throws ConfigurationException

Description copied from interface: DicomConfiguration

Returns all AE names from all devices from the configuration backend

Specified by:

listAllAETitles in interface DicomConfiguration

Returns:

AE names

Throws:

ConfigurationException

persist

public void persist(Device device)
             throws ConfigurationException

Description copied from interface: DicomConfiguration

Stores the full configuration of a device in the configuration backend.

Specified by:

persist in interface DicomConfiguration

Parameters:

device - Device to store

Throws:

ConfigurationAlreadyExistsException - When a device with such name already exists.

ConfigurationException - When an error occured during the operation

handleReadOnlyDeviceModification

private void handleReadOnlyDeviceModification()

merge

public void merge(Device device)
           throws ConfigurationException

Description copied from interface: DicomConfiguration

Replaces the full configuration of a device in the configuration backend with the configuration of the provided device. The behavior is similar to JPA's merge.

Specified by:

merge in interface DicomConfiguration

Parameters:

device - Device to merge

Throws:

ConfigurationException - When an error occured during the operation

createDeviceConfigNode

protected Map<String,Object> createDeviceConfigNode(Device device)
                                             throws ConfigurationException

Throws:

ConfigurationException

removeDevice

public void removeDevice(String name)
                  throws ConfigurationException

Description copied from interface: DicomConfiguration

Removes the device and its configuration from the configuration storage fully.

Specified by:

removeDevice in interface DicomConfiguration

Throws:

ConfigurationException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ExtendedDicomConfiguration

sync

public void sync()
          throws ConfigurationException

Description copied from interface: DicomConfiguration

Invalidates any present cached state for the configuration storage view of the client. There is no guarantee whether the devices accessed afterwards will be re-loaded lazily or eagerly. Has no effect for non-cached or consistently-cached configuration storage backends.

Specified by:

sync in interface DicomConfiguration

Throws:

ConfigurationException

getDicomConfigurationExtension

public <T> T getDicomConfigurationExtension(Class<T> clazz)

Description copied from interface: DicomConfiguration

Get an extension of configuration

Specified by:

getDicomConfigurationExtension in interface DicomConfiguration

Parameters:

clazz - Extension class

Returns:

getVitalizer

public BeanVitalizer getVitalizer()

Specified by:

getVitalizer in interface ConfigurationManager

getConfigurationStorage

public Configuration getConfigurationStorage()

Specified by:

getConfigurationStorage in interface ConfigurationManager

persistTransferCapabilityConfig

public void persistTransferCapabilityConfig(TCConfiguration tcConfig)
                                     throws ConfigurationException

Specified by:

persistTransferCapabilityConfig in interface TransferCapabilityConfigExtension

Throws:

ConfigurationException

getTransferCapabilityConfig

public TCConfiguration getTransferCapabilityConfig()
                                            throws ConfigurationException

Specified by:

getTransferCapabilityConfig in interface TransferCapabilityConfigExtension

Throws:

ConfigurationException

runBatch

public void runBatch(DicomConfiguration.DicomConfigBatch dicomConfigBatch)

Description copied from interface: DicomConfiguration

Provides support for batching configuration changes.

It is guaranteed that

• All configuration reads and writes in a batch are performed within a single transaction, i.e. the changes are atomic and performed in READ COMMITTED isolation
• When this method is called, an ongoing transaction (in case there is one) will be SUSPENDED. The batch will ALWAYS be executed in a SEPARATE transaction.
• At most ONE batch is executed at the same time in the whole cluster (synchronized with a database lock)

Specified by:

runBatch in interface DicomConfiguration

Parameters:

dicomConfigBatch - Configuration batch to execute

createDefaultDicomVitalizer

public static BeanVitalizer createDefaultDicomVitalizer()