Package com.priint.pubserver.check

Class CheckResult

java.lang.Object

com.priint.pubserver.check.CheckResult

All Implemented Interfaces:

java.io.Serializable

public class CheckResult
extends java.lang.Object
implements java.io.Serializable

The CheckResult class provides detailed information about the result of a configuration check.
Methods annotated as PubServerMethods with type=PluginMethod.MethodType.CONFIGURATION_CHECK are expected to return a non null CheckResult object.
Since these checks can be very complex, a CheckResult can (but does not have to) provide a list of Issues, each one of them describing the result of a single examination, test or configuration item.
CheckResults and Issues can provide a solution suggestion.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CheckResult.Issue	A single Issue Issues should refer to a simple problem, e.g.
static class	CheckResult.Solution	A suggested Solution for a Check or Issue. The solution can be a manual fix, which is described by the solutionDescription field a method call, which is defined by the method field a delete request, which is explained by the solutionDescription field suggestion to call the support, which of course should be the last resort for all issues
static class	CheckResult.Status	The overall status of a check or status of a single issue

Constructor Summary

Constructors

Constructor	Description
CheckResult()	Default constructor
CheckResult(java.lang.String pluginMappedName)	Constructor with pluginMappedName parameter which set pluginMappedName variable in class

Method Summary

Modifier and Type	Method	Description
void	addIssue(CheckResult.Issue issue)
CheckResult.Issue	addIssue(java.lang.String repositoryPath, java.lang.String repositoryType, java.lang.String statusDescription, CheckResult.Status status)
void	addSolution(CheckResult.Solution solution)
void	addSolutionDelete(java.lang.String instructions)	Add a delete proposal for this check
void	addSolutionManualFix(java.lang.String instructions)	Add a manual fix proposal for this check
void	addSolutionMethodCall(java.lang.String instructions, PluginMethod method)	Add a method call proposal for this check
void	addSolutionSupportRequest(java.lang.String instructions)	Add a support request proposal for this check
void	calculateStatus()	Calculate the overall status for this check.
java.util.List<CheckResult.Issue>	getIssues()
java.lang.String	getPath()
java.lang.String	getPluginMappedName()
java.util.List<CheckResult.Solution>	getSolutions()
CheckResult.Status	getStatus()	Get the overall status of this check
java.lang.String	getStatusDescription()
java.lang.String	getSummary()
void	setIssues(java.util.List<CheckResult.Issue> issues)
void	setPath(java.lang.String path)	Set path to configuration
void	setPluginMappedName(java.lang.String pluginMappedName)	Set plugin mapped name
void	setSolutions(java.util.List<CheckResult.Solution> solutions)
void	setStatus(CheckResult.Status status)	Set the overall status of this check.
void	setStatusDescription(java.lang.String statusDescription)
void	setSummary(java.lang.String summary)	Set summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CheckResult

public CheckResult(java.lang.String pluginMappedName)

Constructor with pluginMappedName parameter which set pluginMappedName variable in class

CheckResult

public CheckResult()

Default constructor

Method Detail

calculateStatus

public void calculateStatus()

Calculate the overall status for this check. The status will be set to the status of the "most severe" issue of this check.

getStatus

public CheckResult.Status getStatus()

Get the overall status of this check

Returns:

the overall status of this check

setStatus

public void setStatus(CheckResult.Status status)

Set the overall status of this check. Alternatively the status can be calculated by calling calculateStatus.

Parameters:

status - status of this check

getSummary

public java.lang.String getSummary()

Returns:

Summary

setSummary

public void setSummary(java.lang.String summary)

Set summary

getPluginMappedName

public java.lang.String getPluginMappedName()

Returns:

Get plugin mapped name

setPluginMappedName

public void setPluginMappedName(java.lang.String pluginMappedName)

Set plugin mapped name

getStatusDescription

public java.lang.String getStatusDescription()

Returns:

statusDescription

setStatusDescription

public void setStatusDescription(java.lang.String statusDescription)

Parameters:

statusDescription -

getIssues

public java.util.List<CheckResult.Issue> getIssues()

Returns:

Get Issues list

setIssues

public void setIssues(java.util.List<CheckResult.Issue> issues)

Parameters:

Set - Issues list

addIssue

public void addIssue(CheckResult.Issue issue)

Parameters:

Add - issue to Issues list

addIssue

public CheckResult.Issue addIssue(java.lang.String repositoryPath,
                                  java.lang.String repositoryType,
                                  java.lang.String statusDescription,
                                  CheckResult.Status status)

Parameters:

repositoryPath -

repositoryType -

statusDescription -

status -

Returns:

the new issue

getSolutions

public java.util.List<CheckResult.Solution> getSolutions()

Returns:

Get solutions list

setSolutions

public void setSolutions(java.util.List<CheckResult.Solution> solutions)

Parameters:

Set - solutions list

addSolution

public void addSolution(CheckResult.Solution solution)

Parameters:

Add - solution to solution list

getPath

public java.lang.String getPath()

Returns:

Configuration path

setPath

public void setPath(java.lang.String path)

Set path to configuration

addSolutionManualFix

public void addSolutionManualFix(java.lang.String instructions)

Add a manual fix proposal for this check

Parameters:

instructions -

addSolutionMethodCall

public void addSolutionMethodCall(java.lang.String instructions,
                                  PluginMethod method)

Add a method call proposal for this check

Parameters:

instructions -

method -

addSolutionDelete

public void addSolutionDelete(java.lang.String instructions)

Add a delete proposal for this check

Parameters:

instructions -

addSolutionSupportRequest

public void addSolutionSupportRequest(java.lang.String instructions)

Add a support request proposal for this check

Parameters:

instructions -