Package org.apache.pinot.common.utils

Class ServiceStatus

java.lang.Object

org.apache.pinot.common.utils.ServiceStatus

public class ServiceStatus
extends Object

Utility class to obtain the status of the Pinot instance running in this JVM.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceStatus.IdealStateAndCurrentStateMatchServiceStatusCallback	Service status callback that reports starting until all resources relevant to this instance have a matching external view and current state.
static class	ServiceStatus.IdealStateAndExternalViewMatchServiceStatusCallback	Service status callback that reports starting until all resources relevant to this instance have a matching external view and ideal state.
static class	ServiceStatus.LifecycleServiceStatusCallback
static class	ServiceStatus.MapBasedMultipleCallbackServiceStatusCallback
static class	ServiceStatus.MultipleCallbackServiceStatusCallback
static class	ServiceStatus.RealtimeConsumptionCatchupServiceStatusCallback	Service status callback that checks whether realtime consumption has caught up An offset based consumption status checker is being added in two phases.
static interface	ServiceStatus.ServiceStatusCallback	Callback that returns the status of the service.
static class	ServiceStatus.Status

Field Summary

Fields

Modifier and Type	Field	Description
static String	STATUS_DESCRIPTION_INIT
static String	STATUS_DESCRIPTION_NO_HELIX_STATE
static String	STATUS_DESCRIPTION_NONE
static String	STATUS_DESCRIPTION_SHUTTING_DOWN
static String	STATUS_DESCRIPTION_STARTED

Method Summary

Modifier and Type	Method	Description
static ServiceStatus.Status	getServiceStatus()
static ServiceStatus.Status	getServiceStatus(String name)
static Map<String,Map<String,String>>	getServiceStatusMap()
static String	getStatusDescription()
static String	getStatusDescription(String name)
static void	removeServiceStatusCallback(String name)
static void	setServiceStatusCallback(String name, ServiceStatus.ServiceStatusCallback serviceStatusCallback)

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_DESCRIPTION_NONE

public static final String STATUS_DESCRIPTION_NONE

See Also:

Constant Field Values

STATUS_DESCRIPTION_INIT

public static final String STATUS_DESCRIPTION_INIT

See Also:

Constant Field Values

STATUS_DESCRIPTION_STARTED

public static final String STATUS_DESCRIPTION_STARTED

See Also:

Constant Field Values

STATUS_DESCRIPTION_SHUTTING_DOWN

public static final String STATUS_DESCRIPTION_SHUTTING_DOWN

See Also:

Constant Field Values

STATUS_DESCRIPTION_NO_HELIX_STATE

public static final String STATUS_DESCRIPTION_NO_HELIX_STATE

See Also:

Constant Field Values

Method Detail

setServiceStatusCallback

public static void setServiceStatusCallback(String name,
                                            ServiceStatus.ServiceStatusCallback serviceStatusCallback)

removeServiceStatusCallback

public static void removeServiceStatusCallback(String name)

getServiceStatus

public static ServiceStatus.Status getServiceStatus()

getServiceStatus

public static ServiceStatus.Status getServiceStatus(String name)

getStatusDescription

public static String getStatusDescription()

getStatusDescription

public static String getStatusDescription(String name)

getServiceStatusMap

public static Map<String,Map<String,String>> getServiceStatusMap()