Package com.microstrategy.utils.config

Interface ConfigurationFile

All Known Subinterfaces:

StyleCatalog

All Known Implementing Classes:

AbstractConfigurationElement, AbstractConfigurationElementList, AbstractElementList, AbstractStyleCatalogElement, AbstractStyleCatalogList, ActualParameterImpl, ActualParameterInfo, ActualParametersImpl, AddonInfo, AddonInfoList, AdminServer, AdminServersList, AggregatingTaskFactoryConfig, AllowContentTypes, AllowDomains, AltConnectionInfo, AltDBParamInfoList, AltDBParamSectionInfoList, ApplicationParameters, AppschemaDisabledSourceInfo, AppschemaDisabledSources, AreaLayerInfo, AreaLayersInfoList, ArgumentInfo, Assignments, BaseMapInfo, BaseMapsInfoList, BeanDefnImpl, BeanDefnsImpl, BeanFactory.BeanFactoryInfo, BeanFactory.BeanMappingInfo, BeanFactory.BeanMappingInfoList, BeanFactory.BeanPackageInfo, BeanFactory.BeanPackageInfoList, BeanInfo, BeanTaskConfig, BlockConfig, BlockLibraryConfig, BlockListConfig, BrowserSettingDefinition, BrowserSettingDefinitionList, ClientSideLayout, ConnectionInfo, ContentType, ContextInfo, ContextMenuInfo, ContextMenuList, ControllerInfo, ControllerInfoList, CustomThreshold, CustomThresholdBand, CustomThresholdBandList, CustomThresholdList, CustomThresholdsInfo, DBIDInfo, DBIDsInfoList, DBInfo, DBParamInfoList, DBParamSectionInfoList, DBParamValInfo, DBPreferenceInfo, DBPreferenceItem, DBPreferenceItemList, DBPreferencesInfoList, DBPropertiesInfo, DBsInfoList, DBTypeInfo, DBTypesInfoList, DBVersionInfo, DBVersionsInfoList, DBVLDBProperty, DBVLDBPropertyList, Definition, DenyDomains, Domain, DynamicMenus, ErrorInfo, ErrorInfo.ErrorMessage, ErrorInfo.ErrorTitle, ErrorInfoList, ESRICloudAppInfo, ESRICloudAppKeyInfo, ESRICloudAppsInfo, ESRICloudAppsInfoList, ESRIConfigurationInfo, ESRIGeoShapeInfo, ESRIGeoShapesInfoList, ESRIJSAPIUrlInfo, ESRIOnPremiseAttributeInfo, ESRIOnPremiseMapLayerUrlInfo, ESRIOnPremiseQueryFieldInfo, ESRIProxyURL, ESRIProxyURLList, ESRIURLPrefix, ESRIURLPrefixList, ESRIURLPrefixListNew, ESRIWebMapInfo, ESRIWebMapsInfoList, EventArgumentInfo, EventArgumentInfoList, EventFlagList, EventFlagListSet, EventHandlerInfo, EventHandlerInfo, EventHandlerList, EventHandlersCatalog, EventInfo, EventInfo, EventInfoList, EventList, EventListSet, EventMap, EventMap.EventMapArgument, EventMapList, ExportFormat, ExportFormatList, ExportPlaintextDelimiter, ExportPlaintextDelimiterList, FlagInfo, FolderLink, FolderMapping, FolderMappingList, GeoRoleInfo, GeoRolesInfoList, GeoShapeInfo, GeoShapesInfoList, GoogleChannel, GoogleConfigurationInfo, GoogleMapKeyInfo, GraphFormatInfoHelper.Attribute, GraphFormatInfoHelper.Exception, GraphFormatInfoHelper.Exceptions, GraphFormatInfoHelper.GraphAttribute, GraphFormatInfoHelper.GraphAttributes, GraphFormatInfoHelper.GraphFormatInfo, GraphFormatInfoHelper.GraphMajorType, GraphFormatInfoHelper.GraphMajorTypes, GraphFormatInfoHelper.GraphMinorType, GraphFormatInfoHelper.GraphMinorTypes, GraphFormatInfoHelper.GraphObject, GraphFormatInfoHelper.GraphObjects, GraphFormatInfoHelper.IncludeType, GraphFormatInfoHelper.IncludeTypes, IncludeBlock, IncludeDir, JavaScriptInfo, JavaScriptInfoList, LayoutImpl, LayoutParserDefnImpl, LayoutParserDefnsImpl, LayoutsImpl, LayoutSourceDefnImpl, LayoutSourceDefnsImpl, Macro, Macros, MapBoxConfigurationInfo, MapBoxTokenInfo, MapDecorations, MapNameConversionElement, MapNameConversions, MapperDefnImpl, MapperDefnsImpl, MapStyle, MapStyleJson, MapStyleList, MessageInfoImpl, MessagesManager, MicrostrategyAttributeInfo, MicrostrategyProjectInfoList, MicrostrategyProjectsInfoList, MSTRGeoShapeInfo, MSTRGeoShapesInfoList, MSTRShapeConfigurationInfo, MultiMapConfigurationInfo, ObjBrowserFolderLinks, PageInfo, PageInfoList, PageManager, PaperSizes, PaperSizesList, ParameterInfo, ParameterInfo.Description, ParameterInfoList, ProjectInfo, Property, Property, PropertySet, PropertySets, PropertyValue, ResourceFeedConfig, RibbonInfo, RibbonList, RibbonListSet, SectionInfo, SectionInfoList, ShapeConfigurationInfo, ShapeFileMap, ShapeFileMaps, ShapeKeyInfo, ShapeKeysInfoList, Shortcut, ShortcutArgument, ShortcutEvent, ShortcutList, ShortcutListSet, StaticSession, StaticSessionList, StyleCatalogImpl, StyleImpl, StyleInfo, StyleMapConditionImpl, StyleMapDefaultImpl, StyleMapImpl, StyleMapsImpl, StylesImpl, SysFolderBlackListHelper.SystemFolderNode, SystemPickerList, TaskFactoryInfo, TaskFactoryList, TaskFactoryParam, TaskFactoryParamList, TaskInfo, TaskMetadataImpl, TaskParameterMetadataImpl, TasksList, TemplateInfo, TemplateInfoList, ToolbarInfoList, TransformDefnImpl, TransformDefnsImpl, Transition, Transitions, UpdateFilterInfo, Visualization, VisualizationList, Visualizations, WebAttribute, WebAttributeList, WebBeanInfo, WebBeanInfoList, WebBeanProperty, WebBeanPropertyList, WebBeanStyle, WebBeanStyleList, WebGuiComponent, WebGuiComponentList, WebLoginProviderInfo, WebLoginProviderList, WebWrapperAttributeList, WhiteListCommandHelper, WhiteListCommandHelper.LibraryWhiteListCommandInfo, WhiteListCommandHelper.MobileWhiteListCommandInfo, WhiteListCommandHelper.WebWhiteListCommandInfo, WhiteListCommandHelper.WhiteListCommand, WhiteListCommandHelper.WhiteListCommandInfo, WidgetProp, WidgetProps

