org.mule.tooling.client.api

Interface ToolingRuntimeClient.Builder

Enclosing interface:

ToolingRuntimeClient

public static interface ToolingRuntimeClient.Builder

Method Summary

Modifier and Type	Method and Description
ToolingRuntimeClient	build() Builds the ToolingRuntimeClient.
Feature<Action<CacheStorageFactory>>	withCacheStorageFactoryForMetadata() If supported by the ToolingRuntimeClient implementation, it will return a Feature to set the CacheStorageFactory used to create a CacheStorage implemented by the user in the Metadata cache.
Feature<Action<CacheStorageFactory>>	withCacheStorageFactoryForValueProviders() If supported by the ToolingRuntimeClient implementation, it will return a Feature to set the CacheStorageFactory used to create a CacheStorage implemented by the user in the Value Provider cache.
ToolingRuntimeClient.Builder	withMavenConfiguration(org.mule.maven.client.api.model.MavenConfiguration mavenConfiguration) Sets the MavenConfiguration used by the client to access the Maven artifacts.
ToolingRuntimeClient.Builder	withMetadataCacheFactory(MetadataCacheFactory metadataCacheFactory) Deprecated. Use withMetadataCacheStorageFactory() instead
Feature<Action<MetadataCacheStorageFactory>>	withMetadataCacheStorageFactory() Deprecated. Use withCacheStorageFactoryForMetadata()
ToolingRuntimeClient.Builder	withRemoteAgentConfiguration(AgentConfiguration agentConfiguration) Sets the AgentConfiguration used by the client to access the Tooling REST API.
Feature<Action<String>>	withTargetRuntimeVersion() If supported by the ToolingRuntimeClient implementation it will return a Consumer > to set the target version of Mule Runtime that defines the language version, model and DSL.

Method Detail

withRemoteAgentConfiguration

ToolingRuntimeClient.Builder withRemoteAgentConfiguration(AgentConfiguration agentConfiguration)

Sets the AgentConfiguration used by the client to access the Tooling REST API. If the operations executed by the client don't require to access Tooling REST API this won't need to be set. Otherwise an operation could throw a MissingToolingConfigurationException in case if there was no configuration set for the client instance.

Parameters:

agentConfiguration - AgentConfiguration for the client.

Returns:

this

withMavenConfiguration

ToolingRuntimeClient.Builder withMavenConfiguration(org.mule.maven.client.api.model.MavenConfiguration mavenConfiguration)

Sets the MavenConfiguration used by the client to access the Maven artifacts. If not provided, then the bootstrap Maven configuration will be used.

Parameters:

mavenConfiguration - MavenConfiguration for the client.

Returns:

this

withTargetRuntimeVersion

Feature<Action<String>> withTargetRuntimeVersion()

If supported by the ToolingRuntimeClient implementation it will return a Consumer > to set the target version of Mule Runtime that defines the language version, model and DSL. If not set or the feature is disable there will be no filtering and adapting phases for language version, model and DSL.

Returns:

Feature to execute an Action that receives as parameter the targetRuntimeVersion as String.

withMetadataCacheFactory

@Deprecated
ToolingRuntimeClient.Builder withMetadataCacheFactory(MetadataCacheFactory metadataCacheFactory)

Deprecated. Use withMetadataCacheStorageFactory() instead

Sets the MetadataCacheFactory used by the client to create MetadataCache. If not provided, metadata resolution will be always fetched from Mule Runtime when resolving data sense.

Parameters:

metadataCacheFactory - MetadataCacheFactory factory for MetadataCache.

Returns:

this.

withMetadataCacheStorageFactory

@Deprecated
Feature<Action<MetadataCacheStorageFactory>> withMetadataCacheStorageFactory()

Deprecated. Use withCacheStorageFactoryForMetadata()

If supported by the ToolingRuntimeClient implementation, it will return a Feature to set the MetadataCacheStorageFactory used to create a MetadataCacheStorage implemented by the user in the Metadata cache. If not provided, metadata resolution will be always fetched from Mule Runtime when resolving data sense.

Returns:

a Feature> to configure a MetadataCacheStorageFactory

withCacheStorageFactoryForMetadata

Feature<Action<CacheStorageFactory>> withCacheStorageFactoryForMetadata()

If supported by the ToolingRuntimeClient implementation, it will return a Feature to set the CacheStorageFactory used to create a CacheStorage implemented by the user in the Metadata cache. If not provided, metadata resolution will be always fetched from Mule Runtime when resolving data sense.

Returns:

a Feature> to configure a CacheStorage

withCacheStorageFactoryForValueProviders

Feature<Action<CacheStorageFactory>> withCacheStorageFactoryForValueProviders()

If supported by the ToolingRuntimeClient implementation, it will return a Feature to set the CacheStorageFactory used to create a CacheStorage implemented by the user in the Value Provider cache. If not provided, value provider resolution resolution will be always fetched from Mule Runtime.

Returns:

a Feature> to configure a CacheStorage

build

ToolingRuntimeClient build()

Builds the ToolingRuntimeClient.

Returns:

a new instance of the ToolingRuntimeClient.