Interface DependencyCollectionChecker

public interface DependencyCollectionChecker

Dependency collector checker. It is able to check dependency collection result, deem it "satisfiable" or augment collection and re-execute it.

Since:

2.0.19

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTOR_CHECKER_SUPPRESSED	Config property for collector checker suppression.
static final DependencyCollectionChecker	NOOP	A default "no op" implementation.

Method Summary

Modifier and Type	Method	Description
default boolean	isSatisfactory(RepositorySystemSession session, CollectRequest request, CollectResult result)	Performs checks on finished dependency collection.
default RepositorySystemSession	prepare(RepositorySystemSession session, CollectRequest request)	Prepares for dependency collection.

Field Details

NOOP

static final DependencyCollectionChecker NOOP

A default "no op" implementation.

COLLECTOR_CHECKER_SUPPRESSED

static final String COLLECTOR_CHECKER_SUPPRESSED

Config property for collector checker suppression. Presence of this key will suppress collection checking. This key is not meant for users, but to programmatically signal collection suppression.

See Also:

• Constant Field Values

Method Details

prepare

default RepositorySystemSession prepare(RepositorySystemSession session,
 CollectRequest request)

Prepares for dependency collection.

Parameters:

session - The repository system session, must not be null.

request - The collect request about to be processed, must not be null.

Returns:

The session to use for the collection, possibly adapted by this checker.

isSatisfactory

default boolean isSatisfactory(RepositorySystemSession session,
 CollectRequest request,
 CollectResult result)
                        throws DependencyCollectionException

Performs checks on finished dependency collection. It should return true if the collection was deemed "satisfactory". If should return false only, if collection was not satisfactory, and checker was able to modify resolution parameters (to not repeat same work). In other cases (not satisfactory but no param change would help) it should throw DependencyCollectionException.

Parameters:

session - The repository system session, must not be null.

request - The collect request that was processed, must not be null.

result - The result of the dependency collection, must not be null.

Returns:

true if the collection result is satisfactory, false if the checker adjusted resolution parameters and collection should be repeated.

Throws:

DependencyCollectionException - If the collection is not satisfactory and cannot be remedied.