org.rhq.enterprise.server.install.remote

Class RemoteInstallManagerBean

java.lang.Object

org.rhq.enterprise.server.install.remote.RemoteInstallManagerBean

All Implemented Interfaces:

RemoteInstallManagerLocal, RemoteInstallManagerRemote

public class RemoteInstallManagerBean
extends Object
implements RemoteInstallManagerLocal, RemoteInstallManagerRemote

Installs, starts and stops remote agents via SSH.

Author:

Greg Hinkle, John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
RemoteInstallManagerBean()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	agentInstallCheck(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo, String agentInstallPath) Checks to see if an agent is installed in the given directory.
String	agentStatus(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo, String agentInstallPath) Determines the running status of the agent located in the given installation directory.
void	checkSSHConnection(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo) Performs a fast connection check.
String	findAgentInstallPath(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo, String parentPath) Given a root parent path to check, this will scan all subdirectories (recursively) to try to find where the agent is installed (if it is installed at all).
org.rhq.core.domain.install.remote.AgentInstallInfo	installAgent(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo, org.rhq.core.domain.install.remote.CustomAgentInstallData customData) Installs the agent update binary distribution file to the given parent directory.
org.rhq.core.domain.install.remote.AgentInstallInfo	installAgent(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo, String parentPath)
String[]	remotePathDiscover(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo, String parentPath) Returns the given parent directory's child files/directories.
String	startAgent(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo, String agentInstallPath) Starts the agent located in the given installation directory.
String	stopAgent(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo, String agentInstallPath) Stops the agent located in the given installation directory.
String	uninstallAgent(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo, String agentInstallPath) Uninstalls the actual distribution files of an installed agent.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteInstallManagerBean

public RemoteInstallManagerBean()

Method Detail

checkSSHConnection

public void checkSSHConnection(org.rhq.core.domain.auth.Subject subject,
                      org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo)
                        throws org.rhq.core.domain.install.remote.SSHSecurityException

Description copied from interface: RemoteInstallManagerRemote

Performs a fast connection check. This will make an SSH connection to see if it can successfully be made. If it can, this method just returns. Any errors will cause an exception to be thrown.

Specified by:

checkSSHConnection in interface RemoteInstallManagerRemote

Parameters:

subject - the RHQ user making the request

remoteAccessInfo - the remote machine information and remote user SSH credentials

Throws:

org.rhq.core.domain.install.remote.SSHSecurityException - if the connection failed to be made due to things like the remote host is unknown.

agentInstallCheck

public boolean agentInstallCheck(org.rhq.core.domain.auth.Subject subject,
                        org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo,
                        String agentInstallPath)

Description copied from interface: RemoteInstallManagerRemote

Checks to see if an agent is installed in the given directory.

Specified by:

agentInstallCheck in interface RemoteInstallManagerRemote

Parameters:

subject - the RHQ user making the request

remoteAccessInfo - the remote machine information and remote user SSH credentials

agentInstallPath - the directory to check

Returns:

true if an agent is installed in the given install path, false if not

installAgent

public org.rhq.core.domain.install.remote.AgentInstallInfo installAgent(org.rhq.core.domain.auth.Subject subject,
                                                               org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo,
                                                               String parentPath)

Specified by:

installAgent in interface RemoteInstallManagerRemote

Returns:

info containing the results of the installation

installAgent

public org.rhq.core.domain.install.remote.AgentInstallInfo installAgent(org.rhq.core.domain.auth.Subject subject,
                                                               org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo,
                                                               org.rhq.core.domain.install.remote.CustomAgentInstallData customData)

Description copied from interface: RemoteInstallManagerRemote

Installs the agent update binary distribution file to the given parent directory. Note that the agent's install directory will be a child of the given parent directory, with that child install directory usually named "rhq-agent".

Specified by:

installAgent in interface RemoteInstallManagerRemote

Parameters:

subject - the RHQ user making the request

