org.eclipse.higgins.configuration.xml
Class ConfigurationHandler

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

All Implemented Interfaces:

org.eclipse.higgins.configuration.api.IConfigurationHandler

public class ConfigurationHandler

extends Object

implements org.eclipse.higgins.configuration.api.IConfigurationHandler

Author:

mikemci at us dot ibm dot com

Constructor Summary

ConfigurationHandler()
Constructor that initializes the class

Method Summary

void	applyUpdates()
boolean	configure(Map mapConfigurationSettings)
boolean	configure(org.apache.axiom.om.OMElement omConfiguration, Map mapConfigurationSettings)
boolean	configure(String strConfiguration, Map mapConfigurationSettings)
org.eclipse.higgins.configuration.api.ISettingDescriptor	getSettingDescriptor()
Map	getSettings()
static org.apache.axiom.om.OMElement	omFromFile(String strFileName)
static org.apache.axiom.om.OMElement	omFromStream(InputStream inputStream)
static void	omToFile(String strFileName, org.apache.axiom.om.OMElement omElement)
static void	omToStream(FileOutputStream outputStream, org.apache.axiom.om.OMElement omElement)
void	setConfigurationBase(String strBase)
void	setFileName(String strFile)
void	setGlobalSettingDescriptor(org.eclipse.higgins.configuration.api.ISettingDescriptor settingDescriptor)
void	setGlobalSettings(Map settings)
static org.apache.axiom.om.OMElement	toOM(String strElement)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationHandler

public ConfigurationHandler()

Constructor that initializes the class

Method Detail

getSettings

public Map getSettings()
                throws Exception

Specified by:

getSettings in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception

getSettingDescriptor

public org.eclipse.higgins.configuration.api.ISettingDescriptor getSettingDescriptor()
                                                                              throws Exception

Specified by:

getSettingDescriptor in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception

setConfigurationBase

public void setConfigurationBase(String strBase)

Specified by:

setConfigurationBase in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

setFileName

public void setFileName(String strFile)

applyUpdates

public void applyUpdates()
                  throws Exception

Specified by:

applyUpdates in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception

toOM

public static org.apache.axiom.om.OMElement toOM(String strElement)
                                          throws Exception

Throws:

Exception

omFromFile

public static org.apache.axiom.om.OMElement omFromFile(String strFileName)
                                                throws FileNotFoundException,
                                                       Exception

Throws:

FileNotFoundException

Exception

omToFile

public static void omToFile(String strFileName,
                            org.apache.axiom.om.OMElement omElement)
                     throws Exception

Throws:

Exception

omToStream

public static void omToStream(FileOutputStream outputStream,
                              org.apache.axiom.om.OMElement omElement)
                       throws Exception

Throws:

Exception

omFromStream

public static org.apache.axiom.om.OMElement omFromStream(InputStream inputStream)
                                                  throws FileNotFoundException,
                                                         Exception

Throws:

FileNotFoundException

Exception

configure

public boolean configure(Map mapConfigurationSettings)
                  throws Exception

Specified by:

configure in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception

configure

public boolean configure(String strConfiguration,
                         Map mapConfigurationSettings)
                  throws Exception

Throws:

Exception

configure

public boolean configure(org.apache.axiom.om.OMElement omConfiguration,
                         Map mapConfigurationSettings)
                  throws Exception

Throws:

Exception

setGlobalSettings

public void setGlobalSettings(Map settings)
                       throws Exception

Specified by:

setGlobalSettings in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception

setGlobalSettingDescriptor

public void setGlobalSettingDescriptor(org.eclipse.higgins.configuration.api.ISettingDescriptor settingDescriptor)
                                throws Exception

Specified by:

setGlobalSettingDescriptor in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception