org.dcm4che3.conf.core.storage

Class SingleJsonFileConfigurationStorage

java.lang.Object

org.dcm4che3.conf.core.storage.SingleJsonFileConfigurationStorage

All Implemented Interfaces:

BatchRunner, Configuration

public class SingleJsonFileConfigurationStorage
extends Object
implements Configuration

Author:

Roman K

Nested Class Summary

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

Configuration.ConfigStorageType, Configuration.NodeFactory

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

BatchRunner.Batch

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONF_FILENAME_SYSPROP
private String	fileName
private static Logger	log
private org.codehaus.jackson.map.ObjectMapper	objectMapper
static String	USE_GIT_SYSPROP Experimental

Fields inherited from interface org.dcm4che3.conf.core.api.Configuration

CONF_STORAGE_SYSTEM_PROP, OLOCK_HASH_KEY, REFERENCE_BY_UUID_PATTERN, REFERENCE_KEY, UUID_KEY, WEAK_REFERENCE_KEY

Constructor Summary

Constructors

Constructor and Description
SingleJsonFileConfigurationStorage()
SingleJsonFileConfigurationStorage(String fileName)

Method Summary

Modifier and Type	Method and Description
void	configure(Hashtable<?,?> props)
Object	getConfigurationNode(Path path, Class configurableClass) Loads a configuration node under the specified path.
Map<String,Object>	getConfigurationRoot() Return the root of the configuration tree.
Path	getPathByUUID(String uuid)
void	lock() Aquire a global pessimistic lock (cluster-aware implementations should ensure that only a single node can aquire the lock at a time) Subsequent calls from the same transaction should not block.
boolean	nodeExists(Path path) Tests if a node under the specified path exists.
void	persistNode(Path path, Map<String,Object> configNode, Class configurableClass) Persists the configuration node to the specified path.
void	refreshNode(Path path) Invalidates any present cached state for the node It is imperative that some other nodes might also be refreshed during the operation.
void	removeNode(Path path) Removes a configuration node under the specified path with all its children permanently
static String	resolveConfigFileNameSetting(Hashtable<?,?> props)
void	runBatch(BatchRunner.Batch batch) Provides support for batching configuration changes.
Iterator	search(String liteXPathExpression) Performs a search on the configuration tree and returns an iterator to configuration nodes that satisfy the search criteria.

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

CONF_FILENAME_SYSPROP

public static final String CONF_FILENAME_SYSPROP

See Also:

Constant Field Values

USE_GIT_SYSPROP

public static final String USE_GIT_SYSPROP

Experimental

See Also:

Constant Field Values

fileName

private String fileName

objectMapper

private org.codehaus.jackson.map.ObjectMapper objectMapper

Constructor Detail

SingleJsonFileConfigurationStorage

public SingleJsonFileConfigurationStorage()

SingleJsonFileConfigurationStorage

public SingleJsonFileConfigurationStorage(String fileName)

Method Detail

resolveConfigFileNameSetting

public static String resolveConfigFileNameSetting(Hashtable<?,?> props)

configure

public void configure(Hashtable<?,?> props)

nodeExists

public boolean nodeExists(Path path)
                   throws ConfigurationException

Description copied from interface: Configuration

Tests if a node under the specified path exists.

Specified by:

nodeExists in interface Configuration

Returns:

Throws:

ConfigurationException

getConfigurationRoot

public Map<String,Object> getConfigurationRoot()
                                        throws ConfigurationException

Description copied from interface: Configuration

Return the root of the configuration tree. The returned node should not be modified directly (only through persistNode/removeNode).

Specified by:

getConfigurationRoot in interface Configuration

Returns:

configuration tree

Throws:

ConfigurationException

getConfigurationNode

public Object getConfigurationNode(Path path,
                                   Class configurableClass)
                            throws ConfigurationException

Description copied from interface: Configuration

Loads a configuration node under the specified path.

Specified by:

getConfigurationNode in interface Configuration

Parameters:

path - A reference to a node

Returns:

configuration node or null, if not found

Throws:

ConfigurationException

persistNode

public void persistNode(Path path,
                        Map<String,Object> configNode,
                        Class configurableClass)
                 throws ConfigurationException

Description copied from interface: Configuration

Persists the configuration node to the specified path. The path must exist (or at least all nodes but the last one). The property is created/fully overwritten, i.e. if there were any child nodes in the old root that are not present in the new node root, they will be deleted in the new tree.

Specified by:

persistNode in interface Configuration

Parameters:

path - path to the node

configNode - configuration node to persist

configurableClass - class annotated with ConfigurableClass, ConfigurableProperty annotations that corresponds to this node.

Throws:

ConfigurationException

refreshNode

public void refreshNode(Path path)

Description copied from interface: Configuration

Invalidates any present cached state for the node It is imperative that some other nodes might also be refreshed during the operation. There is no guarantee whether the new version will be re-loaded lazily or eagerly

Specified by:

refreshNode in interface Configuration

removeNode

public void removeNode(Path path)
                throws ConfigurationException

Description copied from interface: Configuration

Removes a configuration node under the specified path with all its children permanently

Specified by:

removeNode in interface Configuration

Throws:

ConfigurationException

getPathByUUID

public Path getPathByUUID(String uuid)

Specified by:

getPathByUUID in interface Configuration

search

public Iterator search(String liteXPathExpression)
                throws IllegalArgumentException,
                       ConfigurationException

Description copied from interface: Configuration

Performs a search on the configuration tree and returns an iterator to configuration nodes that satisfy the search criteria.

Specified by:

search in interface Configuration

Parameters:

liteXPathExpression - Must be absolute path, no double slashes, no @attributes (only [attr=val] or [attr<>val])

Throws:

IllegalArgumentException

ConfigurationException

lock

public void lock()

Description copied from interface: Configuration

Aquire a global pessimistic lock (cluster-aware implementations should ensure that only a single node can aquire the lock at a time) Subsequent calls from the same transaction should not block. Should be auto-released on transaction commit/rollback.

Specified by:

lock in interface Configuration

runBatch

public void runBatch(BatchRunner.Batch batch)

Description copied from interface: BatchRunner

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 BatchRunner

Parameters:

batch - Configuration batch change to execute