org.jboss.as.jdr

Class SoSReport

java.lang.Object

org.jboss.as.jdr.SoSReport

public class SoSReport
extends Object

Provides an encapsulated interface to the jython interpreter for executing sosreport

Author:

Jesse Jaggars, Mike M. Clark

Constructor Summary

Constructors

Constructor and Description
SoSReport(org.python.util.PythonInterpreter interpreter, String pyLocation, String jbossHomeDir)

Method Summary

Methods

Modifier and Type	Method and Description
void	enableOption(String name) Enables a flag-like option for sosreport.
String	execute() Executes sosreport and returns the path to the final archived report
void	setCompressionType(CompressionType type) Sets the method of compressing the report archive.
void	setControllerClient(ModelControllerClient controllerClient) Sets the ModelControllerClient instance for sosreport to use.
void	setGlobal(String name, Object value) Sets a globally visible variable for use within sosreport.
void	setHome(String homeDir) Sets JBOSS_HOME for sosreport to use
void	setHostControllerName(String hostControllerName) Sets the host controller name for sosreport to use This is null in standalone mode
void	setHostname(String hostname) Sets the hostname for the management api that sosreport should contact.
void	setOption(String name, String value) Sets a configuration option for sosreport.
void	setPassword(String password) Sets the management api password for sosreport to use
void	setPort(String port) Sets the port for the management api that sosreport should contact.
void	setServerName(String serverName) Sets the server instance name for sosreport to use This is null in standalone mode
void	setTmpDir(String tmpDir) Sets the temporary directory for sosreport to use.
void	setUsername(String username) Sets the management api username for sosreport to use

Methods inherited from class java.lang.Object

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

Constructor Detail

SoSReport

public SoSReport(org.python.util.PythonInterpreter interpreter,
         String pyLocation,
         String jbossHomeDir)

Parameters:

interpreter - the jython interpreter instance to use

pyLocation - the full path to the jar containing sosreport

jbossHomeDir - the full path to JBOSS_HOME

Method Detail

execute

public String execute()

Executes sosreport and returns the path to the final archived report

Returns:

the full path to the report archive

setOption

public void setOption(String name,
             String value)

Sets a configuration option for sosreport.

Parameters:

name - the name of the option

value - the value of the option

enableOption

public void enableOption(String name)

Enables a flag-like option for sosreport.

Parameters:

name - the name of the option

setGlobal

public void setGlobal(String name,
             Object value)

Sets a globally visible variable for use within sosreport.

Parameters:

name - the name of the variable

value - the value of the variable, must be adaptable by Jython

setCompressionType

public void setCompressionType(CompressionType type)

Sets the method of compressing the report archive.

Parameters:

type - the type of compression to use

setControllerClient

public void setControllerClient(ModelControllerClient controllerClient)

Sets the ModelControllerClient instance for sosreport to use.

Parameters:

controllerClient - the ModelControllerClient instance to use

Throws:

IllegalArgumentException - if controllerClient is null

setTmpDir

public void setTmpDir(String tmpDir)

Sets the temporary directory for sosreport to use.

Parameters:

tmpDir - the path to the temporary directory to use

setUsername

public void setUsername(String username)

Sets the management api username for sosreport to use

Parameters:

username - the management api username to use

setPassword

public void setPassword(String password)

Sets the management api password for sosreport to use

Parameters:

password - the management api password to use

setHostname

public void setHostname(String hostname)

Sets the hostname for the management api that sosreport should contact.

Parameters:

hostname - the hostname to use

setPort

public void setPort(String port)

Sets the port for the management api that sosreport should contact.

Parameters:

port - the port to use

setHome

public void setHome(String homeDir)

Sets JBOSS_HOME for sosreport to use

Parameters:

homeDir - the path to JBOSS_HOME

setHostControllerName

public void setHostControllerName(String hostControllerName)

Sets the host controller name for sosreport to use This is null in standalone mode

Parameters:

hostControllerName - the host controller name to use

setServerName

public void setServerName(String serverName)

Sets the server instance name for sosreport to use This is null in standalone mode

Parameters:

serverName - the server instance name to use