org.rhq.enterprise.server.installer

Class ServerInstallUtil

java.lang.Object

org.rhq.enterprise.server.installer.ServerInstallUtil

public class ServerInstallUtil
extends Object

Provides utility methods necessary to complete the server installation.

Author:

John Mazzitelli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerInstallUtil.ExistingSchemaOption
static class	ServerInstallUtil.SupportedDatabaseType

Constructor Summary

Constructors

Constructor and Description
ServerInstallUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	configureDeploymentScanner(org.jboss.as.controller.client.ModelControllerClient mcc) Configure the deployment scanner.
static void	configureLogging(org.jboss.as.controller.client.ModelControllerClient mcc, HashMap<String,String> serverProperties) Configure the logging subsystem.
static void	configureTransactionManager(org.jboss.as.controller.client.ModelControllerClient mcc) Configure the transaction manager.
static void	createDatasourceSecurityDomain(org.jboss.as.controller.client.ModelControllerClient mcc, HashMap<String,String> serverProperties) Creates the security domain for the datasources.
static void	createDefaultManagementUser(String password, ServerDetails serverDetails, String configDirStr) Create an rhqadmin management user so when discovered, the AS7 plugin can use it to connect to the RHQ Server.
static File	createKeystore(ServerDetails serverDetails, String configDirStr) Creates a keystore whose cert has a CN of this server's public endpoint address.
static void	createNewCaches(org.jboss.as.controller.client.ModelControllerClient mcc, HashMap<String,String> serverProperties) Creates the Infinispan caches for RHQ.
static void	createNewDatabaseSchema(HashMap<String,String> props, ServerDetails serverDetails, String password, String logDir) This will create the database schema in the database.
static void	createNewDatasources(org.jboss.as.controller.client.ModelControllerClient mcc, HashMap<String,String> serverProperties) Creates the datasources needed by the RHQ Server.
static void	createNewJdbcDrivers(org.jboss.as.controller.client.ModelControllerClient mcc, HashMap<String,String> serverProperties) Creates JDBC driver configurations so the datasources can properly connect to the backend databases.
static void	createNewJMSQueues(org.jboss.as.controller.client.ModelControllerClient mcc, HashMap<String,String> serverProperties) Creates the JMS Queues required for Drift and Alerting.
static void	createRestSecurityDomain(org.jboss.as.controller.client.ModelControllerClient mcc) Create a security domain for container managed security used with the rhq-rest.war
static void	createUserSecurityDomain(org.jboss.as.controller.client.ModelControllerClient mcc) Create the standard user security domain with the JDBCLogin module installed
static void	ensureDatabaseIsSupported(String connectionUrl, String username, String password) Call this when you need to confirm that the database is supported.
static Map<String,String>	fetchStorageClusterSettings(HashMap<String,String> serverProperties, String password)
static Connection	getDatabaseConnection(String connectionUrl, String userName, String password) Returns a database connection with the given set of properties providing the settings that allow for a successful database connection.
static ServerDetails	getServerDetails(String connectionUrl, String username, String password, String serverName) Returns information on the server as found in the database (port numbers, affinity group, etc).
static ArrayList<String>	getServerNames(String connectionUrl, String username, String password) Get the list of existing servers from an existing schema.
static ServerInstallUtil.SupportedDatabaseType	getSupportedDatabaseType(HashMap<String,String> serverProperties) Give the server properties, this returns the type of database that will be connected to.
static ServerInstallUtil.SupportedDatabaseType	getSupportedDatabaseType(String dbType) Give the database type string, this returns the type of database that it refers to.
static boolean	isAutoinstallEnabled(HashMap<String,String> serverProperties) Determines if we are in auto-install mode.
static boolean	isDatabaseSchemaExist(String connectionUrl, String username, String password) Returns true if the database already has the database schema created for it.
static boolean	isEmpty(String s) Given a server property value string, returns true if it is not specified.
static void	persistStorageClusterSettingsIfNecessary(HashMap<String,String> serverProperties, String password)
static void	persistStorageNodesIfNecessary(HashMap<String,String> serverProperties, String password, Set<org.rhq.core.domain.cloud.StorageNode> storageNodes) Persists the storage nodes to the database only if no storage node entities already exist.
static void	setSocketBindings(org.jboss.as.controller.client.ModelControllerClient mcc, HashMap<String,String> serverProperties)
static void	setupMailService(org.jboss.as.controller.client.ModelControllerClient mcc, HashMap<String,String> serverProperties) Prepares the mail service by configuring the SMTP settings.
static void	setupWebConnectors(org.jboss.as.controller.client.ModelControllerClient mcc, String configDirStr, HashMap<String,String> serverProperties) Ensures our web connectors are configured properly.
static void	storeServerDetails(HashMap<String,String> serverProperties, String password, ServerDetails serverDetails) Stores the server details (such as the public endpoint) in the database.
static String	testConnection(String connectionUrl, String username, String password) Tests to make sure the server can be connected to with the given settings.
static void	upgradeExistingDatabaseSchema(HashMap<String,String> props, ServerDetails serverDetails, String password, String logDir) This will update an existing database schema so it can be upgraded to the latest schema version.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerInstallUtil

