org.wso2.esb.integration.common.utils.common

Class ServerConfigurationManager

java.lang.Object

org.wso2.esb.integration.common.utils.common.ServerConfigurationManager

public class ServerConfigurationManager
extends Object

This class can be used to replace configuration files at carbon server

Constructor Summary

Constructors

Constructor and Description
ServerConfigurationManager(org.wso2.carbon.automation.engine.context.AutomationContext autoCtx) Create a ServerConfigurationManager
ServerConfigurationManager(String productGroup, org.wso2.carbon.automation.engine.context.TestUserMode userMode) Create a ServerConfigurationManager

Method Summary

Modifier and Type	Method and Description
void	applyConfiguration(File newConfig) apply configuration file and restart server to take effect the configuration
void	applyConfiguration(File sourceFile, File targetFile) Methods to replace configuration files in products.
void	applyConfiguration(File sourceFile, File targetFile, boolean backupConfigFile, boolean restartServer)
void	applyConfigurationWithoutRestart(File newConfig) apply configuration file and restart server to take effect the configuration
void	applyConfigurationWithoutRestart(File sourceFile, File targetFile, boolean backup) Apply configuration from source file to a target file without restarting.
void	copyToComponentDropins(File jar) /** Copy Jar file to server component/dropins
void	copyToComponentLib(File jar) Copy Jar file to server component/lib
static String	getCarbonHome()
void	removeFromComponentDropins(String fileName)
void	removeFromComponentLib(String fileName)
void	restartForcefully() Restart Server forcefully from admin user
void	restartGracefully() Restart Server Gracefully from admin user
void	restartGracefully(long timeout) Restart Server Gracefully from admin user
void	restartGracefully(String sessionCookie) Restart server gracefully from current user session
void	restoreToLastConfiguration() restore to a last configuration and restart the server
void	restoreToLastConfiguration(boolean isRestartRequired) restore all files to last configuration and restart the server

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerConfigurationManager

public ServerConfigurationManager(String productGroup,
                                  org.wso2.carbon.automation.engine.context.TestUserMode userMode)
                           throws org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException,
                                  XPathExpressionException,
                                  MalformedURLException

Create a ServerConfigurationManager

Parameters:

productGroup - product group name

userMode - user mode

Throws:

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

XPathExpressionException

MalformedURLException

ServerConfigurationManager

public ServerConfigurationManager(org.wso2.carbon.automation.engine.context.AutomationContext autoCtx)
                           throws org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException,
                                  XPathExpressionException,
                                  MalformedURLException

Create a ServerConfigurationManager

Parameters:

autoCtx - automation context

Throws:

XPathExpressionException

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

MalformedURLException

Method Detail

getCarbonHome

public static String getCarbonHome()

Returns:

will return the carbon home. the location of the server instance

applyConfigurationWithoutRestart

public void applyConfigurationWithoutRestart(File sourceFile,
                                             File targetFile,
                                             boolean backup)
                                      throws IOException

Apply configuration from source file to a target file without restarting.

Parameters:

sourceFile - Source file to copy.

targetFile - Target file that is to be backed up and replaced.

backup - boolean value, set this to true if you want to backup the original file.

Throws:

IOException - - throws if apply configuration fails

applyConfiguration

public void applyConfiguration(File sourceFile,
                               File targetFile,
                               boolean backupConfigFile,
                               boolean restartServer)
                        throws org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException,
                               IOException

Parameters:

sourceFile - file of the new configuration file

targetFile - configuration file required to replace in the server. File must be created with the absolute path.

backupConfigFile - require to back the existing file

restartServer - require to restart the server after replacing the config file

Throws:

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

IOException

restoreToLastConfiguration

public void restoreToLastConfiguration()
                                throws IOException,
                                       org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException

restore to a last configuration and restart the server

Throws:

IOException

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

restoreToLastConfiguration

public void restoreToLastConfiguration(boolean isRestartRequired)
                                throws org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException,
                                       IOException

restore all files to last configuration and restart the server

Throws:

org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException - - throws if restore to last configuration fails

IOException - - throws if restore to last configuration fails

applyConfiguration

public void applyConfiguration(File newConfig)
                        throws org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException,
                               IOException

apply configuration file and restart server to take effect the configuration

Parameters:

newConfig - configuration file

Throws:

org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException - - throws if apply configuration fails

IOException - - throws if apply configuration fails

applyConfigurationWithoutRestart

public void applyConfigurationWithoutRestart(File newConfig)
                                      throws IOException

apply configuration file and restart server to take effect the configuration

Parameters:

newConfig - configuration file

Throws:

IOException - - throws if apply configuration fails

applyConfiguration

public void applyConfiguration(File sourceFile,
                               File targetFile)
                        throws org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException,
                               IOException

Methods to replace configuration files in products.

Parameters:

sourceFile - - configuration file to be copied for your local machine or carbon server it self.

targetFile - - configuration file in carbon server. e.g - path to axis2.xml in config directory

Throws:

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

IOException

restartGracefully

public void restartGracefully()
                       throws org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException

Restart Server Gracefully from admin user

Throws:

org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException - - throws if server restart fails

restartGracefully

public void restartGracefully(long timeout)
                       throws org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException

Restart Server Gracefully from admin user

Parameters:

timeout - - Server startup waiting time

Throws:

org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException - - throws if server restart fails

restartGracefully

public void restartGracefully(String sessionCookie)
                       throws org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException

Restart server gracefully from current user session

Parameters:

sessionCookie - session cookie

Throws:

org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException - - throws if server restart fails

restartForcefully

public void restartForcefully()
                       throws org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException

Restart Server forcefully from admin user

Throws:

org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException - - throws if forceful restart fails

copyToComponentLib

public void copyToComponentLib(File jar)
                        throws IOException,
                               URISyntaxException

Copy Jar file to server component/lib

Parameters:

jar - jar file

Throws:

IOException

URISyntaxException

removeFromComponentLib

public void removeFromComponentLib(String fileName)
                            throws IOException,
                                   URISyntaxException

Parameters:

fileName - file name

Throws:

IOException

URISyntaxException

copyToComponentDropins

public void copyToComponentDropins(File jar)
                            throws IOException,
                                   URISyntaxException

/** Copy Jar file to server component/dropins

Parameters:

jar - jar file

Throws:

IOException

URISyntaxException

removeFromComponentDropins

public void removeFromComponentDropins(String fileName)
                                throws IOException,
                                       URISyntaxException

Parameters:

fileName - file name

Throws:

IOException

URISyntaxException