org.wso2.mb.integration.common.utils.backend

Class ConfigurationEditor

java.lang.Object

org.wso2.mb.integration.common.utils.backend.ConfigurationEditor

public class ConfigurationEditor
extends Object

This class allows a test case to edit the main server configuration (currently broker.xml) and apply it to the server before execution.

Field Summary

Fields

Modifier and Type	Field and Description
org.apache.commons.configuration.XMLConfiguration	configuration Configuration property holder
String	originalConfigFilePath File path of the original configuration file.
static String	UPDATED_CONFIG_FILE_PREFIX File name prefix used for the updated configuration file.
String	updatedConfigFilePath File path of the updated configuration file.

Constructor Summary

Constructors

Constructor and Description
ConfigurationEditor(String originalConfigFilePath)

Method Summary

Modifier and Type	Method and Description
boolean	applyUpdatedConfigurationAndRestartServer(org.wso2.carbon.integration.common.utils.mgt.ServerConfigurationManager serverConfigurationManager) Apply modified configuration and restart server
String	updateProperty(org.wso2.andes.configuration.enums.AndesConfiguration property, String value) Update a property in loaded original configuration

Methods inherited from class java.lang.Object

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

Field Detail

UPDATED_CONFIG_FILE_PREFIX

public static final String UPDATED_CONFIG_FILE_PREFIX

File name prefix used for the updated configuration file.

See Also:

Constant Field Values

configuration

public org.apache.commons.configuration.XMLConfiguration configuration

Configuration property holder

originalConfigFilePath

public String originalConfigFilePath

File path of the original configuration file.

updatedConfigFilePath

public String updatedConfigFilePath

File path of the updated configuration file.

Constructor Detail

ConfigurationEditor

public ConfigurationEditor(String originalConfigFilePath)
                    throws org.apache.commons.configuration.ConfigurationException

Throws:

org.apache.commons.configuration.ConfigurationException

Method Detail

updateProperty

public String updateProperty(org.wso2.andes.configuration.enums.AndesConfiguration property,
                             String value)

Update a property in loaded original configuration

Parameters:

property - AndesConfiguration property.

value - New value to be set

Returns:

the set value

applyUpdatedConfigurationAndRestartServer

public boolean applyUpdatedConfigurationAndRestartServer(org.wso2.carbon.integration.common.utils.mgt.ServerConfigurationManager serverConfigurationManager)
                                                  throws IOException,
                                                         org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException,
                                                         org.apache.commons.configuration.ConfigurationException

Apply modified configuration and restart server

Parameters:

serverConfigurationManager - Server configuration manager object from automation engine.

Returns:

true if the update was successful.

Throws:

IOException

org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException

org.apache.commons.configuration.ConfigurationException