public ServerInstallUtil()

Method Detail

configureLogging

public static void configureLogging(org.jboss.as.controller.client.ModelControllerClient mcc,
                    HashMap<String,String> serverProperties)
                             throws Exception

Configure the logging subsystem.

Parameters:

mcc - JBossAS management client

serverProperties - the server properties, which includes the default log level to use

Throws:

Exception

configureTransactionManager

public static void configureTransactionManager(org.jboss.as.controller.client.ModelControllerClient mcc)
                                        throws Exception

Configure the transaction manager.

Parameters:

mcc - JBossAS management client

Throws:

Exception

configureDeploymentScanner

public static void configureDeploymentScanner(org.jboss.as.controller.client.ModelControllerClient mcc)
                                       throws Exception

Configure the deployment scanner.

Parameters:

mcc - JBossAS management client

Throws:

Exception

setupMailService

public static void setupMailService(org.jboss.as.controller.client.ModelControllerClient mcc,
                    HashMap<String,String> serverProperties)
                             throws Exception

Prepares the mail service by configuring the SMTP settings.

Parameters:

mcc - JBossAS management client

serverProperties - the server's properties

Throws:

Exception

getSupportedDatabaseType

public static ServerInstallUtil.SupportedDatabaseType getSupportedDatabaseType(HashMap<String,String> serverProperties)

Give the server properties, this returns the type of database that will be connected to.

Parameters:

serverProperties -

Returns:

the type of DB

getSupportedDatabaseType

public static ServerInstallUtil.SupportedDatabaseType getSupportedDatabaseType(String dbType)

Give the database type string, this returns the type of database that it refers to.

Parameters:

dbType - the database type string

Returns:

the type of DB

createDatasourceSecurityDomain

public static void createDatasourceSecurityDomain(org.jboss.as.controller.client.ModelControllerClient mcc,
                                  HashMap<String,String> serverProperties)
                                           throws Exception

Creates the security domain for the datasources. This is needed to support obfuscation of the password in the configuration file.

Parameters:

mcc - the JBossAS management client

serverProperties - contains the obfuscated password to store in the security domain

Throws:

Exception

createUserSecurityDomain

public static void createUserSecurityDomain(org.jboss.as.controller.client.ModelControllerClient mcc)
                                     throws Exception

Create the standard user security domain with the JDBCLogin module installed

Parameters:

mcc - ModelControllerClient to talk to the underlying AS

Throws:

Exception - If anything goes wrong

createRestSecurityDomain

public static void createRestSecurityDomain(org.jboss.as.controller.client.ModelControllerClient mcc)
                                     throws Exception

Create a security domain for container managed security used with the rhq-rest.war

Parameters:

mcc - ModelControllerClient to talk to the underlying AS.

Throws:

Exception - If anything goes wrong

createNewJMSQueues

