org.mule.runtime.api.meta.model

Interface ComponentModel

All Superinterfaces:

DescribedObject, EnrichableModel, HasDisplayModel, NamedObject, ParameterizedModel, ThrowsErrors

All Known Subinterfaces:

OperationModel, RouterModel, ScopeModel, SourceModel

public interface ComponentModel
extends NamedObject, DescribedObject, EnrichableModel, ParameterizedModel, HasDisplayModel, ThrowsErrors

A definition of an component in a ExtensionModel. This model groups all the common contracts between extension components like OperationModel, SourceModel, etc.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	accept(ComponentModelVisitor visitor) Accepts a ComponentModelVisitor
OutputModel	getOutput() Returns a MetadataType for the value that this component sets on the output Message.getPayload() field.
OutputModel	getOutputAttributes() Returns a MetadataType for the value that this component sets on the output Message.getAttributes() field.
Set<Stereotype>	getStereotypes()
boolean	isTransactional()
boolean	requiresConnection()
boolean	supportsStreaming() Indicates if this component supports streaming.

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

getModelProperties, getModelProperty

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

getAllParameterModels, getParameterGroupModels

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

getName

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

getDescription

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

Method Detail

getOutput

OutputModel getOutput()

Returns a MetadataType for the value that this component sets on the output Message.getPayload() field.

Returns:

a MetadataType representing the content type for the output messages

getOutputAttributes

OutputModel getOutputAttributes()

Returns a MetadataType for the value that this component sets on the output Message.getAttributes() field.

Returns:

a MetadataType representing the attribute types for the output messages

isTransactional

boolean isTransactional()

Returns:

whether this component has the ability to execute while joining a transaction

requiresConnection

boolean requiresConnection()

Returns:

whether this component requires a connection in order to perform its task

supportsStreaming

boolean supportsStreaming()

Indicates if this component supports streaming.

Notice that supporting streaming doesn't necessarily mean that streaming will be performed each time the component is executed

Returns:

whether this component supports streaming or not

getStereotypes

Set<Stereotype> getStereotypes()

Returns:

The stereotypes which apply to this model

accept

void accept(ComponentModelVisitor visitor)

Accepts a ComponentModelVisitor

Parameters:

visitor - a ComponentModelVisitor