{ "name": "streaming", "description": "Basic Connector with Streamming", "version": "4.1.2", "vendor": "Mulesoft", "category": "COMMUNITY", "xmlDsl": { "prefix": "streaming", "namespace": "http://www.mulesoft.org/schema/mule/streaming", "schemaLocation": "http://www.mulesoft.org/schema/mule/streaming/current/mule-streaming.xsd", "schemaVersion": "4.1.2", "xsdFileName": "mule-streaming.xsd" }, "resources": [], "subTypes": [], "privilegedPackages": [], "privilegedArtifacts": [], "externalLibraries": [], "importedTypes": [ { "format": "java", "type": "Object", "annotations": { "typeId": "org.mule.runtime.api.store.ObjectStore", "extensibleType": {}, "typeAlias": { "value": "ObjectStore" }, "classInformation": { "classname": "org.mule.runtime.api.store.ObjectStore", "hasDefaultConstructor": false, "isInterface": true, "isInstantiable": false, "isAbstract": true, "isFinal": false, "implementedInterfaces": [], "parent": "", "genericTypes": [], "isMap": false } }, "fields": [] } ], "configurations": [ { "stereotype": { "type": "CONFIG", "namespace": "STREAMING", "parent": { "type": "MODULE_CONFIG", "namespace": "MULE" } }, "parameterGroupModels": [ { "parameters": [ { "type": { "format": "java", "type": "String" }, "hasDynamicType": false, "required": true, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "allowedStereotypeModels": [], "name": "configParameter", "description": "Config Parameter description", "modelProperties": {} }, { "type": { "format": "java", "type": "Object", "annotations": { "typeId": "org.mule.runtime.extension.api.runtime.ExpirationPolicy", "description": { "value": "Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit." }, "typeDsl": { "allowInlineDefinition": true, "allowTopLevelDefinition": false } }, "fields": [ { "key": { "name": "maxIdleTime" }, "model": { "type": "Number", "annotations": { "int": {}, "classInformation": { "classname": "java.lang.Long", "hasDefaultConstructor": false, "isInterface": false, "isInstantiable": false, "isAbstract": false, "isFinal": true, "implementedInterfaces": [ "java.lang.Comparable" ], "parent": "java.lang.Number", "genericTypes": [], "isMap": false }, "default": "5" } }, "annotations": { "description": { "value": "A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it\u0027s considered eligible for expiration" }, "expressionSupport": { "value": "NOT_SUPPORTED" } } }, { "key": { "name": "timeUnit" }, "model": { "type": "String", "annotations": { "enum": { "type": "[Ljava.lang.String;", "values": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] }, "default": "MINUTES" } }, "annotations": { "description": { "value": "A time unit that qualifies the maxIdleTime attribute" }, "expressionSupport": { "value": "NOT_SUPPORTED" } } } ] }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "NOT_SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": false, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 2, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "expirationPolicy", "description": "Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "expiration-policy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 4 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} } ], "externalLibraryModels": [], "operations": [ { "blocking": true, "executionType": "CPU_LITE", "output": { "type": { "format": { "id": "application/plain", "label": "application/plain", "validMimeTypes": [ "application/plain" ] }, "type": "Binary", "annotations": { "classInformation": { "classname": "java.io.InputStream", "hasDefaultConstructor": true, "isInterface": false, "isInstantiable": false, "isAbstract": true, "isFinal": false, "implementedInterfaces": [ "java.io.Closeable" ], "parent": "", "genericTypes": [], "isMap": false } } }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "outputAttributes": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": false, "supportsStreaming": true, "notifications": [], "nestedComponents": [], "errors": [], "stereotype": { "type": "PROCESSOR", "namespace": "MULE" }, "parameterGroupModels": [ { "parameters": [ { "type": { "format": "java", "type": "String" }, "hasDynamicType": false, "required": true, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "allowedStereotypeModels": [], "name": "param", "description": "String param description", "modelProperties": {} }, { "type": { "format": "java", "type": "String" }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 2, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "outputMimeType", "description": "The mime type of the payload that this operation outputs.", "modelProperties": {} }, { "type": { "format": "java", "type": "String" }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 3, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "outputEncoding", "description": "The encoding of the payload that this operation outputs.", "modelProperties": {} }, { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ByteStreamingStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "repeatable-in-memory-stream" }, "fields": [ { "key": { "name": "initialBufferSize" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "512" } }, "annotations": { "description": { "value": "This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize." } } }, { "key": { "name": "bufferSizeIncrement" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "512" } }, "annotations": { "description": { "value": "This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full." } } }, { "key": { "name": "maxBufferSize" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "1024" } }, "annotations": { "description": { "value": "This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit." } } }, { "key": { "name": "bufferUnit" }, "model": { "type": "String", "annotations": { "enum": { "type": "[Ljava.lang.String;", "values": [ "BYTE", "KB", "MB", "GB" ] }, "default": "KB" } }, "annotations": { "description": { "value": "The unit in which all these attributes are expressed" } } } ] }, { "type": "Object", "annotations": { "typeId": "repeatable-file-store-stream" }, "fields": [ { "key": { "name": "maxInMemorySize" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "512" } }, "annotations": { "description": { "value": "Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk." } } }, { "key": { "name": "bufferUnit" }, "model": { "type": "String", "annotations": { "enum": { "type": "[Ljava.lang.String;", "values": [ "BYTE", "KB", "MB", "GB" ] }, "default": "KB" } }, "annotations": { "description": { "value": "The unit in which maxInMemorySize is expressed" } } } ] }, { "type": "Object", "annotations": { "typeId": "non-repeatable-stream", "description": { "value": "This configuration allows the input stream to be read only once. It will not allow to seek randomly which will limit the transformations that DW can perform on this stream. Use this option for use cases which just require moving data around from one system to another to get optimum performance." } }, "fields": [] } ] }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "NOT_SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": false, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 4, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "streamingStrategy", "description": "Configure if repeatable streams should be used and their behaviour", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-byte-streaming-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 2 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} }, { "parameters": [ { "type": { "format": "java", "type": "String" }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "NOT_SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 5, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "target", "displayModel": { "displayName": "Target Variable" }, "description": "The name of a variable on which the operation\u0027s output will be placed", "modelProperties": {} }, { "type": { "format": "java", "type": "String" }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "REQUIRED", "defaultValue": "#[payload]", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 6, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "targetValue", "displayModel": { "displayName": "Target Value" }, "description": "An expression that will be evaluated against the operation\u0027s output and the outcome of that expression will be stored in the target variable", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "showInDsl": false, "name": "Output", "description": "", "modelProperties": {} } ], "name": "operationWithStreaming", "description": "Operation With String description", "modelProperties": {}, "kind": "operation" } ], "connectionProviders": [], "messageSources": [ { "hasResponse": false, "runsOnPrimaryNodeOnly": false, "output": { "type": { "format": { "id": "application/plain", "label": "application/plain", "validMimeTypes": [ "application/plain" ] }, "type": "Binary", "annotations": { "classInformation": { "classname": "java.io.InputStream", "hasDefaultConstructor": true, "isInterface": false, "isInstantiable": false, "isAbstract": true, "isFinal": false, "implementedInterfaces": [ "java.io.Closeable" ], "parent": "", "genericTypes": [], "isMap": false } } }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "outputAttributes": { "type": { "format": "java", "type": "@ref:org.mule.modules.basic.BasicAttributes" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": false, "supportsStreaming": true, "notifications": [], "nestedComponents": [], "errors": [], "stereotype": { "type": "SOURCE", "namespace": "MULE" }, "parameterGroupModels": [ { "parameters": [ { "type": { "format": "java", "type": "String" }, "hasDynamicType": false, "required": true, "isConfigOverride": false, "expressionSupport": "NOT_SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "allowedStereotypeModels": [], "name": "sourceParameter", "description": "Source Parameter description", "modelProperties": {} }, { "type": { "format": "java", "type": "String" }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 2, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "outputMimeType", "description": "The mime type of the payload that this operation outputs.", "modelProperties": {} }, { "type": { "format": "java", "type": "String" }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 3, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "outputEncoding", "description": "The encoding of the payload that this operation outputs.", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean" }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "NOT_SUPPORTED", "defaultValue": false, "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 6, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "primaryNodeOnly", "description": "Whether this source should only be executed on the primary node when runnning in Cluster", "modelProperties": {} }, { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ByteStreamingStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "repeatable-in-memory-stream" }, "fields": [ { "key": { "name": "initialBufferSize" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "512" } }, "annotations": { "description": { "value": "This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize." } } }, { "key": { "name": "bufferSizeIncrement" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "512" } }, "annotations": { "description": { "value": "This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full." } } }, { "key": { "name": "maxBufferSize" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "1024" } }, "annotations": { "description": { "value": "This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit." } } }, { "key": { "name": "bufferUnit" }, "model": { "type": "String", "annotations": { "enum": { "type": "[Ljava.lang.String;", "values": [ "BYTE", "KB", "MB", "GB" ] }, "default": "KB" } }, "annotations": { "description": { "value": "The unit in which all these attributes are expressed" } } } ] }, { "type": "Object", "annotations": { "typeId": "repeatable-file-store-stream" }, "fields": [ { "key": { "name": "maxInMemorySize" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "512" } }, "annotations": { "description": { "value": "Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk." } } }, { "key": { "name": "bufferUnit" }, "model": { "type": "String", "annotations": { "enum": { "type": "[Ljava.lang.String;", "values": [ "BYTE", "KB", "MB", "GB" ] }, "default": "KB" } }, "annotations": { "description": { "value": "The unit in which maxInMemorySize is expressed" } } } ] }, { "type": "Object", "annotations": { "typeId": "non-repeatable-stream", "description": { "value": "This configuration allows the input stream to be read only once. It will not allow to seek randomly which will limit the transformations that DW can perform on this stream. Use this option for use cases which just require moving data around from one system to another to get optimum performance." } }, "fields": [] } ] }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "NOT_SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": false, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 4, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "streamingStrategy", "description": "Configure if repeatable streams should be used and their behaviour", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-byte-streaming-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 2 } } }, { "type": { "format": "java", "type": "Object", "annotations": { "typeId": "RedeliveryPolicy" }, "fields": [ { "key": { "name": "maxRedeliveryCount" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "5" } }, "annotations": { "description": { "value": "The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message" } } }, { "key": { "name": "useSecureHash" }, "model": { "type": "Boolean", "annotations": { "default": "true" } }, "annotations": { "description": { "value": "Whether to use a secure hash algorithm to identify a redelivered message" } } }, { "key": { "name": "messageDigestAlgorithm" }, "model": { "type": "String" }, "annotations": { "description": { "value": "The secure hashing algorithm to use. If not set, the default is SHA-256." } } }, { "key": { "name": "idExpression" }, "model": { "type": "String" }, "annotations": { "description": { "value": "Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false." } } }, { "key": { "name": "objectStore" }, "model": { "type": "@ref:org.mule.runtime.api.store.ObjectStore" }, "annotations": { "stereotype": { "allowedStereotypes": [ { "type": "OBJECT_STORE", "namespace": "OS" } ] }, "description": { "value": "The object store where the redelivery counter for each message is going to be stored." } } } ] }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "NOT_SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": false, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 5, "tabName": "Redelivery" }, "allowedStereotypeModels": [], "name": "redeliveryPolicy", "description": "Defines a policy for processing the redelivery of the same message", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-redelivery-policy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 1 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} } ], "name": "BasicSource", "description": "Basic Source with Streamming", "modelProperties": {}, "kind": "source" } ], "name": "config", "description": "Config Description", "modelProperties": {} } ], "operations": [], "functions": [], "constructs": [], "connectionProviders": [], "messageSources": [], "notifications": [], "errors": [ { "error": "MULE:ANY", "handleable": true }, { "error": "MULE:RETRY_EXHAUSTED", "parent": "MULE:ANY", "handleable": true }, { "error": "STREAMING:RETRY_EXHAUSTED", "parent": "MULE:RETRY_EXHAUSTED", "handleable": true }, { "error": "STREAMING:CONNECTIVITY", "parent": "MULE:CONNECTIVITY", "handleable": true }, { "error": "MULE:CONNECTIVITY", "parent": "MULE:ANY", "handleable": true } ], "modelProperties": {}, "types": [ { "format": "java", "type": "Object", "annotations": { "typeId": "org.mule.modules.basic.BasicAttributes", "classInformation": { "classname": "org.mule.modules.basic.BasicAttributes", "hasDefaultConstructor": true, "isInterface": false, "isInstantiable": true, "isAbstract": false, "isFinal": false, "implementedInterfaces": [ "java.io.Serializable" ], "parent": "", "genericTypes": [], "isMap": false }, "typeAlias": { "value": "BasicAttributes" } }, "fields": [ { "key": { "name": "username" }, "model": { "type": "String" } } ] } ] }