public static void createNewJMSQueues(org.jboss.as.controller.client.ModelControllerClient mcc,
                      HashMap<String,String> serverProperties)
                               throws Exception

Creates the JMS Queues required for Drift and Alerting.

Parameters:

mcc - the JBossAS management client

serverProperties - contains the obfuscated password to store in the security domain

Throws:

Exception

createNewCaches

public static void createNewCaches(org.jboss.as.controller.client.ModelControllerClient mcc,
                   HashMap<String,String> serverProperties)
                            throws Exception

Creates the Infinispan caches for RHQ.

Parameters:

mcc - the JBossAS management client

serverProperties - contains the obfuscated password to store in the security domain

Throws:

Exception

createNewJdbcDrivers

public static void createNewJdbcDrivers(org.jboss.as.controller.client.ModelControllerClient mcc,
                        HashMap<String,String> serverProperties)
                                 throws Exception

Creates JDBC driver configurations so the datasources can properly connect to the backend databases. This will attempt to create drivers for all supported databases, not just for the database type that is currently configured.

Parameters:

mcc -

serverProperties -

Throws:

Exception

createNewDatasources

public static void createNewDatasources(org.jboss.as.controller.client.ModelControllerClient mcc,
                        HashMap<String,String> serverProperties)
                                 throws Exception

Creates the datasources needed by the RHQ Server.

Parameters:

mcc - the JBossAS management client

serverProperties - properties to help determine the properties of the datasources to be created

Throws:

Exception

isAutoinstallEnabled

public static boolean isAutoinstallEnabled(HashMap<String,String> serverProperties)

Determines if we are in auto-install mode. This means the properties file is fully configured and the installation can begin without asking the user for more input.

Parameters:

serverProperties - the full set of server properties

Returns:

true if we are in auto-install mode; false if the user must give us more information before we can complete the installation.

isDatabaseSchemaExist

public static boolean isDatabaseSchemaExist(String connectionUrl,
                            String username,
                            String password)
                                     throws Exception

Returns true if the database already has the database schema created for it. It will not be known what version of schema or if its the latest, all this method tells you is that some RHQ database schema exists.

Parameters:

connectionUrl -

username -

password -

Returns:

true if the database can be connected to

Throws:

Exception - if failed to communicate with the database

getServerNames

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

Get the list of existing servers from an existing schema.

Parameters:

connectionUrl -

username -

password -

Returns:

List of server names registered in the database. Empty list if the table does not exist or there are no entries in the table.

Throws:

Exception - if failed to communicate with the database

getServerDetails

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

Returns information on the server as found in the database (port numbers, affinity group, etc).

Parameters:

connectionUrl -

username -

password -

serverName - the server whose details are to be returned

Returns:

the information on the named server

testConnection

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

Tests to make sure the server can be connected to with the given settings. If the test is successful, null. If the test fails, the returned string will be the error message to indicate the problem.

Parameters:

connectionUrl -

username -

password -

Returns:

error message if test failed; null if test succeeded

ensureDatabaseIsSupported

public static void ensureDatabaseIsSupported(String connectionUrl,
                             String username,
                             String password)
                                      throws Exception

Call this when you need to confirm that the database is supported.

Parameters:

connectionUrl -

username -

password -

Throws:

Exception - if the database is not supported

getDatabaseConnection

public static Connection getDatabaseConnection(String connectionUrl,
                               String userName,
                               String password)
                                        throws SQLException

Returns a database connection with the given set of properties providing the settings that allow for a successful database connection. If props is null, it will use the server properties from #getServerProperties.

Parameters:

connectionUrl -

userName -

password -

Returns:

the database connection

Throws:

SQLException - if cannot successfully connect to the database

persistStorageNodesIfNecessary

public static void persistStorageNodesIfNecessary(HashMap<String,String> serverProperties,
                                  String password,
                                  Set<org.rhq.core.domain.cloud.StorageNode> storageNodes)
                                           throws Exception

