com.microsoft.applicationinsights.internal.heartbeat

Class HeartBeatProvider

java.lang.Object

com.microsoft.applicationinsights.internal.heartbeat.HeartBeatProvider

All Implemented Interfaces:

HeartBeatProviderInterface, Stoppable

public class HeartBeatProvider
extends java.lang.Object
implements HeartBeatProviderInterface, Stoppable

Concrete implementation of Heartbeat functionality. This class implements HeartBeatProviderInterface and Stoppable

Field Summary

Fields inherited from interface com.microsoft.applicationinsights.internal.heartbeat.HeartBeatProviderInterface

DEFAULT_HEARTBEAT_INTERVAL, MINIMUM_HEARTBEAT_INTERVAL

Constructor Summary

Constructors

Constructor and Description
HeartBeatProvider()

Method Summary

Modifier and Type	Method and Description
boolean	addHeartBeatProperty(java.lang.String propertyName, java.lang.String propertyValue, boolean isHealthy) Adds the heartbeat property to the heartbeat payload.
boolean	containsHeartBeatProperty(java.lang.String key) Returns true if the HeartBeat provider has the given HeartBeat Property
java.util.List<java.lang.String>	getExcludedHeartBeatProperties() Returns the list of excluded heartbeat properties.
java.util.List<java.lang.String>	getExcludedHeartBeatPropertyProviders() This returns the list of Excluded Heart Beat Providers
long	getHeartBeatInterval() Gets the currently set heartbeat interval.
java.lang.String	getInstrumentationKey() Gets the instrumentation key used by telemetry client sending heartbeat.
void	initialize(TelemetryConfiguration configuration) This method initializes the concrete module.
boolean	isHeartBeatEnabled() Returns if heartbeat is enabled or not.
void	setExcludedHeartBeatProperties(java.util.List<java.lang.String> excludedHeartBeatProperties) Sets the list of properties to be excluded from heartbeat payload.
void	setExcludedHeartBeatPropertyProviders(java.util.List<java.lang.String> excludedHeartBeatPropertyProviders) Sets the list of excluded heartbeat providers.
void	setHeartBeatEnabled(boolean isEnabled) Enables or disables heartbeat module.
void	setHeartBeatInterval(long timeUnit) Sets the time interval of heartbeat in seconds.
boolean	setHeartBeatProperty(java.lang.String propertyName, java.lang.String propertyValue, boolean isHealthy) Sets the value of already existing heartbeat property in the payload.
void	setInstrumentationKey(java.lang.String key) Sets the instrumentation key
void	stop(long timeout, java.util.concurrent.TimeUnit timeUnit)

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartBeatProvider

public HeartBeatProvider()

Method Detail

getInstrumentationKey

public java.lang.String getInstrumentationKey()

Description copied from interface: HeartBeatProviderInterface

Gets the instrumentation key used by telemetry client sending heartbeat.

Specified by:

getInstrumentationKey in interface HeartBeatProviderInterface

Returns:

InstrumentationKey

setInstrumentationKey

public void setInstrumentationKey(java.lang.String key)

Description copied from interface: HeartBeatProviderInterface

Sets the instrumentation key

Specified by:

setInstrumentationKey in interface HeartBeatProviderInterface

Parameters:

key - Key to be set

initialize

public void initialize(TelemetryConfiguration configuration)

Description copied from interface: HeartBeatProviderInterface

This method initializes the concrete module.

Specified by:

initialize in interface HeartBeatProviderInterface

Parameters:

configuration - TelemetryConfiguration

addHeartBeatProperty

public boolean addHeartBeatProperty(java.lang.String propertyName,
                                    java.lang.String propertyValue,
                                    boolean isHealthy)

Description copied from interface: HeartBeatProviderInterface

Adds the heartbeat property to the heartbeat payload.

Specified by:

addHeartBeatProperty in interface HeartBeatProviderInterface

Parameters:

propertyName - Name of the property to be added in Heartbeat payload

propertyValue - Value of the property to be added in Heartbeat payload

