Index (gCube Health API 1.1.0-SNAPSHOT API)

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
compute() - Method in interface org.gcube.common.health.api.Statistics: Computes the group.
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.
CRITICAL - Enum constant in enum class org.gcube.common.health.api.State: Something that does not work, or is gone: e.g. a deleted Context.

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.
DEFAULT_REFRESH - Static variable in interface org.gcube.common.health.api.Statistics: How often a group is computed again, unless it says otherwise.
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().
description() - Method in interface org.gcube.common.health.api.Statistics: Returns what the group describes, in one sentence.
distribution(String, String, Map<String, ? extends Number>) - Static method in class org.gcube.common.health.api.Figure: Creates a figure that gives the parts of a whole by name, in the order given.
DISTRIBUTION - Static variable in class org.gcube.common.health.api.Figure: The kind of a figure that gives the parts of a whole by name.
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
equals(Object) - Method in class org.gcube.common.health.api.Figure
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

Figure - Class in org.gcube.common.health.api: One figure of a group of Statistics, with the label a page shows and its kind, which tells the page how to draw it: "number": one number, drawn as a tile; "distribution": the parts of a whole by name (e.g. the requests by outcome), drawn as a donut with percentages; "states": the parts of a whole by state (e.g. the Contexts by state), with what each state means (State), drawn like a distribution with the colour of each meaning; "values": a number by name that is not a part of a whole (e.g. an average per depth), drawn as bars, without percentages.
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
getId() - Method in class org.gcube.common.health.api.Figure
getInfo() - Method in class org.gcube.common.health.api.response.HealthCheckResponse
getKind() - Method in class org.gcube.common.health.api.Figure: Returns how a page draws the figure: "number", "distribution", "states" or "values".
getLabel() - Method in class org.gcube.common.health.api.Figure
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.
getStates() - Method in class org.gcube.common.health.api.Figure: Returns what each state of a figure of kind "states" means.
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.
getValue() - Method in class org.gcube.common.health.api.Figure: Returns the value: a Number for "number", an unmodifiable Map of numbers by name for the other kinds.
GOOD - Enum constant in enum class org.gcube.common.health.api.State: Everything works: e.g. an active Context.

H

hashCode() - Method in class org.gcube.common.health.api.ContextState
hashCode() - Method in class org.gcube.common.health.api.Figure
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

id() - Method in interface org.gcube.common.health.api.Statistics: Returns the identifier of the group, its field in the document: lowerCamelCase, unique among the groups of the application.
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
NEUTRAL - Enum constant in enum class org.gcube.common.health.api.State: Neither good nor bad: e.g. a Context created and not active yet.
NOT_CALCULATED - Enum constant in enum class org.gcube.common.health.api.Status: Not computed yet.
number(String, String, Number) - Static method in class org.gcube.common.health.api.Figure: Creates a figure that is a number.
NUMBER - Static variable in class org.gcube.common.health.api.Figure: The kind of a figure that is one number.

O

order() - Element in annotation interface org.gcube.common.health.api.StatisticsGroup: Where the group comes among the groups of the application: the groups are given by their order, then by their identifier.
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.
refresh() - Method in interface org.gcube.common.health.api.Statistics: Returns how often the group is computed again: a group that is expensive to compute declares a longer interval.

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.
State - Enum Class in org.gcube.common.health.api: What a state means, as a figure of kind Figure.STATES declares it for each of its states, so that a page draws each with the colour of its meaning instead of guessing it from its name.
states(String, String, Map<String, ? extends Number>, Map<String, State>) - Static method in class org.gcube.common.health.api.Figure: Creates a figure that gives the parts of a whole by state, in the order given, with what each state means.
STATES - Static variable in class org.gcube.common.health.api.Figure: The kind of a figure that gives the parts of a whole by state.
Statistics - Interface in org.gcube.common.health.api: One group of public statistics of an application, e.g. the Contexts of a registry: aggregate numbers only, never a name of a Context, an identifier or a user.
StatisticsGroup - Annotation Interface in org.gcube.common.health.api: Marks a group of public statistics of an application, a class implementing Statistics: SmartGears finds every such class of the application, computes each group on its own schedule and serves the last results without a token at /smartgears/<application>/statistics.
status - Variable in class org.gcube.common.health.api.response.HealthCheckResponse
Status - Enum Class in org.gcube.common.health.api

T

title() - Method in interface org.gcube.common.health.api.Statistics: Returns the title of the group, as a page shows it.
toString() - Method in class org.gcube.common.health.api.ContextState
toString() - Method in class org.gcube.common.health.api.Figure

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.State: Returns the name of the meaning in JSON: good, warning, critical, neutral.
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.State: Returns the enum constant of this class with the specified name.
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.State: Returns an array containing the constants of this enum class, in the order they are declared.
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.
values(String, String, Map<String, ? extends Number>) - Static method in class org.gcube.common.health.api.Figure: Creates a figure that gives a number by name that is not a part of a whole (e.g. an average, a median or a maximum per depth), in the order given.
VALUES - Static variable in class org.gcube.common.health.api.Figure: The kind of a figure that gives a number by name, not the parts of a whole.

W

WARNING - Enum constant in enum class org.gcube.common.health.api.State: Something to look at: e.g. a suspended Context.
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