Record Class ControlEvidence

java.lang.Object

java.lang.Record

org.j7m.middleware.compliance.api.ControlEvidence

Record Components:

timestamp - collection timestamp

runtimeId - runtime id, when runtime-specific

environment - environment label

controlId - control id

sourceModule - source module or component

collectionMethod - collection method

result - safe result text

limitation - known limitation or gap

correlationId - correlation id

signatureMetadata - safe hash/signature metadata

attributes - additional safe attributes

public record ControlEvidence(Instant timestamp, String runtimeId, String environment, ControlId controlId, String sourceModule, String collectionMethod, String result, String limitation, String correlationId, Map<String,String> signatureMetadata, Map<String,String> attributes)
extends Record

Evidence record collected for a control assessment.

Evidence is a factual observation. It is not a certification claim. The record is immutable and safe to share between threads.

Constructor Summary

Constructors

Constructor	Description
ControlEvidence(Instant timestamp, String runtimeId, String environment, ControlId controlId, String sourceModule, String collectionMethod, String result, String limitation, String correlationId, Map<String,String> signatureMetadata, Map<String,String> attributes)	Creates normalized immutable evidence.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	Returns the value of the attributes record component.
String	collectionMethod()	Returns the value of the collectionMethod record component.
ControlId	controlId()	Returns the value of the controlId record component.
String	correlationId()	Returns the value of the correlationId record component.
String	environment()	Returns the value of the environment record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	limitation()	Returns the value of the limitation record component.
String	result()	Returns the value of the result record component.
String	runtimeId()	Returns the value of the runtimeId record component.
Map<String,String>	signatureMetadata()	Returns the value of the signatureMetadata record component.
String	sourceModule()	Returns the value of the sourceModule record component.
Instant	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ControlEvidence

public ControlEvidence(Instant timestamp,
 String runtimeId,
 String environment,
 ControlId controlId,
 String sourceModule,
 String collectionMethod,
 String result,
 String limitation,
 String correlationId,
 Map<String,String> signatureMetadata,
 Map<String,String> attributes)

Creates normalized immutable evidence.

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component

runtimeId

public String runtimeId()

Returns the value of the runtimeId record component.

Returns:

the value of the runtimeId record component

environment

public String environment()

Returns the value of the environment record component.

Returns:

the value of the environment record component

controlId

public ControlId controlId()

Returns the value of the controlId record component.

Returns:

the value of the controlId record component

sourceModule

public String sourceModule()

Returns the value of the sourceModule record component.

Returns:

the value of the sourceModule record component

collectionMethod

public String collectionMethod()

Returns the value of the collectionMethod record component.

Returns:

the value of the collectionMethod record component

result

public String result()

Returns the value of the result record component.

Returns:

the value of the result record component

limitation

public String limitation()

Returns the value of the limitation record component.

Returns:

the value of the limitation record component

correlationId

public String correlationId()

Returns the value of the correlationId record component.

Returns:

the value of the correlationId record component

signatureMetadata

public Map<String,String> signatureMetadata()

Returns the value of the signatureMetadata record component.

Returns:

the value of the signatureMetadata record component

attributes

public Map<String,String> attributes()

Returns the value of the attributes record component.

Returns:

the value of the attributes record component