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

Class DefaultExtensionDiscoveryRequest

java.lang.Object

org.mule.runtime.module.artifact.activation.internal.extension.discovery.DefaultExtensionDiscoveryRequest

All Implemented Interfaces:

ExtensionDiscoveryRequest

public class DefaultExtensionDiscoveryRequest
extends Object
implements ExtensionDiscoveryRequest

Default implementation of ExtensionDiscoveryRequest, which contains the parameters that can be given to ExtensionModelDiscoverer.discoverPluginsExtensionModels(ExtensionDiscoveryRequest)

Since:

4.5

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.module.artifact.activation.api.extension.discovery.ExtensionDiscoveryRequest

ExtensionDiscoveryRequest.ExtensionDiscoveryRequestBuilder

Constructor Summary

Constructors

Constructor and Description
DefaultExtensionDiscoveryRequest(Collection<ArtifactPluginDescriptor> artifactPlugins, Set<org.mule.runtime.api.meta.model.ExtensionModel> parentArtifactExtensions, boolean parallelDiscovery, boolean enrichDescriptions)
DefaultExtensionDiscoveryRequest(Collection<ArtifactPluginDescriptor> artifactPlugins, Set<org.mule.runtime.api.meta.model.ExtensionModel> parentArtifactExtensions, boolean parallelDiscovery, boolean enrichDescriptions, boolean ocsEnabled, Map<String,Object> customParameters)

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.module.artifact.activation.api.extension.discovery.ExtensionDiscoveryRequest

builder

Constructor Detail

DefaultExtensionDiscoveryRequest

public DefaultExtensionDiscoveryRequest(Collection<ArtifactPluginDescriptor> artifactPlugins,
                                        Set<org.mule.runtime.api.meta.model.ExtensionModel> parentArtifactExtensions,
                                        boolean parallelDiscovery,
                                        boolean enrichDescriptions)

DefaultExtensionDiscoveryRequest

public DefaultExtensionDiscoveryRequest(Collection<ArtifactPluginDescriptor> artifactPlugins,
                                        Set<org.mule.runtime.api.meta.model.ExtensionModel> parentArtifactExtensions,
                                        boolean parallelDiscovery,
                                        boolean enrichDescriptions,
                                        boolean ocsEnabled,
                                        Map<String,Object> customParameters)

Method Detail

getParameter

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

Description copied from interface: ExtensionDiscoveryRequest

Obtains the custom parameter registered under key.

Specified by:

getParameter in interface ExtensionDiscoveryRequest

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

public Map<String,Object> getParameters()

Description copied from interface: ExtensionDiscoveryRequest

Returns all the parameters for this discovery request.

Specified by:

getParameters in interface ExtensionDiscoveryRequest

Returns:

parameters for this discovery request.

getArtifactPluginDescriptors

public Collection<ArtifactPluginDescriptor> getArtifactPluginDescriptors()

Specified by:

getArtifactPluginDescriptors in interface ExtensionDiscoveryRequest

Returns:

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

getParentArtifactExtensions

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

Specified by:

getParentArtifactExtensions in interface ExtensionDiscoveryRequest

Returns:

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

isParallelDiscovery

public boolean isParallelDiscovery()

Description copied from interface: ExtensionDiscoveryRequest

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.

Specified by:

isParallelDiscovery in interface ExtensionDiscoveryRequest

Returns:

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

isEnrichDescriptions

public boolean isEnrichDescriptions()

Specified by:

isEnrichDescriptions in interface ExtensionDiscoveryRequest

Returns:

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

isOCSEnabled

public boolean isOCSEnabled()

Specified by:

isOCSEnabled in interface ExtensionDiscoveryRequest

Returns:

whether OCS is enabled.