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 |
Map<String,String> |
getApplicationPropertiesFormatted(String suffix)
For each application property, display the key and its value. |
String |
getAttachmentsLocation()
|
String |
getBackupLocation()
|
String |
getBaseUrl()
|
Map<String,String> |
getBuildStats()
|
Map<Node,Boolean> |
getClusterNodeInformation()
|
Map<String,String> |
getCommonConfigProperties()
The common configuration properties that apply to this instance of JIRA |
String |
getDefaultLanguage()
|
String |
getEntityEngineXmlPath()
|
String |
getIndexLocation()
|
Set<String> |
getIPMatches(TrustedApplicationInfo info)
|
String |
getJiraHomeLocation()
|
String |
getJiraLocalHomeLocation()
|
Map<String,String> |
getJvmStats()
|
Map<String,String> |
getLicenseInfo()
|
Collection<org.ofbiz.core.entity.GenericValue> |
getListeners()
|
String |
getLogPath()
|
List<com.atlassian.jdk.utilities.runtimeinformation.MemoryInformation> |
getMemoryPoolInformation()
|
long |
getMillisecondsToMinutes(long ms)
|
Collection<com.atlassian.plugin.Plugin> |
getPlugins()
|
Map<String,String> |
getProps()
Default is to hide sensitive system information (for the 500 page, etc.) |
Map<String,String> |
getProps(boolean showSensitiveInfo)
|
Map<String,String> |
getServicePropertyMap(JiraServiceContainer serviceContainer)
|
Collection<JiraServiceContainer> |
getServices()
|
SystemInfoUtils |
getSystemInfoUtils()
|
Map<String,String> |
getSystemPropertiesFormatted(String suffix)
For each system properties, display the key and its value. |
Set<TrustedApplicationInfo> |
getTrustedApplications(JiraServiceContext jiraServiceContext)
|
List<UpgradeHistoryItem> |
getUpgradeHistory()
|
Set<String> |
getUrlMatches(TrustedApplicationInfo info)
|
Map<String,String> |
getUsageStats()
|
boolean |
isClustered()
|
boolean |
isJvmJava5OrGreater()
|
boolean |
isJvmWithPermGen()
|
boolean |
isPluginEnabled(com.atlassian.plugin.Plugin plugin)
|
boolean |
isUsingSystemLocale()
Checks whether the default locale has been set or not. |
getSystemInfoUtils
SystemInfoUtils getSystemInfoUtils()
- Returns:
- the SystemInfoUtils object
getProps
Map<String,String> getProps()
- Default is to hide sensitive system information (for the 500 page, etc.)
- Returns:
- an ordered map of system properties
getProps
Map<String,String> getProps(boolean showSensitiveInfo)
- Parameters:
showSensitiveInfo
- Whether to include sensitive system information (e.g. database URL)
- Returns:
- an ordered map of system properties
getCommonConfigProperties
Map<String,String> getCommonConfigProperties()
- The common configuration properties that apply to this instance of JIRA
- Returns:
- a Map of property names to
getJvmStats
Map<String,String> getJvmStats()
- Returns:
- memory statistics for the JVM
getMemoryPoolInformation
List<com.atlassian.jdk.utilities.runtimeinformation.MemoryInformation> getMemoryPoolInformation()
- Returns:
- memory pool statistics for the JVM
getBuildStats
Map<String,String> getBuildStats()
- Returns:
- information about the current build of JIRA
getUpgradeHistory
List<UpgradeHistoryItem> getUpgradeHistory()
- Returns:
- information about the upgrade history of JIRA
- Since:
- v4.1
getApplicationPropertiesFormatted
Map<String,String> getApplicationPropertiesFormatted(String suffix)
- For each application property, 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
getSystemPropertiesFormatted
Map<String,String> 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 - rendered in the current user's locale
getBaseUrl
String getBaseUrl()
- Returns:
- the base URL of the application
getUsageStats
Map<String,String> 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
getAttachmentsLocation
String getAttachmentsLocation()
- Returns:
- the path to the attachments directory
getBackupLocation
String getBackupLocation()
- Returns:
- the path to the backup directory
getListeners
Collection<org.ofbiz.core.entity.GenericValue> getListeners()
- Returns:
- a collection of raw listener GVs
getServices
Collection<JiraServiceContainer> getServices()
- Returns:
- a collection of JiraServiceContainers for each service
getServicePropertyMap
Map<String,String> 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<com.atlassian.plugin.Plugin> 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<TrustedApplicationInfo> getTrustedApplications(JiraServiceContext jiraServiceContext)
- Parameters:
jiraServiceContext
- the JIRA service context
- Returns:
- a set of TrustedApplicationInfo objects
getIPMatches
Set<String> getIPMatches(TrustedApplicationInfo info)
- Parameters:
info
- the trusted application
- Returns:
- the set of IP matches defined for this trusted app
getUrlMatches
Set<String> getUrlMatches(TrustedApplicationInfo info)
- Parameters:
info
- the trusted application
- Returns:
- the set of URL matches defined for this trusted app
getLicenseInfo
Map<String,String> getLicenseInfo()
- Returns:
- details of the current license
isJvmJava5OrGreater
boolean isJvmJava5OrGreater()
- Returns:
- true if using a 1.5 or higher JVM, false otherwise.
isJvmWithPermGen
boolean isJvmWithPermGen()
- Returns:
- true if using a JVM that has PermGen space, false if no PermGen available
(typically JVM's after Java 1.7, 1.8 now use Metaspace).
getJiraHomeLocation
String getJiraHomeLocation()
- Returns:
- the current configured location of shared JIRA Home
getJiraLocalHomeLocation
String getJiraLocalHomeLocation()
- Returns:
- the current configured location of local JIRA Home
isClustered
boolean isClustered()
- Returns:
- true if the instance is clustered.
getClusterNodeInformation
Map<Node,Boolean> getClusterNodeInformation()
- Returns:
- A map of cluster nodes mapped to their live status, i.e. are they heartbeating.
Copyright © 2002-2014 Atlassian. All Rights Reserved.