Package gov.nist.secauto.oscal.lib.profile.resolver.selection

Interface IControlFilter

All Known Implementing Classes:

IControlFilter.Filter

public interface IControlFilter

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IControlFilter.Filter

Field Summary

Fields

Modifier and Type	Field	Description
static IControlFilter	ALWAYS_MATCH
static IControlFilter	NONE_MATCH

Method Summary

Modifier and Type	Method	Description
IControlSelectionFilter	getExclusionFilter()
IControlSelectionFilter	getInclusionFilter()
default org.apache.commons.lang3.tuple.Pair<Boolean,Boolean>	match(IControl control)	Determines if the control is matched by this filter.
org.apache.commons.lang3.tuple.Pair<Boolean,Boolean>	match(IControl control, boolean defaultMatch)	Determines if the control is matched by this filter.
static IControlFilter	newInstance(ProfileImport profileImport)	Construct a new filter instance based on the provided profile import statement.
static IControlFilter	newInstance(IControlSelectionFilter includes, IControlSelectionFilter excludes)

Field Detail

ALWAYS_MATCH

@NonNull
static final IControlFilter ALWAYS_MATCH

NONE_MATCH

@NonNull
static final IControlFilter NONE_MATCH

Method Detail

newInstance

@NonNull
static IControlFilter newInstance(@NonNull
                                  ProfileImport profileImport)

Construct a new filter instance based on the provided profile import statement.

Parameters:

profileImport - an OSCAL profile import statement

Returns:

a new control filter

newInstance

@NonNull
static IControlFilter newInstance(@NonNull
                                  IControlSelectionFilter includes,
                                  @NonNull
                                  IControlSelectionFilter excludes)

match

@NonNull
default org.apache.commons.lang3.tuple.Pair<Boolean,Boolean> match(@NonNull
                                                                         IControl control)

Determines if the control is matched by this filter. This method returns a Pair where the first member of the pair indicates if the control matches, and the second indicates if the match applies to child controls as well.

Parameters:

control - the control to check for a match

Returns:

a pair indicating the status of the match (true for a match or false otherwise), and if a match applies to child controls

match

@NonNull
org.apache.commons.lang3.tuple.Pair<Boolean,Boolean> match(@NonNull
                                                                 IControl control,
                                                                 boolean defaultMatch)

Determines if the control is matched by this filter. This method returns a Pair where the first member of the pair indicates if the control matches, and the second indicates if the match applies to child controls as well.

Parameters:

control - the control to check for a match

defaultMatch - the match status to use if the filter doesn't have an explicit hit

Returns:

a pair indicating the status of the match (true for a match or false otherwise), and if a match applies to child controls

getInclusionFilter

@NonNull
IControlSelectionFilter getInclusionFilter()

getExclusionFilter

@NonNull
IControlSelectionFilter getExclusionFilter()