com.microsoft.applicationinsights.internal.util

Class PropertyHelper

java.lang.Object

com.microsoft.applicationinsights.internal.util.PropertyHelper

public final class PropertyHelper
extends java.lang.Object

Helper class for reading data from a properties file found on the class path.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SDK_VERSION_FILE_NAME
static java.lang.String	UNKNOWN_VERSION_VALUE
static java.lang.String	VERSION_PROPERTY_NAME
static java.lang.String	VERSION_STRING_PREFIX

Method Summary

Modifier and Type	Method and Description
static java.util.Properties	getProperties(java.lang.String name) Reads the properties from a properties file.
static java.lang.String	getQualifiedSdkVersionString() Returns the SDK version string, the version-number prefixed with "java:".
static java.lang.String	getSdkVersionNumber()
static java.util.Properties	getSdkVersionProperties() Deprecated. Use getQualifiedSdkVersionString() to get the cached sdk version value.
static java.util.Properties	getStarterVersionProperties() Deprecated. Use getStarterVersionString() to get the cached starter version value.
static java.lang.String	getStarterVersionString() Returns the starter version string, the version-number prefixed with "java:".

Methods inherited from class java.lang.Object

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

Field Detail

SDK_VERSION_FILE_NAME

public static final java.lang.String SDK_VERSION_FILE_NAME

See Also:

Constant Field Values

VERSION_STRING_PREFIX

public static final java.lang.String VERSION_STRING_PREFIX

See Also:

Constant Field Values

VERSION_PROPERTY_NAME

public static final java.lang.String VERSION_PROPERTY_NAME

See Also:

Constant Field Values

UNKNOWN_VERSION_VALUE

public static final java.lang.String UNKNOWN_VERSION_VALUE

See Also:

Constant Field Values

Method Detail

getProperties

public static java.util.Properties getProperties(java.lang.String name)
                                          throws java.io.IOException

Reads the properties from a properties file.

Parameters:

name - of the properties file.

Returns:

A Properties object containing the properties read from the provided file.

Throws:

java.io.IOException - in case

getSdkVersionProperties

@Deprecated
public static java.util.Properties getSdkVersionProperties()

Deprecated. Use getQualifiedSdkVersionString() to get the cached sdk version value.

A method that loads the properties file that contains SDK-Version data.

Returns:

The properties or null if not found.

getStarterVersionProperties

@Deprecated
public static java.util.Properties getStarterVersionProperties()

Deprecated. Use getStarterVersionString() to get the cached starter version value.

A method that loads the properties file that contains the AI SpringBootStarter version number

Returns:

The properties or null if not found.

getQualifiedSdkVersionString

public static java.lang.String getQualifiedSdkVersionString()

Returns the SDK version string, the version-number prefixed with "java:". The version-number is the value of the "version" property in "sdk-version.properties". If the properties file cannot be read, "unknown" is used for the version-number.

Returns:

"java:version-number" or "java:unknown"

getSdkVersionNumber

public static java.lang.String getSdkVersionNumber()

getStarterVersionString

public static java.lang.String getStarterVersionString()

Returns the starter version string, the version-number prefixed with "java:". The version-number is the value of the "version" property in . If the properties file cannot be read, "unknown" is used for the version-number.

Returns:

"java:version-number" or "java:unknown"