org.rhq.enterprise.server.installer

Class InstallerServiceImpl

java.lang.Object

org.rhq.enterprise.server.installer.InstallerServiceImpl

All Implemented Interfaces:

InstallerService

public class InstallerServiceImpl
extends Object
implements InstallerService

Author:

John Mazzitelli

Nested Class Summary

Nested classes/interfaces inherited from interface org.rhq.enterprise.server.installer.InstallerService

InstallerService.AlreadyInstalledException, InstallerService.AutoInstallDisabledException

Constructor Summary

Constructors

Constructor and Description
InstallerServiceImpl(InstallerConfiguration config)

Method Summary

Methods

Modifier and Type	Method and Description
ArrayList<ServerDetails>	getAllServerDetails(String connectionUrl, String username, String password) Returns details on all servers that are registered in the database.
String	getAppServerVersion() Returns the version string for the app server itself (e.g.
String	getInstallationResults() Use this to determine if the server has already been completely installed or not.
String	getOperatingSystem() Returns the general type of operating system the server is running on (e.g.
ServerDetails	getServerDetails(String connectionUrl, String username, String password, String serverName) Returns details on a specific server that is registered in the database.
ArrayList<String>	getServerNames(String connectionUrl, String username, String password) Returns a list of all registered servers in the database.
HashMap<String,String>	getServerProperties() Returns the rhq-server.properties values in a map.
void	install(HashMap<String,String> serverProperties, ServerDetails serverDetails, String existingSchemaOption) Starts the installation process.
boolean	isDatabaseSchemaExist(String connectionUrl, String username, String password) Tests to see if there is already a schema installed.
void	listServers() This simply logs a list of all known registered servers found in the database.
String	obfuscatePassword(String clearTextPassword) Given a database password, this will obfuscate it.
HashMap<String,String>	preInstall() Call this prior to installing to see if we are ready to install.
void	prepareDatabase(HashMap<String,String> serverProperties, ServerDetails serverDetails, String existingSchemaOption) Prepares the database.
boolean	reconfigure(HashMap<String,String> serverProperties) This will take server properties and reconfigure an already-installed server with those values if the settings were previously hardcoded to old values (as opposed to being set to expressions that allow them to be overridden with system property settings).
void	test() This simply verifies the server configuration but doesn't perform the actual install.
String	testConnection(String connectionUrl, String username, String password) Tests that the database can be connected to with the given URL and credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstallerServiceImpl

public InstallerServiceImpl(InstallerConfiguration config)

Method Detail

obfuscatePassword

public String obfuscatePassword(String clearTextPassword)
                         throws Exception

Description copied from interface: InstallerService

Given a database password, this will obfuscate it. The obfuscated password should be used within rhq-server.properties.

Specified by:

obfuscatePassword in interface InstallerService

Parameters:

clearTextPassword - the password to obfuscate

Returns:

the obfuscated password

Throws:

Exception

listServers

public void listServers()
                 throws Exception

Description copied from interface: InstallerService

This simply logs a list of all known registered servers found in the database.

Specified by:

listServers in interface InstallerService

Throws:

Exception

test

public void test()
          throws InstallerService.AutoInstallDisabledException,
                 InstallerService.AlreadyInstalledException,
                 Exception

Description copied from interface: InstallerService

This simply verifies the server configuration but doesn't perform the actual install. You can use this to see if, for example, the database settings are correct or the installer can successfully connect to the running AS instance where RHQ is to be installed.

Specified by:

test in interface InstallerService

Throws:

InstallerService.AutoInstallDisabledException - if the server configuration properties does not have auto-install enabled

InstallerService.AlreadyInstalledException - if it appears the installer was already run and the server is fully installed

Exception - some other exception that should disallow the installation from continuing

preInstall

public HashMap<String,String> preInstall()
                                  throws InstallerService.AutoInstallDisabledException,
                                         InstallerService.AlreadyInstalledException,
                                         Exception

Description copied from interface: InstallerService

Call this prior to installing to see if we are ready to install. This will do some pre-install checks - if the installation should proceed, the map of server properties is returned. Exceptions are thrown if the install should not proceed.

Specified by:

preInstall in interface InstallerService

Returns:

properties if the caller should next call InstallerService.install(HashMap, ServerDetails, String).

Throws:

InstallerService.AutoInstallDisabledException - if the server configuration properties does not have auto-install enabled

InstallerService.AlreadyInstalledException - if it appears the installer was already run and the server is fully installed

Exception - some other exception that should disallow the installation from continuing

getInstallationResults

public String getInstallationResults()
                              throws Exception

Description copied from interface: InstallerService

Use this to determine if the server has already been completely installed or not. This returns a String to indicate the last installation attempt. If this returns null, then the installer has not done anything yet - you need to complete the installation. If an empty string is returned, it means the installer ran and it appears the application has successfully installed. If a non-empty string is returned, it means the installer attempted to complete the installation, but an error occurred. When a non-empty string is returned, it means that an administrator probably has to do some manual intervention because something went wrong with the application deployment.

Specified by:

getInstallationResults in interface InstallerService

Returns:

indicating of the last installation attempt (see above)

Throws:

Exception - if it cannot be determined if the server has been fully installed.

install

public void install(HashMap<String,String> serverProperties,
           ServerDetails serverDetails,
           String existingSchemaOption)
             throws InstallerService.AutoInstallDisabledException,
                    InstallerService.AlreadyInstalledException,
                    Exception

Description copied from interface: InstallerService

Starts the installation process. Once complete, the installer has nothing more it needs to do.

Specified by:

install in interface InstallerService

Parameters:

serverProperties - the server's settings to use. These will be persisted to the server's .properties file.

serverDetails - details on the server being installed. If in auto-install mode, this value is ignored and can be anything.

existingSchemaOption - if not in auto-install mode, this tells the installer what to do with any existing schema. Must be one of the names of the ServerInstallUtil.ExistingSchemaOption enum. If in auto-install mode, this value is ignored and can be anything.

Throws:

InstallerService.AutoInstallDisabledException - if the server configuration properties does not have auto-install enabled

InstallerService.AlreadyInstalledException - if it appears the installer was already run and the server is fully installed

Exception - some other exception that should disallow the installation from continuing

prepareDatabase

public void prepareDatabase(HashMap<String,String> serverProperties,
                   ServerDetails serverDetails,
                   String existingSchemaOption)
                     throws Exception

Description copied from interface: InstallerService

Prepares the database. This is either going to do a full clean db setup or a db upgrade depending on the existingSchemaOption parameter unless autoinstall setting is on, in which case the autoinstall schema setting in serverProperties parameter will tell this method what to do. NOTE: if not in auto-install mode, the database password is assumed to be in clear text (i.e. unencoded). If in auto-install mode, the database password must be encoded already.

Specified by:

prepareDatabase in interface InstallerService

Parameters:

serverProperties - the server's settings to use. These will be persisted to the server's .properties file.

serverDetails - details on the server being installed. If in auto-install mode, this value is ignored and can be anything.

existingSchemaOption - if not in auto-install mode, this tells the installer what to do with any existing schema. Must be one of the names of the ServerInstallUtil.ExistingSchemaOption enum. If in auto-install mode, this value is ignored and can be anything.

Throws:

Exception - failed to successfully prepare the database

getServerNames

public ArrayList<String> getServerNames(String connectionUrl,
                               String username,
                               String password)

Description copied from interface: InstallerService

Returns a list of all registered servers in the database.

Specified by:

getServerNames in interface InstallerService

Returns:

list of all existing servers registered in the database.

getAllServerDetails

public ArrayList<ServerDetails> getAllServerDetails(String connectionUrl,
                                           String username,
                                           String password)

Description copied from interface: InstallerService

Returns details on all servers that are registered in the database.

Specified by:

getAllServerDetails in interface InstallerService

Returns:

the details of all known servers

getServerDetails

public ServerDetails getServerDetails(String connectionUrl,
                             String username,
                             String password,
                             String serverName)

Description copied from interface: InstallerService

Returns details on a specific server that is registered in the database.

Specified by:

getServerDetails in interface InstallerService

serverName - the name of the server whose details are to be retrieved

Returns:

the details of the server or null if the server does not exist

isDatabaseSchemaExist

public boolean isDatabaseSchemaExist(String connectionUrl,
                            String username,
                            String password)

Description copied from interface: InstallerService

Tests to see if there is already a schema installed.

Specified by:

isDatabaseSchemaExist in interface InstallerService

Returns:

true if there appears to be a schema installed in the database already.

testConnection

public String testConnection(String connectionUrl,
                    String username,
                    String password)

Description copied from interface: InstallerService

Tests that the database can be connected to with the given URL and credentials.

Specified by:

testConnection in interface InstallerService

Returns:

null if the connection succeeded; this will be an error message if failed

getServerProperties

public HashMap<String,String> getServerProperties()
                                           throws Exception

Description copied from interface: InstallerService

Returns the rhq-server.properties values in a map.

Specified by:

getServerProperties in interface InstallerService

Returns:

server properties

Throws:

Exception

reconfigure

public boolean reconfigure(HashMap<String,String> serverProperties)
                    throws Exception

Description copied from interface: InstallerService

This will take server properties and reconfigure an already-installed server with those values if the settings were previously hardcoded to old values (as opposed to being set to expressions that allow them to be overridden with system property settings). Note that is function is here only to workaround various bugs in AS7 that force us to not be able to use expressions in certain app server subsystem attribute settings - see https://issues.jboss.org/browse/AS7-6120. Once this issues are fixed, this method will go away.

Specified by:

reconfigure in interface InstallerService

Parameters:

serverProperties - the new server properties

Returns:

true if the reconfigure was at least attempted; false if the server isn't ready to be reconfigured such as when it hasn't been fully installed yet

Throws:

Exception

getAppServerVersion

public String getAppServerVersion()
                           throws Exception

Description copied from interface: InstallerService

Returns the version string for the app server itself (e.g. "7.1.2.Final").

Specified by:

getAppServerVersion in interface InstallerService

Returns:

version string of app server

Throws:

Exception

getOperatingSystem

public String getOperatingSystem()
                          throws Exception

Description copied from interface: InstallerService

Returns the general type of operating system the server is running on (e.g. "Linux").

Specified by:

getOperatingSystem in interface InstallerService

Returns:

os type name

Throws:

Exception