Module org.mule.sdk.api

Package org.mule.sdk.api.metadata.resolving

Interface PartialTypeKeysResolver<T>

All Superinterfaces:

org.mule.runtime.api.metadata.resolving.NamedTypeResolver, TypeKeysResolver

@MinMuleVersion("4.5.0")
public interface PartialTypeKeysResolver<T>
extends TypeKeysResolver

A TypeKeysResolver that can handle the resolution of multi-level MetadataKey in a lazy way. On each invocation, this resolver will perform the resolution of one more level of the MetadataKey tree, based on the configuration of the previous levels.

Method Summary

Modifier and Type	Method	Description
org.mule.runtime.api.metadata.MetadataKey	resolveChilds(MetadataContext context, T partial)	Further resolves the of types that can be described based on a partial configuration of the Type descriptor, representing them as a multi level MetadataKey.

Methods inherited from interface org.mule.runtime.api.metadata.resolving.NamedTypeResolver

getCategoryName

Methods inherited from interface org.mule.sdk.api.metadata.resolving.TypeKeysResolver

getKeys, getResolverName

Method Details

resolveChilds

org.mule.runtime.api.metadata.MetadataKey resolveChilds(MetadataContext context,
 T partial)
                                                 throws org.mule.runtime.api.metadata.MetadataResolvingException,
org.mule.runtime.api.connection.ConnectionException

Further resolves the of types that can be described based on a partial configuration of the Type descriptor, representing them as a multi level MetadataKey. For example, if we have a location key composed by:

 
  Location: {
    continent,
    country,
    city
  }
 
 

Were the Continent is required to resolve the Country, and the Country is required to resolve the City, this resolveChilds(org.mule.sdk.api.metadata.MetadataContext, T) method will be invoked with the Location configuration available so far. In this case, possible values for the partial parameter of this method are Location: { continent } and Location: { continent, country }

Parameters:

context - MetadataContext of the Metadata resolution

partial - the current, partial representation of the type key.

Returns:

A multi level MetadataKey of representing the available types

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException - if an error occurs during the MetadataKey building. See FailureCode for possible MetadataResolvingException reasons

org.mule.runtime.api.connection.ConnectionException - if an error occurs when using the connection provided by the MetadataContext