org.eclipse.higgins.configuration.xml
Class IncludeHandler

java.lang.Object
  org.eclipse.higgins.configuration.xml.IncludeHandler

All Implemented Interfaces:

ISettingHandler

public class IncludeHandler

extends Object

implements ISettingHandler

Creates a new ConfigurationHandler object, pointing to specified file name. Reads that configuration file and returns settings.

Author:

gbyrd

Constructor Summary

IncludeHandler()

Method Summary

Object

getSetting(String strName, String strConfigurationBase, Map mapSettingHandlers, Map mapSettingsGlobal, Object settingsParent, org.eclipse.higgins.configuration.api.ISettingDescriptor globalDescriptor, org.eclipse.higgins.configuration.api.ISettingDescriptor settingDescriptor, org.apache.axiom.om.OMElement omSetting) Method to convert XML element (omSetting) to an object that will be placed into a configuration map.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IncludeHandler

public IncludeHandler()

Method Detail

getSetting

public Object getSetting(String strName,
                         String strConfigurationBase,
                         Map mapSettingHandlers,
                         Map mapSettingsGlobal,
                         Object settingsParent,
                         org.eclipse.higgins.configuration.api.ISettingDescriptor globalDescriptor,
                         org.eclipse.higgins.configuration.api.ISettingDescriptor settingDescriptor,
                         org.apache.axiom.om.OMElement omSetting)
                  throws Exception

Description copied from interface: ISettingHandler

Method to convert XML element (omSetting) to an object that will be placed into a configuration map. The type of the returned object is implicitly determined by the class implementing the ISettingHandler interface.

Specified by:

getSetting in interface ISettingHandler

Parameters:

strName - Name of setting being processed.

strConfigurationBase - Configuration directory (used for file-oriented settings).

mapSettingHandlers - Map that associates types with ISettingHandler classes.

mapSettingsGlobal - Configuration map containing top-level settings that might be needed for this setting. (E.g., a certificate handler might need information about a previously-configured keystore component.)

settingsParent - Configuration map or list (if any) that will contain this setting.

omSetting - XML element that is being converted to Object.

Returns:

Object that will be put into a configuration Map, associated with given name.

Throws:

Exception