public interface ConfigurationFile

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.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
void	applyCustomization(CustomizationInfo c)	Applies the corresponding customizations.
void	applyCustomizations()	Loops through all the CustomizationInfo in the Customizations class and apply the corresponding customizations.
void	load(java.lang.String fileName)	Loads the file with the given name and initializes this ConfigurationFile with its content.
void	reload()	Reloads the content of this ConfigurationFile if the underlying configuration file has changed.
void	save()	Saves this ConfigurationFile back into the files where it was loaded from.
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.
void	setUseValidation(boolean value)	Defines whether the XML content should validated using a DTD.
boolean	useValidation()	Returns whether the XML content should be validated using a DTD.

Method Detail

load

void load(java.lang.String fileName)
   throws ConfigException

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

reload

void reload()
     throws ConfigException

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

Throws:

ConfigException

save

void save()
   throws ConfigException

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

Throws:

ConfigException

save

void save(CustomizationInfo c)
   throws ConfigException

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

Throws:

ConfigException

applyCustomizations

void applyCustomizations()
                  throws ConfigException

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

Throws:

ConfigException

applyCustomization

void applyCustomization(CustomizationInfo c)
                 throws ConfigException

Applies the corresponding customizations.

Throws:

ConfigException

setUseValidation

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.

useValidation

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).