org.mule.runtime.extension.api.model.source

Class ImmutableSourceModel

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

org.mule.runtime.extension.api.model.source.ImmutableSourceModel

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.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.source.SourceModel, org.mule.runtime.api.meta.model.stereotype.HasStereotypeModel, org.mule.runtime.api.meta.NamedObject

public class ImmutableSourceModel
extends AbstractExecutableComponentModel
implements org.mule.runtime.api.meta.model.source.SourceModel

Immutable implementation of SourceModel

Since:

1.0

Field Summary

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

description, modelProperties

Constructor Summary

Constructors

Constructor and Description
ImmutableSourceModel(String name, String description, boolean hasResponse, boolean runsOnPrimaryNodeOnly, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents, org.mule.runtime.api.meta.model.OutputModel output, org.mule.runtime.api.meta.model.OutputModel outputAttributes, Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> successCallbackModel, Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> errorCallbackModel, Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> terminateCallbackModel, boolean requiresConnection, boolean transactional, boolean supportsStreaming, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications) Creates a new instance
ImmutableSourceModel(String name, String description, boolean hasResponse, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels, List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents, org.mule.runtime.api.meta.model.OutputModel output, org.mule.runtime.api.meta.model.OutputModel outputAttributes, Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> successCallbackModel, Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> errorCallbackModel, Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> terminateCallbackModel, boolean requiresConnection, boolean transactional, boolean supportsStreaming, org.mule.runtime.api.meta.model.display.DisplayModel displayModel, org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype, Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties) Deprecated. This constructor is deprecated and will be removed in Mule 5. Use ImmutableSourceModel(String, String, boolean, boolean, List, List, OutputModel, OutputModel, Optional, Optional, Optional, boolean, boolean, boolean, DisplayModel, StereotypeModel, Set, Set, Set) instead

Method Summary

Modifier and Type	Method and Description
Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel>	getErrorCallback()
Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel>	getSuccessCallback()
Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel>	getTerminateCallback()
boolean	hasResponse()
boolean	runsOnPrimaryNodeOnly()

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

getNotificationModels, getOutput, getOutputAttributes, isTransactional, requiresConnection, supportsStreaming

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

getErrorModels, getNestedComponents

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

getStereotype

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.source.SourceModel

accept, getAllParameterModels

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

isTransactional, requiresConnection, supportsStreaming

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

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.HasOutputModel

getOutput, getOutputAttributes

Methods inherited from interface org.mule.runtime.api.meta.model.notification.HasNotifications

getNotificationModels

Constructor Detail

ImmutableSourceModel

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

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

Creates a new instance

Parameters:

name - the source name. Cannot be blank

description - the source description

hasResponse - Whether the source emits a response

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

nestedComponents - a List with the components contained by this model

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

outputAttributes - an OutputModel which represents the attributes on the output me

successCallbackModel - an optional model for the source success callback

errorCallbackModel - an optional model for the source error callback

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 source is displayed in the UI

stereotype - the stereotype of this component

modelProperties - A Set of custom properties which extend this model

ImmutableSourceModel

public ImmutableSourceModel(String name,
                            String description,
                            boolean hasResponse,
                            boolean runsOnPrimaryNodeOnly,
                            List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> parameterGroupModels,
                            List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents,
                            org.mule.runtime.api.meta.model.OutputModel output,
                            org.mule.runtime.api.meta.model.OutputModel outputAttributes,
                            Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> successCallbackModel,
                            Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> errorCallbackModel,
                            Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> terminateCallbackModel,
                            boolean requiresConnection,
                            boolean transactional,
                            boolean supportsStreaming,
                            org.mule.runtime.api.meta.model.display.DisplayModel displayModel,
                            org.mule.runtime.api.meta.model.stereotype.StereotypeModel stereotype,
                            Set<org.mule.runtime.api.meta.model.error.ErrorModel> errors,
                            Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
                            Set<org.mule.runtime.api.meta.model.notification.NotificationModel> notifications)

Creates a new instance

Parameters:

name - the source name. Cannot be blank

description - the source description

hasResponse - Whether the source emits a response

runsOnPrimaryNodeOnly - Whether the source should only run on the primary node or all nodes

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

nestedComponents - a List with the components contained by this model

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

outputAttributes - an OutputModel which represents the attributes on the output me

successCallbackModel - an optional model for the source success callback

errorCallbackModel - an optional model for the source error callback

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 source is displayed in the UI

stereotype - the stereotype of this component

modelProperties - A Set of custom properties which extend this model

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

Method Detail

hasResponse

public boolean hasResponse()

Specified by:

hasResponse in interface org.mule.runtime.api.meta.model.source.SourceModel

getSuccessCallback

public Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> getSuccessCallback()

Specified by:

getSuccessCallback in interface org.mule.runtime.api.meta.model.source.SourceModel

getErrorCallback

public Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> getErrorCallback()

Specified by:

getErrorCallback in interface org.mule.runtime.api.meta.model.source.SourceModel

getTerminateCallback

public Optional<org.mule.runtime.api.meta.model.source.SourceCallbackModel> getTerminateCallback()

Specified by:

getTerminateCallback in interface org.mule.runtime.api.meta.model.source.SourceModel

runsOnPrimaryNodeOnly

public boolean runsOnPrimaryNodeOnly()

Specified by:

runsOnPrimaryNodeOnly in interface org.mule.runtime.api.meta.model.source.SourceModel