org.mule.runtime.extension.api.model

Class AbstractExecutableComponentModel

java.lang.Object

org.mule.runtime.extension.api.model.AbstractImmutableModel

org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

org.mule.runtime.extension.api.model.parameter.AbstractParameterizedModel

org.mule.runtime.extension.api.model.parameter.AbstractStereotypedModel

org.mule.runtime.extension.api.model.AbstractComponentModel

org.mule.runtime.extension.api.model.AbstractExecutableComponentModel

All Implemented Interfaces:

org.mule.runtime.api.meta.DescribedObject, org.mule.runtime.api.meta.model.ComponentModel, org.mule.runtime.api.meta.model.ComposableModel, org.mule.runtime.api.meta.model.ConnectableComponentModel, org.mule.runtime.api.meta.model.declaration.fluent.HasSemanticTerms, org.mule.runtime.api.meta.model.deprecated.DeprecableModel, org.mule.runtime.api.meta.model.display.HasDisplayModel, org.mule.runtime.api.meta.model.EnrichableModel, org.mule.runtime.api.meta.model.error.ThrowsErrors, org.mule.runtime.api.meta.model.HasOutputModel, org.mule.runtime.api.meta.model.notification.HasNotifications, org.mule.runtime.api.meta.model.parameter.ParameterizedModel, org.mule.runtime.api.meta.model.stereotype.HasStereotypeModel, org.mule.runtime.api.meta.NamedObject

Direct Known Subclasses:

ImmutableOperationModel, ImmutableSourceModel

public abstract class AbstractExecutableComponentModel
extends AbstractComponentModel
implements org.mule.runtime.api.meta.model.ConnectableComponentModel, org.mule.runtime.api.meta.model.notification.HasNotifications

Base class for immutable implementations of a ComponentModel

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

description, modelProperties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExecutableComponentModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, org.mule.runtime.api.meta.model.OutputModel output, org.mule.runtime.api.meta.model.OutputModel outputAttributes, boolean requiresConnection, boolean transactional, boolean supportsStreaming, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents) Deprecated. This constructor is deprecated and will be removed in Mule 5. Use AbstractExecutableComponentModel(String, String, List, OutputModel, OutputModel, boolean, boolean, boolean, DisplayModel, Set, StereotypeModel, Set, List, Set) instead
protected	AbstractExecutableComponentModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, org.mule.runtime.api.meta.model.OutputModel output, org.mule.runtime.api.meta.model.OutputModel outputAttributes, boolean requiresConnection, boolean transactional, boolean supportsStreaming, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents, Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications) Creates a new instance
protected	AbstractExecutableComponentModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, org.mule.runtime.api.meta.model.OutputModel output, org.mule.runtime.api.meta.model.OutputModel outputAttributes, boolean requiresConnection, boolean transactional, boolean supportsStreaming, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents, Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel) Creates a new instance
protected	AbstractExecutableComponentModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, org.mule.runtime.api.meta.model.OutputModel output, org.mule.runtime.api.meta.model.OutputModel outputAttributes, boolean requiresConnection, boolean transactional, boolean supportsStreaming, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents, Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel, org.mule.runtime.api.meta.model.data.sample.SampleDataProviderModel sampleDataProviderModel) Creates a new instance
protected	AbstractExecutableComponentModel(String name, String description, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, org.mule.runtime.api.meta.model.OutputModel output, org.mule.runtime.api.meta.model.OutputModel outputAttributes, boolean requiresConnection, boolean transactional, boolean supportsStreaming, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents, Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications, org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel, org.mule.runtime.api.meta.model.data.sample.SampleDataProviderModel sampleDataProviderModel, Set<String> semanticTerms) Creates a new instance

Method Summary

Modifier and Type	Method and Description
Set<org.mule.runtime.api.meta.model.notification.NotificationModel>	getNotificationModels()
org.mule.runtime.api.meta.model.OutputModel	getOutput()
org.mule.runtime.api.meta.model.OutputModel	getOutputAttributes()
Optional<org.mule.runtime.api.meta.model.data.sample.SampleDataProviderModel>	getSampleDataProviderModel()
boolean	isTransactional()
boolean	requiresConnection()
boolean	supportsStreaming()

Methods inherited from class org.mule.runtime.extension.api.model.AbstractComponentModel

getErrorModels, getNestedComponents, getSemanticTerms

Methods inherited from class org.mule.runtime.extension.api.model.parameter.AbstractStereotypedModel

getDeprecationModel, getStereotype, isDeprecated

Methods inherited from class org.mule.runtime.extension.api.model.parameter.AbstractParameterizedModel

getParameterGroupModels

Methods inherited from class org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

checkArgument, equals, getDisplayModel, getName, hashCode, toString

