org.rhq.enterprise.server.install.remote

Interface RemoteInstallManagerRemote

All Known Subinterfaces:

RemoteInstallManagerLocal

All Known Implementing Classes:

RemoteInstallManagerBean

public interface RemoteInstallManagerRemote

Provides an interface to remotely install an RHQ Agent over SSH.

Author:

Greg Hinkle

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) Deprecated. use installAgent(Subject, RemoteAccessInfo, CustomAgentInstallData)
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.

Method Detail

checkSSHConnection

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

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.

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

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.

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

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. 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".

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

Since:

4.11

installAgent

@Deprecated
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)

Deprecated. use installAgent(Subject, RemoteAccessInfo, CustomAgentInstallData)

Parameters:

subject -

remoteAccessInfo -

parentPath -

Returns:

info containing the results of the installation

uninstallAgent

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. 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.

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).

Since:

4.11

startAgent

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.

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

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.

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

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.

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

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). 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).

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

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.

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