org.jboss.aerogear.unifiedpush.rest.util

Class HealthCheck

java.lang.Object

org.jboss.aerogear.unifiedpush.rest.util.HealthCheck

public class HealthCheck
extends Object

A class to test 'health' of the server

Constructor Summary

Constructors

Constructor and Description
HealthCheck()

Method Summary

Modifier and Type	Method and Description
HealthStatus	health() Get health status
javax.ws.rs.core.Response	manifestDetails(javax.servlet.http.HttpServletRequest request) Endpoint to verify scm and version details
javax.ws.rs.core.Response	ping() Simple Ping endpoint to check if the UPS is running as expected

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheck

public HealthCheck()

Method Detail

health

public HealthStatus health()
                    throws ExecutionException,
                           InterruptedException

Get health status

Returns:

HealthStatus with details

Throws:

ExecutionException - The computation of health status threw an exception

InterruptedException - The thread, which compute health status, was interrupted

ping

public javax.ws.rs.core.Response ping()

Simple Ping endpoint to check if the UPS is running as expected

Returns:

simple OK string if the server is running

manifestDetails

public javax.ws.rs.core.Response manifestDetails(@Context
                                                 javax.servlet.http.HttpServletRequest request)

Endpoint to verify scm and version details

Returns:

Attributes

Status codes:

200 Successful response for your request with manifest's attributes, 404 Not found version information