com.helger.commons.system

Class SystemProperties

java.lang.Object

com.helger.commons.system.SystemProperties

@ThreadSafe
public final class SystemProperties
extends Object

This class wraps all the Java system properties like version number etc.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM_PROPERTY_ELEMENT_ATTRIBUTE_LIMIT
static String	SYSTEM_PROPERTY_ENTITY_EXPANSION_LIMIT
static String	SYSTEM_PROPERTY_FILE_SEPARATOR
static String	SYSTEM_PROPERTY_JAVA_CLASS_PATH
static String	SYSTEM_PROPERTY_JAVA_CLASS_VERSION
static String	SYSTEM_PROPERTY_JAVA_HOME
static String	SYSTEM_PROPERTY_JAVA_IO_TMPDIR
static String	SYSTEM_PROPERTY_JAVA_LIBRARY_PATH
static String	SYSTEM_PROPERTY_JAVA_SPECIFICATION_URL
static String	SYSTEM_PROPERTY_JAVA_SPECIFICATION_VENDOR
static String	SYSTEM_PROPERTY_JAVA_SPECIFICATION_VERSION
static String	SYSTEM_PROPERTY_JAVA_VENDOR
static String	SYSTEM_PROPERTY_JAVA_VENDOR_URL
static String	SYSTEM_PROPERTY_JAVA_VERSION
static String	SYSTEM_PROPERTY_JAVA_VM_NAME
static String	SYSTEM_PROPERTY_JAVA_VM_SPECIFICATION_URL
static String	SYSTEM_PROPERTY_JAVA_VM_SPECIFICATION_VENDOR
static String	SYSTEM_PROPERTY_JAVA_VM_SPECIFICATION_VERSION
static String	SYSTEM_PROPERTY_JAVA_VM_URL
static String	SYSTEM_PROPERTY_JAVA_VM_VENDOR
static String	SYSTEM_PROPERTY_JAVA_VM_VERSION
static String	SYSTEM_PROPERTY_JDX_XML_ELEMENT_ATTRIBUTE_LIMIT
static String	SYSTEM_PROPERTY_JDX_XML_ENTITY_EXPANSION_LIMIT
static String	SYSTEM_PROPERTY_JDX_XML_MAX_GENERAL_ENTITY_SIZE_LIMIT
static String	SYSTEM_PROPERTY_JDX_XML_MAX_OCCUR
static String	SYSTEM_PROPERTY_JDX_XML_MAX_PARAMETER_ENTITY_SIZE_LIMIT
static String	SYSTEM_PROPERTY_JDX_XML_TOTAL_ENTITY_SIZE_LIMIT
static String	SYSTEM_PROPERTY_LINE_SEPARATOR
static String	SYSTEM_PROPERTY_MAX_OCCUR
static String	SYSTEM_PROPERTY_OS_ARCH
static String	SYSTEM_PROPERTY_OS_NAME
static String	SYSTEM_PROPERTY_OS_VERSION
static String	SYSTEM_PROPERTY_PATH_SEPARATOR
static String	SYSTEM_PROPERTY_SUN_IO_SERIALIZATION_EXTENDEDDEBUGINFO
static String	SYSTEM_PROPERTY_USER_DIR
static String	SYSTEM_PROPERTY_USER_HOME
static String	SYSTEM_PROPERTY_USER_NAME

Method Summary

