Package com.priint.pubserver.check
interfaces and classes for server side configuration checks
- Since:
- 4.0.0
-
Interface Summary Interface Description ServerCheckRule Tagging interface for check rules. -
Class Summary Class Description CheckResult 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.CheckResult.Issue A single Issue
Issues should refer to a simple problem, e.g.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 -
Enum Summary Enum Description CheckResult.Solution.SolutionType Type of solutionCheckResult.Status The overall status of a check or status of a single issue