Package io.wcm.tooling.commons.packmgr.httpaction

Record Class SystemReadyStatus

java.lang.Object

java.lang.Record

io.wcm.tooling.commons.packmgr.httpaction.SystemReadyStatus

Record Components:

overallResult - overall result

results - list of individual results

public record SystemReadyStatus(String overallResult, List<SystemReadyStatus.Result> results)
extends Record

POJO to map system ready JSON response to via Jackson.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SystemReadyStatus.Message	Represents a message within a health check result.
static final record	SystemReadyStatus.Result	Represents a single health check result.

Constructor Summary

Constructors

Constructor	Description
SystemReadyStatus(String overallResult, List<SystemReadyStatus.Result> results)	Creates an instance of a SystemReadyStatus record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getFailureInfoString()	Returns a human-readable string with failure information if the system is not ready.
final int	hashCode()	Returns a hash code value for this object.
boolean	isSystemReadyOK()	Checks if the overall system ready status is OK.
String	overallResult()	Returns the value of the overallResult record component.
List<SystemReadyStatus.Result>	results()	Returns the value of the results record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SystemReadyStatus

public SystemReadyStatus(String overallResult,
 List<SystemReadyStatus.Result> results)

Creates an instance of a SystemReadyStatus record class.

Parameters:

overallResult - the value for the overallResult record component

results - the value for the results record component

Method Details

isSystemReadyOK

public boolean isSystemReadyOK()

Checks if the overall system ready status is OK.

Returns:

true if overall status is OK

getFailureInfoString

public String getFailureInfoString()

Returns a human-readable string with failure information if the system is not ready. If the system is ready, returns null.

Returns:

failure information string or null

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

overallResult

public String overallResult()

Returns the value of the overallResult record component.

Returns:

the value of the overallResult record component

results

public List<SystemReadyStatus.Result> results()

Returns the value of the results record component.

Returns:

the value of the results record component