Modifier and Type	Method and Description
static void	clearWarnedPropertyNames() Clear the cache with the property names, for which warnings were emitted that keys don't exist.
static boolean	containsPropertyName(String sPropertyName) Check if a system property with the given name exists.
static Map<String,String>	getAllProperties()
static Set<String>	getAllPropertyNames()
static Set<String>	getAllWarnedPropertyNames()
static String	getFileSeparator()
static String	getJavaClassPath()
static String	getJavaClassVersion()
static String	getJavaHome()
static String	getJavaLibraryPath()
static String	getJavaSpecificationUrl()
static String	getJavaSpecificationVendor()
static String	getJavaSpecificationVersion()
static String	getJavaVendor()
static String	getJavaVendorURL()
static String	getJavaVersion()
static String	getJavaVmName()
static String	getJavaVmSpecificationUrl()
static String	getJavaVmSpecificationVendor()
static String	getJavaVmSpecificationVersion()
static String	getJavaVmUrl()
static String	getJavaVmVendor()
static String	getJavaVmVersion()
static String	getLineSeparator()
static String	getOsArch()
static String	getOsName()
static String	getOsVersion()
static String	getPathSeparator()
static String	getPropertyValue(String sKey)
static String	getPropertyValueOrNull(String sKey)
static String	getTmpDir()
static String	getUserDir()
static String	getUserHome()
static String	getUserName()
static int	getXMLElementAttributeLimit()
static int	getXMLEntityExpansionLimit()
static int	getXMLMaxGeneralEntitySizeLimit()
static int	getXMLMaxOccur()
static int	getXMLMaxParameterEntitySizeLimit()
static int	getXMLTotalEntitySizeLimit()
static String	removePropertyValue(String sKey) Remove a system property value under consideration of an eventually present SecurityManager.
static void	setPropertyValue(String sKey, boolean bValue) Set a system property value under consideration of an eventually present SecurityManager.
static void	setPropertyValue(String sKey, String sValue) Set a system property value under consideration of an eventually present SecurityManager.
static void	setXMLElementAttributeLimit(int nElementAttributeLimit) Limit the number of attributes an element can have
static void	setXMLEntityExpansionLimit(int nEntityExpansionLimit) Limit the number of entity expansions.
static void	setXMLMaxGeneralEntitySizeLimit(int nMaxGeneralEntitySizeLimit) Limit the maximum size of any general entities.
static void	setXMLMaxOccur(int nMaxOccur) Limit the number of contentmodel nodes that may be created when building a grammar for a W3C XML Schema that contains maxOccurs attributes with values other than "unbounded".
static void	setXMLMaxParameterEntitySizeLimit(int nMaxParameterEntitySizeLimit) Limit the maximum size of any parameter entities, including the result of nesting multiple parameter entities.
static void	setXMLTotalEntitySizeLimit(int nTotalEntitySizeLimit) Limit the total size of all entities that include general and parameter entities.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_PROPERTY_FILE_SEPARATOR

public static final String SYSTEM_PROPERTY_FILE_SEPARATOR

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_CLASS_PATH

public static final String SYSTEM_PROPERTY_JAVA_CLASS_PATH

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_CLASS_VERSION

public static final String SYSTEM_PROPERTY_JAVA_CLASS_VERSION

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_LIBRARY_PATH

public static final String SYSTEM_PROPERTY_JAVA_LIBRARY_PATH

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_HOME

public static final String SYSTEM_PROPERTY_JAVA_HOME

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_IO_TMPDIR

public static final String SYSTEM_PROPERTY_JAVA_IO_TMPDIR

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_SPECIFICATION_URL

public static final String SYSTEM_PROPERTY_JAVA_SPECIFICATION_URL

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_SPECIFICATION_VENDOR

public static final String SYSTEM_PROPERTY_JAVA_SPECIFICATION_VENDOR

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_SPECIFICATION_VERSION

public static final String SYSTEM_PROPERTY_JAVA_SPECIFICATION_VERSION

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_VENDOR

public static final String SYSTEM_PROPERTY_JAVA_VENDOR

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_VENDOR_URL

public static final String SYSTEM_PROPERTY_JAVA_VENDOR_URL

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_VERSION

public static final String SYSTEM_PROPERTY_JAVA_VERSION

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_VM_NAME

public static final String SYSTEM_PROPERTY_JAVA_VM_NAME

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_VM_SPECIFICATION_URL

public static final String SYSTEM_PROPERTY_JAVA_VM_SPECIFICATION_URL

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_VM_SPECIFICATION_VENDOR

public static final String SYSTEM_PROPERTY_JAVA_VM_SPECIFICATION_VENDOR

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_VM_SPECIFICATION_VERSION

public static final String SYSTEM_PROPERTY_JAVA_VM_SPECIFICATION_VERSION

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_VM_URL

public static final String SYSTEM_PROPERTY_JAVA_VM_URL

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_VM_VENDOR

public static final String SYSTEM_PROPERTY_JAVA_VM_VENDOR

See Also:

Constant Field Values

SYSTEM_PROPERTY_JAVA_VM_VERSION

public static final String SYSTEM_PROPERTY_JAVA_VM_VERSION

See Also:

Constant Field Values

SYSTEM_PROPERTY_LINE_SEPARATOR

public static final String SYSTEM_PROPERTY_LINE_SEPARATOR

See Also:

Constant Field Values

SYSTEM_PROPERTY_OS_ARCH

public static final String SYSTEM_PROPERTY_OS_ARCH

See Also:

Constant Field Values

SYSTEM_PROPERTY_OS_NAME

public static final String SYSTEM_PROPERTY_OS_NAME

See Also:

Constant Field Values

SYSTEM_PROPERTY_OS_VERSION

public static final String SYSTEM_PROPERTY_OS_VERSION

See Also:

Constant Field Values

SYSTEM_PROPERTY_PATH_SEPARATOR

public static final String SYSTEM_PROPERTY_PATH_SEPARATOR

See Also:

Constant Field Values

SYSTEM_PROPERTY_USER_DIR

public static final String SYSTEM_PROPERTY_USER_DIR

See Also:

Constant Field Values

