org.mule.runtime.module.artifact.activation.api.extension.discovery

Interface ExtensionDiscoveryRequest

All Known Implementing Classes:

DefaultExtensionDiscoveryRequest

@NoImplement
public interface ExtensionDiscoveryRequest

Container of the parameters that can be given to ExtensionModelDiscoverer.discoverPluginsExtensionModels(ExtensionDiscoveryRequest).

Since:

4.5

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExtensionDiscoveryRequest.ExtensionDiscoveryRequestBuilder

Method Summary

Modifier and Type	Method and Description
static ExtensionDiscoveryRequest.ExtensionDiscoveryRequestBuilder	builder()
Collection<ArtifactPluginDescriptor>	getArtifactPluginDescriptors()
<T> Optional<T>	getParameter(String key) Obtains the custom parameter registered under key.
Map<String,Object>	getParameters() Returns all the parameters for this discovery request.
Set<org.mule.runtime.api.meta.model.ExtensionModel>	getParentArtifactExtensions()
boolean	isEnrichDescriptions()
boolean	isOCSEnabled()
boolean	isParallelDiscovery() Parallel discovery will try to parallelize only the discovery for extensions that do not depend on the DSL of other extensions.

Method Detail

builder

static ExtensionDiscoveryRequest.ExtensionDiscoveryRequestBuilder builder()

Returns:

a fluent builder for creating a new ExtensionDiscoveryRequest instance.

getParameter

<T> Optional<T> getParameter(String key)

Obtains the custom parameter registered under key.

Type Parameters:

T - generic type of the expected value.

Parameters:

key - the key under which the wanted value is registered.

Returns:

an Optional value.

getParameters

Map<String,Object> getParameters()

Returns all the parameters for this discovery request.

Returns:

parameters for this discovery request.

getArtifactPluginDescriptors

Collection<ArtifactPluginDescriptor> getArtifactPluginDescriptors()

Returns:

ArtifactPluginDescriptors for artifact plugins deployed inside the artifact. Non-null.

getParentArtifactExtensions

Set<org.mule.runtime.api.meta.model.ExtensionModel> getParentArtifactExtensions()

Returns:

Set of ExtensionModel to also take into account when parsing extensions.

isParallelDiscovery

boolean isParallelDiscovery()

Parallel discovery will try to parallelize only the discovery for extensions that do not depend on the DSL of other extensions.

Parallelism is achieved using the fork-join pool.

Returns:

true if the extension model discovery process will attempt to discover an extension model from the classloaders in parallel instead of sequentially.

isEnrichDescriptions

boolean isEnrichDescriptions()

Returns:

true if any DeclarationEnricher that adds descriptions to an ExtensionDeclaration must be executed, false if it must be skipped.

isOCSEnabled

boolean isOCSEnabled()

Returns:

whether OCS is enabled.