com.microsoft.applicationinsights.internal.heartbeat

Class WebAppsHeartbeatProvider

java.lang.Object

com.microsoft.applicationinsights.internal.heartbeat.WebAppsHeartbeatProvider

All Implemented Interfaces:

HeartBeatPayloadProviderInterface

public class WebAppsHeartbeatProvider
extends java.lang.Object
implements HeartBeatPayloadProviderInterface

WebApp Heartbeat Property Provider

This class is a concrete implementation of HeartBeatPayloadProviderInterface It enables setting Web-apps Metadata to heartbeat payload.

Constructor Summary

Constructors

Constructor and Description
WebAppsHeartbeatProvider() Constructor that initializes fields and load environment variables

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the heartbeat provider.
boolean	isKeyword(java.lang.String keyword) Tells if the input string is a reserved property.
java.util.concurrent.Callable<java.lang.Boolean>	setDefaultPayload(java.util.List<java.lang.String> disableFields, HeartBeatProviderInterface provider) Returns a callable which can be executed to set the payload based on the parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebAppsHeartbeatProvider

public WebAppsHeartbeatProvider()

Constructor that initializes fields and load environment variables

Method Detail

getName

public java.lang.String getName()

Description copied from interface: HeartBeatPayloadProviderInterface

Returns the name of the heartbeat provider.

Specified by:

getName in interface HeartBeatPayloadProviderInterface

Returns:

Name of the heartbeat provider

isKeyword

public boolean isKeyword(java.lang.String keyword)

Description copied from interface: HeartBeatPayloadProviderInterface

Tells if the input string is a reserved property.

Specified by:

isKeyword in interface HeartBeatPayloadProviderInterface

Parameters:

keyword - string to test

Returns:

true if input string is reserved keyword

setDefaultPayload

public java.util.concurrent.Callable<java.lang.Boolean> setDefaultPayload(java.util.List<java.lang.String> disableFields,
                                                                          HeartBeatProviderInterface provider)

Description copied from interface: HeartBeatPayloadProviderInterface

Returns a callable which can be executed to set the payload based on the parameters.

Specified by:

setDefaultPayload in interface HeartBeatPayloadProviderInterface

Parameters:

disableFields - List of Properties to be excluded from payload

provider - The current heartbeat provider

Returns:

Callable which can be executed to add the payload