Persists the storage nodes to the database only if no storage node entities already exist. This method is used to persist storage nodes created from the rhq.storage.nodes server configuration property. The only time those seed nodes should be created is during an initial server installation. After the initial installation storage nodes should be created using rhqctl install. This ensures that any necessary cluster maintenance tasks will be performed.

Parameters:

serverProperties - the server properties

password - clear text password to connect to the database

storageNodes - the storage nodes to persist

Throws:

Exception

fetchStorageClusterSettings

public static Map<String,String> fetchStorageClusterSettings(HashMap<String,String> serverProperties,
                                             String password)
                                                      throws Exception

Throws:

Exception

persistStorageClusterSettingsIfNecessary

public static void persistStorageClusterSettingsIfNecessary(HashMap<String,String> serverProperties,
                                            String password)
                                                     throws Exception

Throws:

Exception

storeServerDetails

public static void storeServerDetails(HashMap<String,String> serverProperties,
                      String password,
                      ServerDetails serverDetails)
                               throws Exception

Stores the server details (such as the public endpoint) in the database. If the server definition already exists, it will be updated; otherwise, a new server will be added to the HA cloud.

Parameters:

serverProperties - the server properties

password - clear text password to connect to the database

serverDetails - the details of the server to put into the database

Throws:

Exception

createNewDatabaseSchema

public static void createNewDatabaseSchema(HashMap<String,String> props,
                           ServerDetails serverDetails,
                           String password,
                           String logDir)
                                    throws Exception

This will create the database schema in the database. props define the connection to the database -

Note that if the schema already exists, it will be purged of all data/tables and recreated.

Parameters:

props - the full set of server properties

serverDetails - additional information about the server being installed

password - the database password in clear text

logDir - a directory where the db schema upgrade logs can be written

Throws:

Exception - if failed to create the new schema for some reason

upgradeExistingDatabaseSchema

public static void upgradeExistingDatabaseSchema(HashMap<String,String> props,
                                 ServerDetails serverDetails,
                                 String password,
                                 String logDir)
                                          throws Exception

This will update an existing database schema so it can be upgraded to the latest schema version.

Note that if the schema does not already exist, errors will occur.

Parameters:

props - the full set of server properties

serverDetails - additional information about the server being installed

password - the database password in clear text

logDir - a directory where the db schema upgrade logs can be written

Throws:

Exception - if the upgrade failed for some reason

isEmpty

public static boolean isEmpty(String s)

Given a server property value string, returns true if it is not specified.

Parameters:

s - the property string value

Returns:

true if it is null or empty

setupWebConnectors

public static void setupWebConnectors(org.jboss.as.controller.client.ModelControllerClient mcc,
                      String configDirStr,
                      HashMap<String,String> serverProperties)
                               throws Exception

Ensures our web connectors are configured properly.

Parameters:

mcc - the AS client

configDirStr - location of a configuration directory where the keystore is to be stored

serverProperties - the full set of server properties

Throws:

Exception

createKeystore

public static File createKeystore(ServerDetails serverDetails,
                  String configDirStr)

Creates a keystore whose cert has a CN of this server's public endpoint address.

Parameters:

serverDetails - details of the server being installed - must not be null and endpoint must be included in it

configDirStr - location of a configuration directory where the keystore is to be stored

Returns:

where the keystore file should be created (if an error occurs, this file won't exist)

createDefaultManagementUser

public static void createDefaultManagementUser(String password,
                               ServerDetails serverDetails,
                               String configDirStr)

Create an rhqadmin management user so when discovered, the AS7 plugin can use it to connect to the RHQ Server. The password is set in rhq-server.properties. Because the plugin can't guess the password, if not set to the default then the AS7 plugin will fail to connect, and the RHQ Server resource connection properties will need to be updated after discovery and import.

Parameters:

password - the management password

serverDetails - details of the server being installed

configDirStr - location of a configuration directory where the mgmt-users.properties file lives

setSocketBindings

public static void setSocketBindings(org.jboss.as.controller.client.ModelControllerClient mcc,
                     HashMap<String,String> serverProperties)
                              throws Exception

Throws:

Exception