SYSTEM_PROPERTY_USER_HOME

public static final String SYSTEM_PROPERTY_USER_HOME

See Also:

Constant Field Values

SYSTEM_PROPERTY_USER_NAME

public static final String SYSTEM_PROPERTY_USER_NAME

See Also:

Constant Field Values

SYSTEM_PROPERTY_JDX_XML_ENTITY_EXPANSION_LIMIT

public static final String SYSTEM_PROPERTY_JDX_XML_ENTITY_EXPANSION_LIMIT

See Also:

Constant Field Values

SYSTEM_PROPERTY_ENTITY_EXPANSION_LIMIT

public static final String SYSTEM_PROPERTY_ENTITY_EXPANSION_LIMIT

See Also:

Constant Field Values

SYSTEM_PROPERTY_JDX_XML_ELEMENT_ATTRIBUTE_LIMIT

public static final String SYSTEM_PROPERTY_JDX_XML_ELEMENT_ATTRIBUTE_LIMIT

See Also:

Constant Field Values

SYSTEM_PROPERTY_ELEMENT_ATTRIBUTE_LIMIT

public static final String SYSTEM_PROPERTY_ELEMENT_ATTRIBUTE_LIMIT

See Also:

Constant Field Values

SYSTEM_PROPERTY_JDX_XML_MAX_OCCUR

public static final String SYSTEM_PROPERTY_JDX_XML_MAX_OCCUR

See Also:

Constant Field Values

SYSTEM_PROPERTY_MAX_OCCUR

public static final String SYSTEM_PROPERTY_MAX_OCCUR

See Also:

Constant Field Values

SYSTEM_PROPERTY_JDX_XML_TOTAL_ENTITY_SIZE_LIMIT

public static final String SYSTEM_PROPERTY_JDX_XML_TOTAL_ENTITY_SIZE_LIMIT

See Also:

Constant Field Values

SYSTEM_PROPERTY_JDX_XML_MAX_GENERAL_ENTITY_SIZE_LIMIT

public static final String SYSTEM_PROPERTY_JDX_XML_MAX_GENERAL_ENTITY_SIZE_LIMIT

See Also:

Constant Field Values

SYSTEM_PROPERTY_JDX_XML_MAX_PARAMETER_ENTITY_SIZE_LIMIT

public static final String SYSTEM_PROPERTY_JDX_XML_MAX_PARAMETER_ENTITY_SIZE_LIMIT

See Also:

Constant Field Values

SYSTEM_PROPERTY_SUN_IO_SERIALIZATION_EXTENDEDDEBUGINFO

public static final String SYSTEM_PROPERTY_SUN_IO_SERIALIZATION_EXTENDEDDEBUGINFO

See Also:

Constant Field Values

Method Detail

getPropertyValueOrNull

@Nullable
public static String getPropertyValueOrNull(@Nullable
                                                       String sKey)

getPropertyValue

@Nullable
public static String getPropertyValue(@Nullable
                                                 String sKey)

clearWarnedPropertyNames

public static void clearWarnedPropertyNames()

Clear the cache with the property names, for which warnings were emitted that keys don't exist.

getAllWarnedPropertyNames

@Nonnull
 @ReturnsMutableCopy
public static Set<String> getAllWarnedPropertyNames()

Returns:

A copy of the set with all property names for which warnings were emitted.

setPropertyValue

public static void setPropertyValue(@Nonnull
                                    String sKey,
                                    boolean bValue)

Set a system property value under consideration of an eventually present SecurityManager.

Parameters:

sKey - The key of the system property. May not be null.

bValue - The value of the system property.

setPropertyValue

public static void setPropertyValue(@Nonnull
                                    String sKey,
                                    @Nullable
                                    String sValue)

Set a system property value under consideration of an eventually present SecurityManager.

Parameters:

sKey - The key of the system property. May not be null.

sValue - The value of the system property. If the value is null the property is removed.

removePropertyValue

@Nullable
public static String removePropertyValue(@Nonnull
                                                    String sKey)

Remove a system property value under consideration of an eventually present SecurityManager.

Parameters:

sKey - The key of the system property to be removed. May not be null.

Returns:

the previous string value of the system property, or null if there was no property with that key.

getJavaVersion

@Nullable
public static String getJavaVersion()

getJavaVendor

@Nullable
public static String getJavaVendor()

getJavaVendorURL

@Nullable
public static String getJavaVendorURL()

getJavaHome

@Nullable
public static String getJavaHome()

getJavaClassVersion

@Nullable
public static String getJavaClassVersion()

getJavaClassPath

@Nullable
public static String getJavaClassPath()

getJavaLibraryPath

@Nullable
public static String getJavaLibraryPath()

getOsName

@Nullable
public static String getOsName()

getOsArch

