Package org.incendo.serverlib

Class Check

java.lang.Object

org.incendo.serverlib.Check

Direct Known Subclasses:

ClassPresenceCheck, PackagePresenceCheck

public abstract class Check
extends Object

A check is any operation that can be done to determine whether unsafe software is being used.

Constructor Summary

Constructors

Constructor	Description
Check(CheckType type)	Constructs a new check.

Method Summary

Modifier and Type	Method	Description
abstract String[]	explain()	Explains the reasoning behind the check.
void	printExplanation()	Prints an explanation of what the check detected.
abstract boolean	shouldFlag()	Checks whether or not the check detects the presence of unsafe software.
CheckType	type()	Returns the type of this check.

Methods inherited from class java.lang.Object

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

Constructor Details

Check

public Check(CheckType type)

Constructs a new check.

Parameters:

type - The type of the check.

Method Details

type

public final CheckType type()

Returns the type of this check.

Returns:

The type of the check.

shouldFlag

public abstract boolean shouldFlag()

Checks whether or not the check detects the presence of unsafe software.

Returns:

Whether or not the check detects the presence of the unsafe software.

explain

public abstract String[] explain()

Explains the reasoning behind the check.

Returns:

Lines of text explaining what the check detected.

printExplanation

public final void printExplanation()

Prints an explanation of what the check detected.

The message is printed directly to the error output stream, so that a filter cannot be added directly to the Log4J instance of the server to filter out these messages.