org.mule.runtime.extension.api.values

Interface ConfigurationParameterValueProvider

@NoImplement
public interface ConfigurationParameterValueProvider

This interface allows the exposure of the Set of values associated to a Configuration's or Connection Provider's parameter.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
default List<org.mule.runtime.api.meta.model.parameter.ValueProviderModel>	getConfigModels(String providerName) Deprecated.
Set<org.mule.runtime.api.value.Value>	getConfigValues(String parameterName) Resolves the possible values for the Configuration's parameter identified by the parameterName
Set<org.mule.runtime.api.value.Value>	getConfigValues(String parameterName, String targetSelector) Gets the values for the Configuration's parameter of the given parameterName, using the given targetSelector.
default List<org.mule.runtime.api.meta.model.parameter.ValueProviderModel>	getConnectionModels(String providerName) Deprecated.
Set<org.mule.runtime.api.value.Value>	getConnectionValues(String parameterName) Resolves the possible values for the Connection Providers's parameter identified by the parameterName
Set<org.mule.runtime.api.value.Value>	getConnectionValues(String parameterName, String targetSelector) Gets the values for the Connection Provider's parameter of the given parameterName, using the given targetSelector.

Method Detail

getConfigValues

Set<org.mule.runtime.api.value.Value> getConfigValues(String parameterName)
                                               throws ValueResolvingException

Resolves the possible values for the Configuration's parameter identified by the parameterName

Parameters:

parameterName - the name of the parameter that has the capability to provide values

Returns:

Set of possible and valid values

Throws:

ValueResolvingException

getConfigValues

Set<org.mule.runtime.api.value.Value> getConfigValues(String parameterName,
                                                      String targetSelector)
                                               throws ValueResolvingException

Gets the values for the Configuration's parameter of the given parameterName, using the given targetSelector. See FieldValues.targetSelectors()

Parameters:

parameterName - the name of the parameter for which its values will be resolved

targetSelector - the target selector to use to resolve the values

Returns:

Set of possible and valid values

Throws:

ValueResolvingException

getConfigModels

@Deprecated
default List<org.mule.runtime.api.meta.model.parameter.ValueProviderModel> getConfigModels(String providerName)
                                                                                                throws ValueResolvingException

Deprecated.

Retrieves the list of associated ValueProviderModel with the given provider name in the configuration

Parameters:

providerName - The name of the value provider

Returns:

The associated ValueProviderModel

Throws:

ValueResolvingException

getConnectionValues

Set<org.mule.runtime.api.value.Value> getConnectionValues(String parameterName)
                                                   throws ValueResolvingException

Resolves the possible values for the Connection Providers's parameter identified by the parameterName

Parameters:

parameterName - the name of the parameter that has the capability to provide values

Returns:

Set of possible and valid values

Throws:

ValueResolvingException

getConnectionValues

Set<org.mule.runtime.api.value.Value> getConnectionValues(String parameterName,
                                                          String targetSelector)
                                                   throws ValueResolvingException

Gets the values for the Connection Provider's parameter of the given parameterName, using the given targetSelector. See FieldValues.targetSelectors()

Parameters:

parameterName - the name of the parameter for which its values will be resolved

targetSelector - the target selector to use to resolve the values

Returns:

Set of possible and valid values

Throws:

ValueResolvingException

getConnectionModels

@Deprecated
default List<org.mule.runtime.api.meta.model.parameter.ValueProviderModel> getConnectionModels(String providerName)
                                                                                                    throws ValueResolvingException

Deprecated.

Retrieves the list of associated ValueProviderModel with the given provider name in the connection

Parameters:

providerName - The name of the value provider

Returns:

The associated ValueProviderModel

Throws:

ValueResolvingException