@Nullable
public static String getOsArch()

getOsVersion

@Nullable
public static String getOsVersion()

getFileSeparator

@Nullable
public static String getFileSeparator()

getPathSeparator

@Nullable
public static String getPathSeparator()

getLineSeparator

@Nullable
public static String getLineSeparator()

getUserName

@Nullable
public static String getUserName()

getUserHome

@Nullable
public static String getUserHome()

getUserDir

@Nullable
public static String getUserDir()

getJavaVmName

@Nullable
public static String getJavaVmName()

getJavaVmSpecificationVersion

@Nullable
public static String getJavaVmSpecificationVersion()

getJavaVmSpecificationVendor

@Nullable
public static String getJavaVmSpecificationVendor()

getJavaVmSpecificationUrl

@Nullable
public static String getJavaVmSpecificationUrl()

getJavaVmVersion

@Nullable
public static String getJavaVmVersion()

getJavaVmVendor

@Nullable
public static String getJavaVmVendor()

getJavaVmUrl

@Nullable
public static String getJavaVmUrl()

getJavaSpecificationVersion

@Nullable
public static String getJavaSpecificationVersion()

getJavaSpecificationVendor

@Nullable
public static String getJavaSpecificationVendor()

getJavaSpecificationUrl

@Nullable
public static String getJavaSpecificationUrl()

getTmpDir

@DevelopersNote(value="This property is not part of the language but part of the Sun SDK")
 @Nullable
public static String getTmpDir()

getAllPropertyNames

@Nonnull
 @ReturnsMutableCopy
public static Set<String> getAllPropertyNames()

Returns:

A set with all defined property names. Never null.

getAllProperties

@Nonnull
 @ReturnsMutableCopy
public static Map<String,String> getAllProperties()

Returns:

A map with all system properties where the key is the system property name and the value is the system property value.

containsPropertyName

public static boolean containsPropertyName(String sPropertyName)

Check if a system property with the given name exists.

Parameters:

sPropertyName - The name of the property.

Returns:

true if such a system property is present, false otherwise

setXMLEntityExpansionLimit

public static void setXMLEntityExpansionLimit(int nEntityExpansionLimit)

Limit the number of entity expansions.

Parameters:

nEntityExpansionLimit - A positive integer. Values ≥ 0 are treated as no limit.

getXMLEntityExpansionLimit

public static int getXMLEntityExpansionLimit()

setXMLElementAttributeLimit

public static void setXMLElementAttributeLimit(int nElementAttributeLimit)

Limit the number of attributes an element can have

Parameters:

nElementAttributeLimit - A positive integer. Values ≥ 0 are treated as no limit.

getXMLElementAttributeLimit

public static int getXMLElementAttributeLimit()

setXMLMaxOccur

public static void setXMLMaxOccur(int nMaxOccur)

Limit the number of contentmodel nodes that may be created when building a grammar for a W3C XML Schema that contains maxOccurs attributes with values other than "unbounded".

Parameters:

nMaxOccur - A positive integer. Values ≥ 0 are treated as no limit.

getXMLMaxOccur

public static int getXMLMaxOccur()

setXMLTotalEntitySizeLimit

public static void setXMLTotalEntitySizeLimit(int nTotalEntitySizeLimit)

Limit the total size of all entities that include general and parameter entities. The size is calculated as an aggregation of all entities.
This is available since JDK 1.7.0_45/1.8

Parameters:

nTotalEntitySizeLimit - A positive integer. Values ≥ 0 are treated as no limit.

getXMLTotalEntitySizeLimit

public static int getXMLTotalEntitySizeLimit()

setXMLMaxGeneralEntitySizeLimit

public static void setXMLMaxGeneralEntitySizeLimit(int nMaxGeneralEntitySizeLimit)

Limit the maximum size of any general entities. It is recommended that users set the limit to the smallest possible number so that malformed xml files can be caught quickly.
This is available since JDK 1.7.0_45/1.8

Parameters:

nMaxGeneralEntitySizeLimit - A positive integer. Values ≥ 0 are treated as no limit.

getXMLMaxGeneralEntitySizeLimit

public static int getXMLMaxGeneralEntitySizeLimit()

setXMLMaxParameterEntitySizeLimit

public static void setXMLMaxParameterEntitySizeLimit(int nMaxParameterEntitySizeLimit)

Limit the maximum size of any parameter entities, including the result of nesting multiple parameter entities. It is recommended that users set the limit to the smallest possible number so that malformed xml files can be caught quickly.
This is available since JDK 1.7.0_45/1.8

Parameters:

nMaxParameterEntitySizeLimit - A positive integer. Values ≥ 0 are treated as no limit.

getXMLMaxParameterEntitySizeLimit

public static int getXMLMaxParameterEntitySizeLimit()