com.quantum.dxi.rest.system

Class HealthCheck

java.lang.Object

Base

com.quantum.dxi.rest.system.HealthCheck

public class HealthCheck
extends Base

The HealthCheck resource represents the health check singleton on the system. The HealthCheck resource includes services for controlling and getting the status of health checks.

The schema that defines the HealthCheck resource is defined below.

 
   <xs:element name="HealthCheck">
       <xs:complexType>
           <xs:sequence>
               <xs:element name="HealthCheckSummary" minOccurs="0">
                   <xs:complexType>
                       <xs:sequence>
                           <xs:element name="Status" type="xs:string" minOccurs="0"/>
                           <xs:element name="Progress" type="xs:int" minOccurs="0"/>
                           <xs:element name="StartTime" type="xs:long" minOccurs="0"/>
                           <xs:element name="EndTime" type="xs:long" minOccurs="0"/>
                       </xs:sequence>
                   </xs:complexType>
               </xs:element>
               <xs:element name="HealthCheckDetails">
                   <xs:complexType>
                       <xs:sequence>
                           <xs:element name="DeDuplication" type="HealthCheckDetailType" minOccurs="0"/>
                           <xs:element name="Integrity" type="HealthCheckDetailType" minOccurs="0"/>
                       </xs:sequence>
                   </xs:complexType>
               </xs:element>
           </xs:sequence>
       </xs:complexType>
   </xs:element>
   <xs:complexType name="HealthCheckDetailType">
       <xs:sequence>
           <xs:element name="State" type="xs:boolean"/>
           <xs:element name="Started" type="xs:long" minOccurs="0"/>
           <xs:element name="Finished" type="xs:long" minOccurs="0"/>
           <xs:element name="Status" type="xs:string" minOccurs="0"/>
       </xs:sequence>
   </xs:complexType>
 
 

Constructor Summary

Constructors

Constructor and Description
HealthCheck()

Method Summary

Modifier and Type	Method and Description
com.quantum.dxi.dao.types.HealthCheck	getHealthCheck(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/HealthCheck
javax.ws.rs.core.Response	startHealthCheck(javax.servlet.http.HttpServletRequest request, String errorType) POST /rest/HealthCheck/start
void	stopHealthCheck(javax.servlet.http.HttpServletRequest request, String errorType) POST /rest/HealthCheck/stop
com.quantum.dxi.dao.types.HealthCheck	updateHealthCheck(javax.servlet.http.HttpServletRequest request, String errorType, com.quantum.dxi.dao.types.HealthCheck healthCheck) PUT /rest/HealthCheck

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheck

public HealthCheck()

Method Detail

startHealthCheck

public javax.ws.rs.core.Response startHealthCheck(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  String errorType)

POST /rest/HealthCheck/start

Start the system health checks.

Response Entity type: <xs:element name="StringScalarType">

Since:

1.1

stopHealthCheck

public void stopHealthCheck(@Context
                            javax.servlet.http.HttpServletRequest request,
                            String errorType)

POST /rest/HealthCheck/stop

Stop the system health checks.

Since:

1.1

getHealthCheck

public com.quantum.dxi.dao.types.HealthCheck getHealthCheck(@Context
                                                            javax.servlet.http.HttpServletRequest request,
                                                            String errorType)

GET /rest/HealthCheck

Get the status of the system health checks.

Response Entity type: <xs:element name="HealthCheck">

Since:

1.1

updateHealthCheck

public com.quantum.dxi.dao.types.HealthCheck updateHealthCheck(@Context
                                                               javax.servlet.http.HttpServletRequest request,
                                                               String errorType,
                                                               com.quantum.dxi.dao.types.HealthCheck healthCheck)

PUT /rest/HealthCheck

Enable or disable health checks on the system. Request Entity type: <xs:element name="HealthCheck">

Response Entity type: <xs:element name="HealthCheck">

Since:

1.1