de.otto.edison.status.domain

Class StatusDetail

java.lang.Object

de.otto.edison.status.domain.StatusDetail

@Immutable
public class StatusDetail
extends java.lang.Object

The status of a job, component, repository or other part of the application. StatusDetails are aggreagated to the overall status of the application. This information is exposed by the StatusController via REST. In order to accounce the current status of some part of the application, StatusDetailIndicator can be implemented.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.lang.String>	getDetails() Additional details about the current status of the job, component, ...
java.lang.String	getMessage() A short message describing the current status.
java.lang.String	getName() Short name of the status detail.
Status	getStatus() Status indicating the health / availability of the job, component, ...
int	hashCode()
static StatusDetail	statusDetail(java.lang.String name, Status status, java.lang.String message)
static StatusDetail	statusDetail(java.lang.String name, Status status, java.lang.String message, java.util.Map<java.lang.String,java.lang.String> additionalAttributes)
StatusDetail	toError(java.lang.String message) Create a copy of this StatusDetail, updates the message, changes the status to ERROR, and return the new StatusDetail.
StatusDetail	toOk(java.lang.String message) Create a copy of this StatusDetail, updates the message, changes the status to OK, and return the new StatusDetail.
java.lang.String	toString()
StatusDetail	toWarning(java.lang.String message) Create a copy of this StatusDetail, updates the message, changes the status to WARNING, and return the new StatusDetail.
StatusDetail	withDetail(java.lang.String key, java.lang.String value) Create a copy of this StatusDetail, add a detail and return the new StatusDetail.
StatusDetail	withoutDetail(java.lang.String key) Create a copy of this StatusDetail, remove a detail and return the new StatusDetail.

Methods inherited from class java.lang.Object

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

Method Detail

statusDetail

public static StatusDetail statusDetail(java.lang.String name,
                                        Status status,
                                        java.lang.String message)

statusDetail

public static StatusDetail statusDetail(java.lang.String name,
                                        Status status,
                                        java.lang.String message,
                                        java.util.Map<java.lang.String,java.lang.String> additionalAttributes)

toOk

public StatusDetail toOk(java.lang.String message)

Create a copy of this StatusDetail, updates the message, changes the status to OK, and return the new StatusDetail.

Parameters:

message - the new message

Returns:

StatusDetail

toWarning

public StatusDetail toWarning(java.lang.String message)

Create a copy of this StatusDetail, updates the message, changes the status to WARNING, and return the new StatusDetail.

Parameters:

message - the new message

Returns:

StatusDetail

toError

public StatusDetail toError(java.lang.String message)

Create a copy of this StatusDetail, updates the message, changes the status to ERROR, and return the new StatusDetail.

Parameters:

message - the new message

Returns:

StatusDetail

withDetail

public StatusDetail withDetail(java.lang.String key,
                               java.lang.String value)

Create a copy of this StatusDetail, add a detail and return the new StatusDetail.

Parameters:

key - the key of the additional detail

value - the value of the additional detail

Returns:

StatusDetail

withoutDetail

public StatusDetail withoutDetail(java.lang.String key)

Create a copy of this StatusDetail, remove a detail and return the new StatusDetail.

Parameters:

key - the key of the additional detail

Returns:

StatusDetail

getName

public java.lang.String getName()

Short name of the status detail.

Returns:

name

getStatus

public Status getStatus()

Status indicating the health / availability of the job, component, ...

Returns:

Status

getMessage

public java.lang.String getMessage()

A short message describing the current status.

Returns:

String

getDetails

public java.util.Map<java.lang.String,java.lang.String> getDetails()

Additional details about the current status of the job, component, ...

Returns:

Map

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object