com.jivesoftware.forum.util
Class SystemInfoReporter

java.lang.Object
  com.jivesoftware.forum.util.SystemInfoReporter

public class SystemInfoReporter
extends java.lang.Object

This class is responsible for collecting a snapshot of the system including the configuration, license information, JVM, application server, database info, and content summary/growth statistics.

Once the collector has the information it sends it to a Jive Software service which can store the data for future support of the specific customer.

Field Summary

static java.lang.String	APP_SERVER_PREFIX
static java.lang.String	DATABASE_PREFIX
static java.lang.String	JAVA_PREFIX
static java.lang.String	JIVE_CONFIG_PREFIX
static java.lang.String	JIVE_INFO_PREFIX
static java.lang.String	JIVE_LICENSE_PREFIX
static java.lang.String	NOT_AVAILABLE
protected java.util.Map	sysInfo
static java.lang.String	SYSTEM_PREFIX

Constructor Summary

SystemInfoReporter()

Method Summary

protected void	collectAppServerInfo(javax.servlet.ServletContext application) Collects the application server data.
protected void	collectDatabaseInfo() Collects all of the database/datasource information into the system info Map.
void	collectInformation(ForumFactory forumFactory, javax.servlet.ServletContext application, javax.servlet.ServletRequest request) Collects the set of system information into the systemInfo Map.
protected void	collectJavaPropertiesInfo() Collects the Java properties information and places it in the system info Map.
protected void	collectJiveConfig(ForumFactory forumFactory) Collects all of the properties from jive_startup into the system info Map.
protected void	collectJiveInfo(ForumFactory forumFactory) Collect the information for general Jive info and place it in the system info Map.
protected void	collectLicenseInfo() Collects the license information for this installation and places it in the system info Map.
protected void	collectSystemInfo(javax.servlet.ServletRequest request) Collect system information.
java.lang.String	getProperty(java.lang.String name) Gets the value associated with a name.
java.util.List	getPropertyNames() Gets a list of the property names that have been collected.
protected java.lang.String	postData(java.lang.String xml) Posts the data to the SERVICE_URL.
java.lang.String	sendSystemInfo() Sends the collected set of system information to Jive.
protected java.lang.String	toXML() Outputs the system info Map as an XML document.

Methods inherited from class java.lang.Object

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

Field Detail

JIVE_CONFIG_PREFIX

public static final java.lang.String JIVE_CONFIG_PREFIX

See Also:

Constant Field Values

JAVA_PREFIX

public static final java.lang.String JAVA_PREFIX

See Also:

Constant Field Values

DATABASE_PREFIX

public static final java.lang.String DATABASE_PREFIX

See Also:

Constant Field Values

SYSTEM_PREFIX

public static final java.lang.String SYSTEM_PREFIX

See Also:

Constant Field Values

APP_SERVER_PREFIX

public static final java.lang.String APP_SERVER_PREFIX

See Also:

Constant Field Values

JIVE_LICENSE_PREFIX

public static final java.lang.String JIVE_LICENSE_PREFIX

See Also:

Constant Field Values

JIVE_INFO_PREFIX

public static final java.lang.String JIVE_INFO_PREFIX

See Also:

Constant Field Values

NOT_AVAILABLE

public static final java.lang.String NOT_AVAILABLE

See Also:

Constant Field Values

sysInfo

protected java.util.Map sysInfo

Constructor Detail

SystemInfoReporter

public SystemInfoReporter()

Method Detail

collectInformation

public void collectInformation(ForumFactory forumFactory,
                               javax.servlet.ServletContext application,
                               javax.servlet.ServletRequest request)

Collects the set of system information into the systemInfo Map.

This call guarantees that there are no null values in the Map.

Parameters:

forumFactory - a ForumFactory instance.

application - the application context object.

request - the servlet request.

sendSystemInfo

public java.lang.String sendSystemInfo()

Sends the collected set of system information to Jive.

Returns:

a result message that should be displayed to the user.

getPropertyNames

public java.util.List getPropertyNames()

Gets a list of the property names that have been collected. The list is unmodifiable.

Returns:

a list of the property names that have been collected.

getProperty

public java.lang.String getProperty(java.lang.String name)

Gets the value associated with a name.

Returns:

the value associated with a name. null may be returned if the name does not exist or the value is actually null.

collectJavaPropertiesInfo

protected void collectJavaPropertiesInfo()

Collects the Java properties information and places it in the system info Map.

collectLicenseInfo

protected void collectLicenseInfo()

Collects the license information for this installation and places it in the system info Map.

collectAppServerInfo

protected void collectAppServerInfo(javax.servlet.ServletContext application)

Collects the application server data.

collectJiveConfig

protected void collectJiveConfig(ForumFactory forumFactory)

Collects all of the properties from jive_startup into the system info Map.

Parameters:

forumFactory - a ForumFactory instance.

collectDatabaseInfo

protected void collectDatabaseInfo()

Collects all of the database/datasource information into the system info Map.

collectJiveInfo

protected void collectJiveInfo(ForumFactory forumFactory)

Collect the information for general Jive info and place it in the system info Map.

Parameters:

forumFactory - a ForumFactory instance.

collectSystemInfo

protected void collectSystemInfo(javax.servlet.ServletRequest request)

Collect system information.

postData

protected java.lang.String postData(java.lang.String xml)

Posts the data to the SERVICE_URL.

Parameters:

xml - the xml to post.

Returns:

the result to display to the user.

toXML

protected java.lang.String toXML()

Outputs the system info Map as an XML document.

Returns:

the system info Map as an XML document.