Methods inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

copy, copy, getDescription, getModelProperties, getModelProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mule.runtime.api.meta.model.ComponentModel

accept

Methods inherited from interface org.mule.runtime.api.meta.model.parameter.ParameterizedModel

getAllParameterModels, getParameterGroupModels

Methods inherited from interface org.mule.runtime.api.meta.DescribedObject

getDescription

Methods inherited from interface org.mule.runtime.api.meta.model.ComposableModel

getNestedComponents

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Methods inherited from interface org.mule.runtime.api.meta.model.stereotype.HasStereotypeModel

getStereotype

Methods inherited from interface org.mule.runtime.api.meta.model.EnrichableModel

getModelProperties, getModelProperty

Methods inherited from interface org.mule.runtime.api.meta.model.display.HasDisplayModel

getDisplayModel

Methods inherited from interface org.mule.runtime.api.meta.model.error.ThrowsErrors

getErrorModels

Methods inherited from interface org.mule.runtime.api.meta.model.deprecated.DeprecableModel

getDeprecationModel, isDeprecated

Methods inherited from interface org.mule.runtime.api.meta.model.declaration.fluent.HasSemanticTerms

getSemanticTerms

Constructor Detail

AbstractExecutableComponentModel

@Deprecated
protected AbstractExecutableComponentModel(String name,
                                                       String description,
                                                       List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
                                                       org.mule.runtime.api.meta.model.OutputModel output,
                                                       org.mule.runtime.api.meta.model.OutputModel outputAttributes,
                                                       boolean requiresConnection,
                                                       boolean transactional,
                                                       boolean supportsStreaming,
                                                       org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                                                       Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
                                                       org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype,
                                                       Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
                                                       List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents)

Deprecated. This constructor is deprecated and will be removed in Mule 5. Use AbstractExecutableComponentModel(String, String, List, OutputModel, OutputModel, boolean, boolean, boolean, DisplayModel, Set, StereotypeModel, Set, List, Set) instead

Creates a new instance

Parameters:

name - the model's name

description - the model's description

parameterGroupModels - a List with the source's parameter group models

output - an OutputModel which represents the component's output content

outputAttributes - an OutputModel which represents the component's attributes on the output Message

requiresConnection - whether this component requires connectivity

transactional - whether this component supports transactions

supportsStreaming - whether this component supports streaming

displayModel - a model which contains directive about how this component is displayed in the UI

stereotype - the stereotype of this component

modelProperties - A Set of custom properties which extend this model

nestedComponents - a List with the components contained by this model

Throws:

IllegalArgumentException - if name is blank

AbstractExecutableComponentModel

protected AbstractExecutableComponentModel(String name,
                                           String description,
                                           List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
                                           org.mule.runtime.api.meta.model.OutputModel output,
                                           org.mule.runtime.api.meta.model.OutputModel outputAttributes,
                                           boolean requiresConnection,
                                           boolean transactional,
                                           boolean supportsStreaming,
                                           org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                                           Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
                                           org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype,
                                           Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
                                           List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents,
                                           Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications)

Creates a new instance

Parameters:

name - the model's name

description - the model's description

parameterGroupModels - a List with the source's parameter group models

output - an OutputModel which represents the component's output content

outputAttributes - an OutputModel which represents the component's attributes on the output Message

requiresConnection - whether this component requires connectivity

transactional - whether this component supports transactions

supportsStreaming - whether this component supports streaming

displayModel - a model which contains directive about how this component is displayed in the UI

stereotype - the stereotype of this component

modelProperties - A Set of custom properties which extend this model

nestedComponents - a List with the components contained by this model

notifications - A Set of NotificationModel which describes the component's notifications

Throws:

IllegalArgumentException - if name is blank

AbstractExecutableComponentModel

protected AbstractExecutableComponentModel(String name,
                                           String description,
                                           List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
                                           org.mule.runtime.api.meta.model.OutputModel output,
                                           org.mule.runtime.api.meta.model.OutputModel outputAttributes,
                                           boolean requiresConnection,
                                           boolean transactional,
                                           boolean supportsStreaming,
                                           org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                                           Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
                                           org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype,
                                           Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
                                           List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents,
                                           Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications,
                                           org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel)

Creates a new instance

Parameters:

name - the model's name

description - the model's description

parameterGroupModels - a List with the source's parameter group models

output - an OutputModel which represents the component's output content

outputAttributes - an OutputModel which represents the component's attributes on the output Message

requiresConnection - whether this component requires connectivity

transactional - whether this component supports transactions

supportsStreaming - whether this component supports streaming

displayModel - a model which contains directive about how this component is displayed in the UI

stereotype - the stereotype of this component

modelProperties - A Set of custom properties which extend this model

nestedComponents - a List with the components contained by this model

