Index

A B C D E F G H I N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

active() - Static method in class org.gcube.common.health.api.ContextState

Returns the state of an application that works in the Context.

ACTIVE - Static variable in class org.gcube.common.health.api.ContextState

The value of an application that works in the Context.

B

build() - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder.BuildPart

builder(String) - Static method in class org.gcube.common.health.api.response.HealthCheckResponse

C

check() - Method in interface org.gcube.common.health.api.HealthCheck

ContextPreparation - Interface in org.gcube.common.health.api

How an application prepares itself in one of its Contexts (e.g. reads or creates its configuration there and reaches what it needs) and reports its state there.

ContextPreparer - Annotation Interface in org.gcube.common.health.api

Marks the ContextPreparation of an application: SmartGears finds it and uses it to prepare the application in each of its Contexts and to report its state there.

ContextState - Class in org.gcube.common.health.api

The state of an application in one of its Contexts: pending before it has been prepared there, active when it works there, degraded when it works with a problem to verify, inactive when it cannot work there.

D

data - Variable in class org.gcube.common.health.api.response.HealthCheckResponse

Structured data of the check (values are strings, numbers, booleans or lists of them), absent when there is none.

degraded() - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder

The check is ready but degraded, e.g. a cache not reachable while the service still works: error says why.

degraded(String) - Static method in class org.gcube.common.health.api.ContextState

Returns the state of an application that works in the Context with a problem to verify.

DEGRADED - Enum constant in enum class org.gcube.common.health.api.Status

Ready, with reduced performance or a missing part (e.g. a cache not reachable).

DEGRADED - Static variable in class org.gcube.common.health.api.ContextState

The value of an application that works in the Context with a problem to verify.

description - Variable in class org.gcube.common.health.api.response.HealthCheckResponse

What the check verifies, from HealthCheck.getDescription().

down() - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder

DOWN - Enum constant in enum class org.gcube.common.health.api.Status

Not ready.

E

equals(Object) - Method in class org.gcube.common.health.api.ContextState

error(String) - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder.ErrorPart

Says why the check is degraded or down.

errorMessage - Variable in class org.gcube.common.health.api.response.HealthCheckResponse

F

fromValue(String) - Static method in enum class org.gcube.common.health.api.Status

Returns the status of a JSON value; the names of the constants (UP) are accepted too.

G

getData() - Method in class org.gcube.common.health.api.response.HealthCheckResponse

Returns the structured data of the check, e.g. the Contexts a service runs in.

getDescription() - Method in interface org.gcube.common.health.api.HealthCheck

Returns what the check verifies, in one sentence for a reader of the health, e.g.

getDescription() - Method in class org.gcube.common.health.api.response.HealthCheckResponse

Returns what the check verifies.

getErrorMessage() - Method in class org.gcube.common.health.api.response.HealthCheckResponse

getInfo() - Method in class org.gcube.common.health.api.response.HealthCheckResponse

getName() - Method in interface org.gcube.common.health.api.HealthCheck

getName() - Method in class org.gcube.common.health.api.response.HealthCheckResponse

getReason() - Method in class org.gcube.common.health.api.ContextState

Returns the reason of a degraded or inactive state.

getStatus() - Method in class org.gcube.common.health.api.response.HealthCheckResponse

getValue() - Method in class org.gcube.common.health.api.ContextState

Returns the value of the state: pending, active, degraded or inactive.

H

hashCode() - Method in class org.gcube.common.health.api.ContextState

HealthCheck - Interface in org.gcube.common.health.api

HealthCheckResponse - Class in org.gcube.common.health.api.response

HealthCheckResponse() - Constructor for class org.gcube.common.health.api.response.HealthCheckResponse

HealthCheckResponseBuilder - Class in org.gcube.common.health.api.response

HealthCheckResponseBuilder(String) - Constructor for class org.gcube.common.health.api.response.HealthCheckResponseBuilder

HealthCheckResponseBuilder.BuildPart - Class in org.gcube.common.health.api.response

HealthCheckResponseBuilder.ErrorPart - Class in org.gcube.common.health.api.response

HealthCheckResponseBuilder.SuccessPart - Class in org.gcube.common.health.api.response

I

inactive(String) - Static method in class org.gcube.common.health.api.ContextState

Returns the state of an application that cannot work in the Context.

INACTIVE - Static variable in class org.gcube.common.health.api.ContextState

The value of an application that cannot work in the Context.

info - Variable in class org.gcube.common.health.api.response.HealthCheckResponse

info(String) - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder.SuccessPart

isReady() - Method in enum class org.gcube.common.health.api.Status

Returns whether the status is ready: up or degraded.

isWorking() - Method in class org.gcube.common.health.api.ContextState

Tells whether the application works in the Context (active or degraded).

N

name - Variable in class org.gcube.common.health.api.response.HealthCheckResponse

NOT_CALCULATED - Enum constant in enum class org.gcube.common.health.api.Status

Not computed yet.

O

org.gcube.common.health.api - package org.gcube.common.health.api

org.gcube.common.health.api.response - package org.gcube.common.health.api.response

P

pending() - Static method in class org.gcube.common.health.api.ContextState

Returns the state of an application not prepared yet in the Context.

PENDING - Static variable in class org.gcube.common.health.api.ContextState

The value of an application not prepared yet in the Context.

prepare() - Method in interface org.gcube.common.health.api.ContextPreparation

Prepares the application in the Context of the caller.

R

ReadinessChecker - Annotation Interface in org.gcube.common.health.api

Marks a HealthCheck of an application: SmartGears finds it, runs it at the start and then every minute, and reports it in the health of the application.

S

setDescription(String) - Method in class org.gcube.common.health.api.response.HealthCheckResponse

Sets what the check verifies: the runner of the checks copies it from the check.

state() - Method in interface org.gcube.common.health.api.ContextPreparation

Returns the state of the application in the Context of the caller, without preparing it.

status - Variable in class org.gcube.common.health.api.response.HealthCheckResponse

Status - Enum Class in org.gcube.common.health.api

T

toString() - Method in class org.gcube.common.health.api.ContextState

U

up() - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder

UP - Enum constant in enum class org.gcube.common.health.api.Status

Ready.

V

value() - Method in enum class org.gcube.common.health.api.Status

Returns the value of the status in JSON, in lowerCamelCase as every enumerated value of the Information System.

valueOf(String) - Static method in enum class org.gcube.common.health.api.Status

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.gcube.common.health.api.Status

Returns an array containing the constants of this enum class, in the order they are declared.

W

withData(String, Object) - Method in class org.gcube.common.health.api.response.HealthCheckResponseBuilder.BuildPart

Adds an entry to the structured data of the check.

A B C D E F G H I N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values