Package eu.xenit.alfresco.healthprocessor.fixer.api

Class NodeFixReport

java.lang.Object

eu.xenit.alfresco.healthprocessor.fixer.api.NodeFixReport

All Implemented Interfaces:

NodeHealthReport.PersistableData, Serializable

public final class NodeFixReport
extends Object
implements NodeHealthReport.PersistableData

Attachment to a NodeHealthReport that contains attempted fixes made on a NodeHealthReport. Fixes attempted by an HealthFixerPlugin result in a NodeFixReport that contains the details about the status of the attempted fix.

Since:

0.5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
NodeFixReport(NodeFixStatus status, NodeHealthReport healthReport)
NodeFixReport(NodeFixStatus status, NodeHealthReport healthReport, String... messages)
NodeFixReport(NodeFixStatus status, NodeHealthReport healthReport, Collection<String> messages)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
NodeFixStatus	getFixStatus()	Result of this fix
NodeHealthReport	getHealthReport()	Health report of the attempted fix
Set<String>	getMessages()	Messages about this fix
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeFixReport

@OnlyForUseIn(FIXER)
public NodeFixReport(@Nonnull
                     NodeFixStatus status,
                     @Nonnull
                     NodeHealthReport healthReport)

NodeFixReport

@OnlyForUseIn(FIXER)
public NodeFixReport(@Nonnull
                     NodeFixStatus status,
                     @Nonnull
                     NodeHealthReport healthReport,
                     String... messages)

NodeFixReport

@OnlyForUseIn(FIXER)
public NodeFixReport(@Nonnull
                     NodeFixStatus status,
                     @Nonnull
                     NodeHealthReport healthReport,
                     Collection<String> messages)

Method Detail

getFixStatus

public NodeFixStatus getFixStatus()

Result of this fix

getMessages

public Set<String> getMessages()

Messages about this fix

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getHealthReport

@OnlyForUseIn(FIXER)
public NodeHealthReport getHealthReport()

Health report of the attempted fix

Implementation note:

This field is transient, so it is not serialized, to avoid a circular reference. This means this link will not be available after the HealthReportsStore has stored a NodeHealthReport. It is only used to be able to link a NodeFixReport returned from HealthFixerPlugin.fix(Class, Set) to its corresponding NodeHealthReport in HealthProcessor internals. The HealthProcessor fixers component will link it via NodeHealthReport.data(), so we have no need for this backlink afterwards.