notifications - A Set of NotificationModel which describes the component's notifications

deprecationModel - a DeprecationModel describing if the component is deprecated. A null value means it is not deprecated.

Throws:

IllegalArgumentException - if name is blank

AbstractExecutableComponentModel

protected AbstractExecutableComponentModel(String name,
                                           String description,
                                           List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
                                           org.mule.runtime.api.meta.model.OutputModel output,
                                           org.mule.runtime.api.meta.model.OutputModel outputAttributes,
                                           boolean requiresConnection,
                                           boolean transactional,
                                           boolean supportsStreaming,
                                           org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                                           Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
                                           org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype,
                                           Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
                                           List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents,
                                           Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications,
                                           org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel,
                                           org.mule.runtime.api.meta.model.data.sample.SampleDataProviderModel sampleDataProviderModel)

Creates a new instance

Parameters:

name - the model's name

description - the model's description

parameterGroupModels - a List with the source's parameter group models

output - an OutputModel which represents the component's output content

outputAttributes - an OutputModel which represents the component's attributes on the output Message

requiresConnection - whether this component requires connectivity

transactional - whether this component supports transactions

supportsStreaming - whether this component supports streaming

displayModel - a model which contains directive about how this component is displayed in the UI

stereotype - the stereotype of this component

modelProperties - A Set of custom properties which extend this model

nestedComponents - a List with the components contained by this model

notifications - A Set of NotificationModel which describes the component's notifications

deprecationModel - a DeprecationModel describing if the component is deprecated. A null value means it is not deprecated.

sampleDataProviderModel - A nullable SampleDataProviderModel which describes the component's sample data capabilities

Throws:

IllegalArgumentException - if name is blank

Since:

1.4.0

AbstractExecutableComponentModel

protected AbstractExecutableComponentModel(String name,
                                           String description,
                                           List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
                                           org.mule.runtime.api.meta.model.OutputModel output,
                                           org.mule.runtime.api.meta.model.OutputModel outputAttributes,
                                           boolean requiresConnection,
                                           boolean transactional,
                                           boolean supportsStreaming,
                                           org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                                           Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
                                           org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype,
                                           Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
                                           List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents,
                                           Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications,
                                           org.mule.runtime.api.meta.model.deprecated.DeprecationModel deprecationModel,
                                           org.mule.runtime.api.meta.model.data.sample.SampleDataProviderModel sampleDataProviderModel,
                                           Set<String> semanticTerms)

Creates a new instance

Parameters:

name - the model's name

description - the model's description

parameterGroupModels - a List with the source's parameter group models

output - an OutputModel which represents the component's output content

outputAttributes - an OutputModel which represents the component's attributes on the output Message

requiresConnection - whether this component requires connectivity

transactional - whether this component supports transactions

supportsStreaming - whether this component supports streaming

displayModel - a model which contains directive about how this component is displayed in the UI

stereotype - the stereotype of this component

modelProperties - A Set of custom properties which extend this model

nestedComponents - a List with the components contained by this model

notifications - A Set of NotificationModel which describes the component's notifications

deprecationModel - a DeprecationModel describing if the component is deprecated. A null value means it is not deprecated.

sampleDataProviderModel - A nullable SampleDataProviderModel which describes the component's sample data capabilities

semanticTerms - a Set of semantic terms which describe the component's meaning and effect

Throws:

IllegalArgumentException - if name is blank

Since:

1.4.0

Method Detail

getOutput

public org.mule.runtime.api.meta.model.OutputModel getOutput()

Specified by:

getOutput in interface org.mule.runtime.api.meta.model.HasOutputModel

getOutputAttributes

public org.mule.runtime.api.meta.model.OutputModel getOutputAttributes()

Specified by:

getOutputAttributes in interface org.mule.runtime.api.meta.model.HasOutputModel

isTransactional

public boolean isTransactional()

Specified by:

isTransactional in interface org.mule.runtime.api.meta.model.ConnectableComponentModel

requiresConnection

public boolean requiresConnection()

Specified by:

requiresConnection in interface org.mule.runtime.api.meta.model.ConnectableComponentModel

supportsStreaming

public boolean supportsStreaming()

Specified by:

supportsStreaming in interface org.mule.runtime.api.meta.model.ConnectableComponentModel

getNotificationModels

public Set<org.mule.runtime.api.meta.model.notification.NotificationModel> getNotificationModels()

Specified by:

getNotificationModels in interface org.mule.runtime.api.meta.model.notification.HasNotifications

getSampleDataProviderModel

public Optional<org.mule.runtime.api.meta.model.data.sample.SampleDataProviderModel> getSampleDataProviderModel()

Specified by:

getSampleDataProviderModel in interface org.mule.runtime.api.meta.model.HasOutputModel