com.atlassian.jira.util.system
Interface ExtendedSystemInfoUtils

All Known Implementing Classes:
ExtendedSystemInfoUtilsImpl

public interface ExtendedSystemInfoUtils

Contains methods for obtaining various collections of system information in a localised format. In contrast to SystemInfoUtils, these methods are more dependant on components being correctly initialised, thus they should only be used once the application is in a stable state.

Since:
v3.13

Method Summary
 String getBaseUrl()
           
 Map getBuildStats()
           
 String getDefaultLanguage()
           
 String getEntityEngineXmlPath()
           
 String getIndexLocation()
           
 Set getIPMatches(TrustedApplicationInfo info)
           
 Map getJvmStats()
           
 Map getLicenseInfo()
           
 Collection getListeners()
           
 String getLogPath()
           
 long getMillisecondsToMinutes(long ms)
           
 Collection getPlugins()
           
 Map getProps()
          Default is to hide sensitive system information (for the 500 page, etc.)
 Map getProps(boolean showSensitiveInfo)
           
 Map getServicePropertyMap(JiraServiceContainer serviceContainer)
           
 Collection getServices()
           
 SystemInfoUtils getSystemInfoUtils()
           
 Map getSystemPropertiesFormatted(String suffix)
          For each system properties, display the key and its value.
 Set getTrustedApplications(JiraServiceContext jiraServiceContext)
           
 Set getUrlMatches(TrustedApplicationInfo info)
           
 Map getUsageStats()
           
 boolean isJvmJava5OrGreater()
           
 boolean isPluginEnabled(com.atlassian.plugin.Plugin plugin)
           
 boolean isUsingSystemLocale()
          Checks whether the default locale has been set or not.
 

Method Detail

getSystemInfoUtils

SystemInfoUtils getSystemInfoUtils()
Returns:
the SystemInfoUtils object

getProps

Map getProps()
Default is to hide sensitive system information (for the 500 page, etc.)

Returns:
an ordered map of system properties

getProps

Map getProps(boolean showSensitiveInfo)
Parameters:
showSensitiveInfo - Whether to include sensitive system information (e.g. database URL)
Returns:
an ordered map of system properties

getJvmStats

Map getJvmStats()
Returns:
memory statistics for the JVM

getBuildStats

Map getBuildStats()
Returns:
information about the current build of JIRA

getSystemPropertiesFormatted

Map getSystemPropertiesFormatted(String suffix)
For each system properties, display the key and its value. If the value is a path, then break the paths at semi colons ';' (For non-windows operatin systems, breaks on colon ':' as well). The break is accomplished by replacing the ';' or ':' with the suffix string argument

Parameters:
suffix - the string to add to the suffix of ';' and/or ':'
Returns:
Map of system property keys to its value

getDefaultLanguage

String getDefaultLanguage()
Returns:
the default language set in the application's properties

getBaseUrl

String getBaseUrl()
Returns:
the base URL of the application

getUsageStats

Map getUsageStats()
Returns:
usage statistics for the application (user counts, issue counts, etc)

isUsingSystemLocale

boolean isUsingSystemLocale()
Checks whether the default locale has been set or not.

Returns:
true if default locale is set, false if using system locale

getEntityEngineXmlPath

String getEntityEngineXmlPath()
Returns:
the path to the entityengine.xml file

getLogPath

String getLogPath()
Returns:
the path to the atlassian-jira.log file

getIndexLocation

String getIndexLocation()
Returns:
the path to the application's index file

getListeners

Collection getListeners()
Returns:
a collection of raw listener GVs

getServices

Collection getServices()
Returns:
a collection of JiraServiceContainers for each service

getServicePropertyMap

Map getServicePropertyMap(JiraServiceContainer serviceContainer)
Parameters:
serviceContainer - the service object to obtain properties for
Returns:
a map of properties relating to the service configuration

getMillisecondsToMinutes

long getMillisecondsToMinutes(long ms)
Parameters:
ms - milliseconds
Returns:
the number of minutes represented by the specified number of milliseconds

getPlugins

Collection getPlugins()
Returns:
a collection of plugins

isPluginEnabled

boolean isPluginEnabled(com.atlassian.plugin.Plugin plugin)
Parameters:
plugin - the plugin
Returns:
true if the plugin is currently enabled; false otherwise

getTrustedApplications

Set getTrustedApplications(JiraServiceContext jiraServiceContext)
Parameters:
jiraServiceContext - the JIRA service context
Returns:
a set of TrustedApplicationInfo objects

getIPMatches

Set getIPMatches(TrustedApplicationInfo info)
Parameters:
info - the trusted application
Returns:
the set of IP matches defined for this trusted app

getUrlMatches

Set getUrlMatches(TrustedApplicationInfo info)
Parameters:
info - the trusted application
Returns:
the set of URL matches defined for this trusted app

getLicenseInfo

Map getLicenseInfo()
Returns:
details of the current license

isJvmJava5OrGreater

boolean isJvmJava5OrGreater()
Returns:
true if using a 1.5 or higher JVM, false otherwise.


Copyright © 2002-2008 Atlassian. All Rights Reserved.