remoteAccessInfo - the remote machine information and remote user SSH credentials

customData - contains custom install details such as where the agent install directory will be

Returns:

info containing the results of the installation

uninstallAgent

public String uninstallAgent(org.rhq.core.domain.auth.Subject subject,
                    org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo,
                    String agentInstallPath)

Description copied from interface: RemoteInstallManagerRemote

Uninstalls the actual distribution files of an installed agent. You must give a valid agent name in the remote access info and that agent name must have its install location in the database for this to work. We purposefully do not allow you to give just any path to uninstall as that could have bad implications such as wiping out large portions of the disk as a mistake.

Specified by:

uninstallAgent in interface RemoteInstallManagerRemote

Parameters:

subject - the RHQ user making the request

remoteAccessInfo - the remote machine information and remote user SSH credentials including the name of the agent.

Returns:

the results of the uninstall - this will be null if there was no install information for the given agent (and thus nothing was uninstalled).

startAgent

public String startAgent(org.rhq.core.domain.auth.Subject subject,
                org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo,
                String agentInstallPath)

Description copied from interface: RemoteInstallManagerRemote

Starts the agent located in the given installation directory.

Specified by:

startAgent in interface RemoteInstallManagerRemote

Parameters:

subject - the RHQ user making the request

remoteAccessInfo - the remote machine information and remote user SSH credentials

agentInstallPath - where the agent is installed

Returns:

results of the start command

stopAgent

public String stopAgent(org.rhq.core.domain.auth.Subject subject,
               org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo,
               String agentInstallPath)

Description copied from interface: RemoteInstallManagerRemote

Stops the agent located in the given installation directory.

Specified by:

stopAgent in interface RemoteInstallManagerRemote

Parameters:

subject - the RHQ user making the request

remoteAccessInfo - the remote machine information and remote user SSH credentials

agentInstallPath - where the agent is installed

Returns:

results of the stop command

agentStatus

public String agentStatus(org.rhq.core.domain.auth.Subject subject,
                 org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo,
                 String agentInstallPath)

Description copied from interface: RemoteInstallManagerRemote

Determines the running status of the agent located in the given installation directory.

Specified by:

agentStatus in interface RemoteInstallManagerRemote

Parameters:

subject - the RHQ user making the request

remoteAccessInfo - the remote machine information and remote user SSH credentials

agentInstallPath - where the agent is installed

Returns:

results of the status command

findAgentInstallPath

public String findAgentInstallPath(org.rhq.core.domain.auth.Subject subject,
                          org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo,
                          String parentPath)

Description copied from interface: RemoteInstallManagerRemote

Given a root parent path to check, this will scan all subdirectories (recursively) to try to find where the agent is installed (if it is installed at all). If parentPath is null or empty, the more common locations where agents are normally installed will be scanned. Returns the path to the first location where an agent is probably installed; null is returned if it does not look like the agent is installed anywhere under the given parent path (or in any of the common locations, if parent path is null).

Specified by:

findAgentInstallPath in interface RemoteInstallManagerRemote

Parameters:

subject - the RHQ user making the request

remoteAccessInfo - the remote machine information and remote user SSH credentials

parentPath - the parent directory whose children files/directories are scanned

Returns:

the probable location of an installed agent; null if no agent install was found

remotePathDiscover

public String[] remotePathDiscover(org.rhq.core.domain.auth.Subject subject,
                          org.rhq.core.domain.install.remote.RemoteAccessInfo remoteAccessInfo,
                          String parentPath)

Description copied from interface: RemoteInstallManagerRemote

Returns the given parent directory's child files/directories.

Specified by:

remotePathDiscover in interface RemoteInstallManagerRemote

Parameters:

subject - the RHQ user making the request

remoteAccessInfo - the remote machine information and remote user SSH credentials

parentPath - the parent directory whose children files/directories are returned

Returns:

names of the parent's child files/directories