org.mule.runtime.module.extension.internal.loader.parser

Interface ConnectionProviderModelParser

All Superinterfaces:

SemanticTermsParser, StereotypeModelParser

All Known Implementing Classes:

JavaConnectionProviderModelParser

public interface ConnectionProviderModelParser
extends SemanticTermsParser, StereotypeModelParser

Parses the syntactic definition of a ConnectionProviderModel so that the semantics reflected in it can be extracted in a uniform way, regardless of the actual syntax used by the extension developer.

Since:

4.5.0

See Also:

ExtensionModelParser

Method Summary

Modifier and Type	Method and Description
List<org.mule.runtime.api.meta.model.ModelProperty>	getAdditionalModelProperties() Returns a list with all the model properties to be applied at the connection provider level which are specifically linked to the type of syntax used to define the extension.
org.mule.runtime.api.meta.model.connection.ConnectionManagementType	getConnectionManagementType()
Optional<ConnectionProviderFactoryModelProperty>	getConnectionProviderFactoryModelProperty()
Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel>	getDeprecationModel()
String	getDescription()
Optional<org.mule.runtime.api.meta.model.display.DisplayModel>	getDisplayModel()
List<org.mule.runtime.api.meta.model.ExternalLibraryModel>	getExternalLibraryModels()
String	getName()
Optional<org.mule.runtime.extension.api.connectivity.oauth.OAuthModelProperty>	getOAuthModelProperty()
List<ParameterGroupModelParser>	getParameterGroupModelParsers() Returns a list with a ParameterGroupModelParser per each parameter group defined in the provider.
Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty>	getSinceMuleVersionModelProperty()
boolean	isExcludedFromConnectivitySchema()
boolean	supportsConnectivityTesting()

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.SemanticTermsParser

getSemanticTerms

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.StereotypeModelParser

getStereotype

Method Detail

getName

String getName()

Returns:

the provider's name

getDescription

String getDescription()

Returns:

the provider's description

getParameterGroupModelParsers

List<ParameterGroupModelParser> getParameterGroupModelParsers()

Returns a list with a ParameterGroupModelParser per each parameter group defined in the provider. Each group is listed in the same order as defined in the syntax.

Returns:

a list with the config's ParameterGroupModelParser

getExternalLibraryModels

List<org.mule.runtime.api.meta.model.ExternalLibraryModel> getExternalLibraryModels()

Returns:

a list with an ExternalLibraryModel per each external library defined at the configuration level.

getConnectionManagementType

org.mule.runtime.api.meta.model.connection.ConnectionManagementType getConnectionManagementType()

Returns:

the ConnectionManagementType used by this provider

getConnectionProviderFactoryModelProperty

Optional<ConnectionProviderFactoryModelProperty> getConnectionProviderFactoryModelProperty()

Returns:

the ConnectionProviderFactoryModelProperty used to create instances of this provider

supportsConnectivityTesting

boolean supportsConnectivityTesting()

Returns:

whether this provider supports connectivity testing or not.

isExcludedFromConnectivitySchema

boolean isExcludedFromConnectivitySchema()

Returns:

whether this provider should be skipped when generating the extension's connectivity schemas

getOAuthModelProperty

Optional<org.mule.runtime.extension.api.connectivity.oauth.OAuthModelProperty> getOAuthModelProperty()

Returns:

if the provider supports OAuth, returns an OAuthModelProperty which describes its grant types

getAdditionalModelProperties

List<org.mule.runtime.api.meta.model.ModelProperty> getAdditionalModelProperties()

Returns a list with all the model properties to be applied at the connection provider level which are specifically linked to the type of syntax used to define the extension.

Returns:

a list with ModelProperty instances.

getDeprecationModel

Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel> getDeprecationModel()

Returns:

the connection provider's DeprecationModel if one was defined

getDisplayModel

Optional<org.mule.runtime.api.meta.model.display.DisplayModel> getDisplayModel()

Returns:

the connection provider's DisplayModel

getSinceMuleVersionModelProperty

Optional<org.mule.runtime.extension.api.property.SinceMuleVersionModelProperty> getSinceMuleVersionModelProperty()