org.dcm4che3.conf.api

Interface DicomConfiguration

All Known Subinterfaces:

DicomConfigurationManager, ExtendedDicomConfiguration

All Known Implementing Classes:

CommonDicomConfiguration, CommonDicomConfigurationWithHL7

public interface DicomConfiguration

This interface should be used by vendors/integrators to access and manipulate the DICOM configuration in a type-safe way. Always give the preference to this interface when possible.

Author:

Gunter Zeilinger , Roman K

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DicomConfiguration.DicomConfigBatch Defines a configuration batch that allows to execute configuration changes in a bulk-type manner.

Method Summary

Modifier and Type	Method and Description
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	findDeviceByUUID(String uuid) Looks up a device by UUID
<T> T	getDicomConfigurationExtension(Class<T> clazz) Get an extension of configuration
List<String>	listAllAETitles() Returns all AE names from all devices from the configuration backend
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	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.

Method Detail

findApplicationEntity

ApplicationEntity findApplicationEntity(String aet)
                                 throws ConfigurationException

Looks up an application entity by name

Parameters:

aet - application entity name

Returns:

Throws:

ConfigurationException

findApplicationEntityByUUID

ApplicationEntity findApplicationEntityByUUID(String uuid)
                                       throws ConfigurationException

Looks up an application entity by UUID

Parameters:

uuid - UUID

Returns:

Throws:

ConfigurationException

findDeviceByUUID

Device findDeviceByUUID(String uuid)
                 throws ConfigurationException

Looks up a device by UUID

Parameters:

uuid - UUID

Returns:

Throws:

ConfigurationException

findDevice

Device findDevice(String name)
           throws ConfigurationException

Looks up a device by name

Parameters:

name - device name

Returns:

Throws:

ConfigurationException

persist

void persist(Device device)
      throws ConfigurationException

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

Parameters:

device - Device to store

Throws:

ConfigurationAlreadyExistsException - When a device with such name already exists.

ConfigurationException - When an error occured during the operation

merge

void merge(Device device)
    throws ConfigurationException

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.

Parameters:

device - Device to merge

Throws:

ConfigurationException - When an error occured during the operation

removeDevice

void removeDevice(String name)
           throws ConfigurationException

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

Parameters:

name -

Throws:

ConfigurationException

listDeviceNames

String[] listDeviceNames()
                  throws ConfigurationException

Returns all device names from the configuration backend

Returns:

Device names

Throws:

ConfigurationException

listAllAETitles

List<String> listAllAETitles()
                      throws ConfigurationException

Returns all AE names from all devices from the configuration backend

Returns:

AE names

Throws:

ConfigurationException

sync

void sync()
   throws ConfigurationException

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.

Throws:

ConfigurationException

getDicomConfigurationExtension

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

Get an extension of configuration

Type Parameters:

T -

Parameters:

clazz - Extension class

Returns:

Throws:

IllegalArgumentException - - in case an extension of specified class is nto found

runBatch

void runBatch(DicomConfiguration.DicomConfigBatch dicomConfigBatch)

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)

Parameters:

dicomConfigBatch - Configuration batch to execute