Summary: Methods | [Expand All]
public interface

ConfigurationFile

com.microstrategy.utils.config.ConfigurationFile
Known Indirect Subclasses

Class Overview

This is the interface that represents an instance of a configuration file. It is the interface used by the ConfigurationFilesCache to load and reload the contents of the file. Those ConfigurationElement instances that can be directly saved/loaded from a file and its values cached within the ConfigurationFilesCache require to explicitly implement this interface.

Summary

Public Methods
abstract void applyCustomization(CustomizationInfo c)
Applies the corresponding customizations.
abstract void applyCustomizations()
Loops through all the CustomizationInfo in the Customizations class and apply the corresponding customizations.
abstract void load(String fileName)
Loads the file with the given name and initializes this ConfigurationFile with its content.
abstract void reload()
Reloads the content of this ConfigurationFile if the underlying configuration file has changed.
abstract void save()
Saves this ConfigurationFile back into the files where it was loaded from.
abstract void save(CustomizationInfo c)
Saves the differences between the shipped ("out of the box") definition of this ConfigurationFile and its currents values into the corresponding CustomizationInfo.
abstract void setUseValidation(boolean value)
Defines whether the XML content should validated using a DTD.
abstract boolean useValidation()
Returns whether the XML content should be validated using a DTD.

Public Methods

public abstract void applyCustomization (CustomizationInfo c)

Applies the corresponding customizations.

Throws
ConfigException

public abstract void applyCustomizations ()

Loops through all the CustomizationInfo in the Customizations class and apply the corresponding customizations.

Throws
ConfigException

public abstract void load (String fileName)

Loads the file with the given name and initializes this ConfigurationFile with its content.

Parameters
fileName The path to the configuration file. This path will be resolved by the FileLoader
Throws
ConfigException

public abstract void reload ()

Reloads the content of this ConfigurationFile if the underlying configuration file has changed.

Throws
ConfigException

public abstract void save ()

Saves this ConfigurationFile back into the files where it was loaded from.

Throws
ConfigException

public abstract void save (CustomizationInfo c)

Saves the differences between the shipped ("out of the box") definition of this ConfigurationFile and its currents values into the corresponding CustomizationInfo.

Throws
ConfigException

public abstract void setUseValidation (boolean value)

Defines whether the XML content should validated using a DTD.

Parameters
value true requires that the XML is parsed with DTD validation on.

public abstract boolean useValidation ()

Returns whether the XML content should be validated using a DTD. If true when the XML is parsed the file will be validated using the corresponding DTD (as defined in the XML itself).