Package com.symphony.bdk.core.service.health

Class HealthService

java.lang.Object

com.symphony.bdk.core.service.health.HealthService

@API(status=STABLE)
public class HealthService
extends Object

Service class for checking health of the Agent server.

Constructor Summary

Constructors

Constructor	Description
HealthService(SystemApi systemApi, SignalsApi signalsApi, AuthSession authSession)
HealthService(SystemApi systemApi, SignalsApi signalsApi, AuthSession authSession, DatafeedLoop datafeedLoop)

Method Summary

Modifier and Type	Method	Description
V3HealthStatus	datafeedHealthCheck()	Return the connectivity status of the DataFeed long pulling connection.
AgentInfo	getAgentInfo()	Gets information about the Agent.
V3Health	healthCheck()	Returns the connectivity status of your Agent server.
V3Health	healthCheckExtended()	Returns the connectivity status of the Agent services as well as users connectivity.
void	setDatafeedLoop(DatafeedLoop datafeedLoop)

Methods inherited from class java.lang.Object

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

Constructor Details

HealthService

public HealthService(SystemApi systemApi,
 SignalsApi signalsApi,
 AuthSession authSession)

HealthService

public HealthService(SystemApi systemApi,
 SignalsApi signalsApi,
 AuthSession authSession,
 DatafeedLoop datafeedLoop)

Method Details

setDatafeedLoop

public void setDatafeedLoop(DatafeedLoop datafeedLoop)

healthCheck

public V3Health healthCheck()

Returns the connectivity status of your Agent server. If your Agent server is started and running properly, the status value will be UP. Available on Agent 2.57.0 and above.

Returns:

V3Health the connectivity status of your Agent server.

See Also:

• Health Check v3

healthCheckExtended

public V3Health healthCheckExtended()

Returns the connectivity status of the Agent services as well as users connectivity. Available on Agent 2.57.0 and above.

Returns:

V3Health the connectivity status of the Agent services as well as users connectivity.

See Also:

• Healt Check Extended v3

datafeedHealthCheck

public V3HealthStatus datafeedHealthCheck()

Return the connectivity status of the DataFeed long pulling connection.

Returns:

V3HealthStatus the connectivity status

getAgentInfo

public AgentInfo getAgentInfo()

Gets information about the Agent. Available on Agent 2.53.0 and above.

Returns:

AgentInfo information of the agent server.

See Also:

• Agent Info v1