isHealthy - indicates if heartbeat is healthy

Returns:

true if property is added successfully

setHeartBeatProperty

public boolean setHeartBeatProperty(java.lang.String propertyName,
                                    java.lang.String propertyValue,
                                    boolean isHealthy)

Description copied from interface: HeartBeatProviderInterface

Sets the value of already existing heartbeat property in the payload.

Specified by:

setHeartBeatProperty in interface HeartBeatProviderInterface

Parameters:

propertyName - Name of the property to be added in Heartbeat payload

propertyValue - Value of the property to be added in Heartbeat payload

isHealthy - indicates if heartbeat is healthy

Returns:

true if property is added successfully

isHeartBeatEnabled

public boolean isHeartBeatEnabled()

Description copied from interface: HeartBeatProviderInterface

Returns if heartbeat is enabled or not.

Specified by:

isHeartBeatEnabled in interface HeartBeatProviderInterface

Returns:

true if heartbeat is enabled

setHeartBeatEnabled

public void setHeartBeatEnabled(boolean isEnabled)

Description copied from interface: HeartBeatProviderInterface

Enables or disables heartbeat module.

Specified by:

setHeartBeatEnabled in interface HeartBeatProviderInterface

Parameters:

isEnabled - state of the heartbeat (enabled/disabled)

getExcludedHeartBeatPropertyProviders

public java.util.List<java.lang.String> getExcludedHeartBeatPropertyProviders()

Description copied from interface: HeartBeatProviderInterface

This returns the list of Excluded Heart Beat Providers

Specified by:

getExcludedHeartBeatPropertyProviders in interface HeartBeatProviderInterface

Returns:

list of excluded heartbeat providers

setExcludedHeartBeatPropertyProviders

public void setExcludedHeartBeatPropertyProviders(java.util.List<java.lang.String> excludedHeartBeatPropertyProviders)

Description copied from interface: HeartBeatProviderInterface

Sets the list of excluded heartbeat providers.

Specified by:

setExcludedHeartBeatPropertyProviders in interface HeartBeatProviderInterface

Parameters:

excludedHeartBeatPropertyProviders - List of heartbeat providers to be excluded

getHeartBeatInterval

public long getHeartBeatInterval()

Description copied from interface: HeartBeatProviderInterface

Gets the currently set heartbeat interval.

Specified by:

getHeartBeatInterval in interface HeartBeatProviderInterface

Returns:

returns the time interval of heartbeat

setHeartBeatInterval

public void setHeartBeatInterval(long timeUnit)

Description copied from interface: HeartBeatProviderInterface

Sets the time interval of heartbeat in seconds.

Specified by:

setHeartBeatInterval in interface HeartBeatProviderInterface

Parameters:

timeUnit - Heartbeat interval in seconds

getExcludedHeartBeatProperties

public java.util.List<java.lang.String> getExcludedHeartBeatProperties()

Description copied from interface: HeartBeatProviderInterface

Returns the list of excluded heartbeat properties.

Specified by:

getExcludedHeartBeatProperties in interface HeartBeatProviderInterface

Returns:

List of excluded heartbeat properties

setExcludedHeartBeatProperties

public void setExcludedHeartBeatProperties(java.util.List<java.lang.String> excludedHeartBeatProperties)

Description copied from interface: HeartBeatProviderInterface

Sets the list of properties to be excluded from heartbeat payload.

Specified by:

setExcludedHeartBeatProperties in interface HeartBeatProviderInterface

Parameters:

excludedHeartBeatProperties - List of properties to be excluded

containsHeartBeatProperty

public boolean containsHeartBeatProperty(java.lang.String key)

Description copied from interface: HeartBeatProviderInterface

Returns true if the HeartBeat provider has the given HeartBeat Property

Specified by:

containsHeartBeatProperty in interface HeartBeatProviderInterface

Returns:

stop

public void stop(long timeout,
                 java.util.concurrent.TimeUnit timeUnit)

Specified by:

stop in interface Stoppable