Package gov.nist.secauto.decima.core.assessment.util

Class AssessmentSummarizingLoggingHandler

java.lang.Object

gov.nist.secauto.decima.core.assessment.util.AbstractDelegatingLoggingHandler

gov.nist.secauto.decima.core.assessment.util.AssessmentSummarizingLoggingHandler

All Implemented Interfaces:

LoggingHandler

public class AssessmentSummarizingLoggingHandler
extends AbstractDelegatingLoggingHandler

Constructor Summary

Constructors

Constructor	Description
AssessmentSummarizingLoggingHandler(org.apache.logging.log4j.Level summaryLogLevel)
AssessmentSummarizingLoggingHandler(org.apache.logging.log4j.Level summaryLogLevel, LoggingHandler delegate)

Method Summary

Modifier and Type	Method	Description
<DOC extends Document> void	addTestResult(Assessment<? extends DOC> assessment, DOC document, String derivedRequirementId, TestResult result)	Called when a new TestResult is reported against the identified derived requirement.
<DOC extends Document> void	assessmentCompleted(Assessment<? extends DOC> assessment, DOC document)	Signals that evaluation of the target assessment completed successfully.
<DOC extends Document> void	assessmentError(Assessment<? extends DOC> assessment, DOC document, Throwable th)	Signals that evaluation of the target assessment resulted in an error.
<DOC extends Document> void	assessmentStarted(Assessment<? extends DOC> assessment, DOC document)	Signals that evaluation of the target assessment started.
<DOC extends Document> void	assignTestStatus(Assessment<? extends DOC> assessment, DOC document, String derivedRequirementId, TestState state)	Called when the evaluated TestState for a derived requirement is directly reported.
AssessmentStats	getAssessmentStats(Assessment<?> assessment)
protected gov.nist.secauto.decima.core.assessment.util.AssessmentSummarizingLoggingHandler.AssessmentStatsImpl	getAssessmentStatsInternal(Assessment<?> assessment)
org.apache.logging.log4j.Level	getSummaryLogLevel()	Retrieve the logging level to use when logging.
protected <DOC extends Document> boolean	isProvideSummary(Assessment<? extends DOC> assessment, DOC document)

Methods inherited from class gov.nist.secauto.decima.core.assessment.util.AbstractDelegatingLoggingHandler

assessmentExecutionCompleted, assessmentExecutionStarted, completedResults, producingResults, validationEnded, validationStarted

Methods inherited from class java.lang.Object

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

Constructor Detail

AssessmentSummarizingLoggingHandler

public AssessmentSummarizingLoggingHandler(org.apache.logging.log4j.Level summaryLogLevel)

AssessmentSummarizingLoggingHandler

public AssessmentSummarizingLoggingHandler(org.apache.logging.log4j.Level summaryLogLevel,
                                           LoggingHandler delegate)

Method Detail

getSummaryLogLevel

public org.apache.logging.log4j.Level getSummaryLogLevel()

Retrieve the logging level to use when logging.

Returns:

the summaryLogLevel

assessmentStarted

public <DOC extends Document> void assessmentStarted(Assessment<? extends DOC> assessment,
                                                     DOC document)

Description copied from interface: LoggingHandler

Signals that evaluation of the target assessment started.

Specified by:

assessmentStarted in interface LoggingHandler

Overrides:

assessmentStarted in class AbstractDelegatingLoggingHandler

Type Parameters:

DOC - the type of document that is the target of the assessment

Parameters:

assessment - the target assessment

document - the document being assessed

assessmentError

public <DOC extends Document> void assessmentError(Assessment<? extends DOC> assessment,
                                                   DOC document,
                                                   Throwable th)

Description copied from interface: LoggingHandler

Signals that evaluation of the target assessment resulted in an error.

Specified by:

assessmentError in interface LoggingHandler

Overrides:

assessmentError in class AbstractDelegatingLoggingHandler

Type Parameters:

DOC - the type of document that is the target of the assessment

Parameters:

assessment - the target assessment

document - the document being assessed

th - the error that was thrown, or null if no exception was thrown

addTestResult

public <DOC extends Document> void addTestResult(Assessment<? extends DOC> assessment,
                                                 DOC document,
                                                 String derivedRequirementId,
                                                 TestResult result)

Description copied from interface: LoggingHandler

Called when a new TestResult is reported against the identified derived requirement.

Specified by:

addTestResult in interface LoggingHandler

Overrides:

addTestResult in class AbstractDelegatingLoggingHandler

Type Parameters:

DOC - the type of document that is the target of the assessment

Parameters:

assessment - the target assessment

document - the document being assessed

derivedRequirementId - the derived requirement the result is for

result - the reported result

assignTestStatus

public <DOC extends Document> void assignTestStatus(Assessment<? extends DOC> assessment,
                                                    DOC document,
                                                    String derivedRequirementId,
                                                    TestState state)

Description copied from interface: LoggingHandler

Called when the evaluated TestState for a derived requirement is directly reported.

Specified by:

assignTestStatus in interface LoggingHandler

Overrides:

assignTestStatus in class AbstractDelegatingLoggingHandler

Type Parameters:

DOC - the type of document that is the target of the assessment

Parameters:

assessment - the target assessment

document - the document being assessed

derivedRequirementId - the derived requirement for which the state change has occurred

state - the new state of the derived requirement

assessmentCompleted

public <DOC extends Document> void assessmentCompleted(Assessment<? extends DOC> assessment,
                                                       DOC document)

Description copied from interface: LoggingHandler

Signals that evaluation of the target assessment completed successfully.

Specified by:

assessmentCompleted in interface LoggingHandler

Overrides:

assessmentCompleted in class AbstractDelegatingLoggingHandler

Type Parameters:

DOC - the type of document that is the target of the assessment

Parameters:

assessment - the target assessment

document - the document being assessed

isProvideSummary

protected <DOC extends Document> boolean isProvideSummary(Assessment<? extends DOC> assessment,
                                                          DOC document)

getAssessmentStats

public AssessmentStats getAssessmentStats(Assessment<?> assessment)

getAssessmentStatsInternal

protected gov.nist.secauto.decima.core.assessment.util.AssessmentSummarizingLoggingHandler.AssessmentStatsImpl getAssessmentStatsInternal(Assessment<?> assessment)