{ "name": "File", "description": "File connector used to manipulate file systems mounted on the host operation system. \u003cp\u003e This class serves as both extension definition and configuration. Operations are based on the standard BaseFileSystemOperations", "version": "1.4.2-SNAPSHOT", "vendor": "Mulesoft", "category": "COMMUNITY", "xmlDsl": { "prefix": "file", "namespace": "http://www.mulesoft.org/schema/mule/file", "schemaLocation": "http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd", "schemaVersion": "1.4.2-SNAPSHOT", "xsdFileName": "mule-file.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": [] }, { "format": "java", "type": "Object", "annotations": { "typeId": "org.mule.runtime.core.api.source.scheduler.Scheduler", "classInformation": { "classname": "org.mule.runtime.core.api.source.scheduler.Scheduler", "hasDefaultConstructor": false, "isInterface": true, "isInstantiable": false, "isAbstract": true, "isFinal": false, "implementedInterfaces": [], "parent": "", "genericTypes": [], "isMap": false }, "typeAlias": { "value": "scheduling-strategy" } }, "fields": [] } ], "configurations": [ { "stereotype": { "type": "CONFIG", "namespace": "FILE", "parent": { "type": "MODULE_CONFIG", "namespace": "MULE" } }, "parameterGroupModels": [ { "parameters": [ { "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": 1, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "defaultWriteEncoding", "displayModel": { "displayName": "Default write encoding(DEPRECATED)", "summary": "This parameter is deprecated and will not be taken into account" }, "description": "", "modelProperties": {} }, { "type": { "format": "java", "type": "Number", "annotations": { "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 }, "int": {} } }, "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": "timeBetweenSizeCheck", "displayModel": { "summary": "Wait time between size checks to determine if a file is ready to be read." }, "description": "Wait time between size checks to determine if a file is ready to be read. This allows a file write to complete before processing. If no value is provided, the check will not be performed. When enabled, Mule performs two size checks waiting the specified time between calls. If both checks return the same value, the file is ready to be read.This attribute works in tandem with #timeBetweenSizeCheckUnit.", "modelProperties": {} }, { "type": { "format": "java", "type": "String", "annotations": { "typeId": "java.util.concurrent.TimeUnit", "enum": { "type": "[Ljava.lang.String;", "values": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "MILLISECONDS", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 3, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "timeBetweenSizeCheckUnit", "displayModel": { "summary": "Time unit to be used in the wait time between size checks" }, "description": "A TimeUnit which qualifies the #timeBetweenSizeCheck attribute. \u003cp\u003e Defaults to MILLISECONDS", "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": 4, "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": "BLOCKING", "output": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "outputAttributes": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": true, "supportsStreaming": false, "notifications": [], "nestedComponents": [], "errors": [ "FILE:CONNECTIVITY", "FILE:ILLEGAL_PATH", "FILE:FILE_ALREADY_EXISTS", "FILE:RETRY_EXHAUSTED" ], "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": "sourcePath", "displayModel": { "pathModel": { "type": "ANY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "the path to the file to be copied", "modelProperties": {} }, { "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": 2 }, "allowedStereotypeModels": [], "name": "targetPath", "displayModel": { "pathModel": { "type": "ANY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "the target directory where the file is going to be copied", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "true", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 3 }, "allowedStereotypeModels": [], "name": "createParentDirectories", "description": "whether or not to attempt creating any parent directories which don\u0027t exists.", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "false", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 4 }, "allowedStereotypeModels": [], "name": "overwrite", "description": "whether or not overwrite the file if the target destination already exists.", "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": 5 }, "allowedStereotypeModels": [], "name": "renameTo", "description": "copied file\u0027s new name. If not provided, original file name will be kept.", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} }, { "parameters": [ { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "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": 6, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "reconnectionStrategy", "description": "A retry strategy in case of connectivity errors", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-reconnection-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "copy", "displayModel": { "summary": "Copies a file" }, "description": "Copies the file at the sourcePath into the targetPath. \u003cp\u003e If targetPath doesn\u0027t exist, and neither does its parent, then an attempt will be made to create depending on the value of the createParentFolder argument. If such argument is , then a FILE:ILLEGAL_PATH will be thrown. \u003cp\u003e If the target file already exists, then it will be overwritten if the overwrite argument is true. Otherwise, FILE:FILE_ALREADY_EXISTS error will be thrown. \u003cp\u003e As for the sourcePath, it can either be a file or a directory. If it points to a directory, then it will be copied recursively.", "modelProperties": {}, "kind": "operation" }, { "blocking": true, "executionType": "BLOCKING", "output": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "outputAttributes": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": true, "supportsStreaming": false, "notifications": [], "nestedComponents": [], "errors": [ "FILE:CONNECTIVITY", "FILE:ILLEGAL_PATH", "FILE:FILE_ALREADY_EXISTS", "FILE:RETRY_EXHAUSTED", "FILE:ACCESS_DENIED" ], "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": "directoryPath", "displayModel": { "pathModel": { "type": "DIRECTORY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "the new directory\u0027s name", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} }, { "parameters": [ { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "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": "reconnectionStrategy", "description": "A retry strategy in case of connectivity errors", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-reconnection-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "createDirectory", "displayModel": { "summary": "Creates a new directory" }, "description": "Creates a new directory on directoryPath", "modelProperties": {}, "kind": "operation" }, { "blocking": true, "executionType": "BLOCKING", "output": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "outputAttributes": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": true, "supportsStreaming": false, "notifications": [], "nestedComponents": [], "errors": [ "FILE:CONNECTIVITY", "FILE:ILLEGAL_PATH", "FILE:RETRY_EXHAUSTED", "FILE:ACCESS_DENIED" ], "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": "path", "displayModel": { "pathModel": { "type": "ANY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "the path to the file to be deleted", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} }, { "parameters": [ { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "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": "reconnectionStrategy", "description": "A retry strategy in case of connectivity errors", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-reconnection-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "delete", "displayModel": { "summary": "Deletes a file" }, "description": "Deletes the file pointed by path, provided that it\u0027s not locked", "modelProperties": {}, "kind": "operation" }, { "blocking": true, "executionType": "BLOCKING", "output": { "type": { "format": "java", "type": "Array", "annotations": { "classInformation": { "classname": "org.mule.runtime.extension.api.runtime.streaming.PagingProvider", "hasDefaultConstructor": false, "isInterface": true, "isInstantiable": false, "isAbstract": true, "isFinal": false, "implementedInterfaces": [], "parent": "", "genericTypes": [ "org.mule.extension.file.internal.LocalFileSystem", "org.mule.runtime.extension.api.runtime.operation.Result" ], "isMap": false } }, "item": { "type": "Object", "annotations": { "typeId": "org.mule.runtime.api.message.Message" }, "fields": [ { "key": { "name": "payload", "required": "true" }, "model": { "type": "Object", "annotations": { "typeId": "java.lang.Object", "classInformation": { "classname": "java.lang.Object", "hasDefaultConstructor": true, "isInterface": false, "isInstantiable": true, "isAbstract": false, "isFinal": false, "implementedInterfaces": [], "parent": "", "genericTypes": [], "isMap": false }, "typeAlias": { "value": "Object" } }, "fields": [] } }, { "key": { "name": "attributes", "required": "true" }, "model": { "type": "@ref:org.mule.extension.file.api.LocalFileAttributes" } } ] } }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "outputAttributes": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": true, "supportsStreaming": true, "notifications": [], "nestedComponents": [], "errors": [ "FILE:ILLEGAL_PATH", "FILE:ACCESS_DENIED" ], "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": "directoryPath", "displayModel": { "pathModel": { "type": "DIRECTORY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "the path to the directory to be listed", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "false", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "allowedStereotypeModels": [], "name": "recursive", "description": "whether to include the contents of sub-directories. Defaults to false.", "modelProperties": {} }, { "type": { "format": "java", "type": "@ref:org.mule.extension.file.api.LocalFileMatcher" }, "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 }, "allowedStereotypeModels": [], "name": "matcher", "displayModel": { "displayName": "File Matching Rules", "summary": "Matcher to filter the listed files" }, "description": "a matcher used to filter the output list", "modelProperties": {} }, { "type": { "format": "java", "type": "Number", "annotations": { "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 }, "int": {} } }, "hasDynamicType": false, "required": false, "isConfigOverride": true, "expressionSupport": "SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 4, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "timeBetweenSizeCheck", "description": "wait time between size checks to determine if a file is ready to be read.", "modelProperties": {} }, { "type": { "format": "java", "type": "String", "annotations": { "typeId": "java.util.concurrent.TimeUnit", "enum": { "type": "[Ljava.lang.String;", "values": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "hasDynamicType": false, "required": false, "isConfigOverride": true, "expressionSupport": "SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 5, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "timeBetweenSizeCheckUnit", "description": "time unit to be used in the wait time between size checks.", "modelProperties": {} }, { "type": { "format": "java", "type": "@ref:org.mule.extension.file.api.subset.LocalSubsetList" }, "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": 6, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "subset", "displayModel": { "summary": "Limit and sort the number of files returned" }, "description": "", "modelProperties": {} }, { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ObjectStreamingStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "repeatable-in-memory-iterable" }, "fields": [ { "key": { "name": "initialBufferSize" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "100" } }, "annotations": { "description": { "value": "This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances." } } }, { "key": { "name": "bufferSizeIncrement" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "100" } }, "annotations": { "description": { "value": "This is by how much will the 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. Default value is 100 instances." } } }, { "key": { "name": "maxBufferSize" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "500" } }, "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." } } } ] }, { "type": "Object", "annotations": { "typeId": "repeatable-file-store-iterable" }, "fields": [ { "key": { "name": "inMemoryObjects" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "100" } }, "annotations": { "description": { "value": "This is the maximum amount of instances that will be kept in memory. If more than that is required, 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-iterable", "description": { "value": "This configuration allows the 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": 7, "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-object-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": 8, "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": 9, "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": {} }, { "parameters": [ { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "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": 10, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "reconnectionStrategy", "description": "A retry strategy in case of connectivity errors", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-reconnection-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 3 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "list", "displayModel": { "summary": "List all the files from given directory" }, "description": "Lists all the files in the directoryPath which match the given matcher. \u003cp\u003e If the listing encounters a directory, the output list will include its contents depending on the value of the recursive parameter. \u003cp\u003e", "modelProperties": {}, "kind": "operation" }, { "blocking": true, "executionType": "BLOCKING", "output": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "outputAttributes": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": true, "supportsStreaming": false, "notifications": [], "nestedComponents": [], "errors": [ "FILE:CONNECTIVITY", "FILE:ILLEGAL_PATH", "FILE:FILE_ALREADY_EXISTS", "FILE:RETRY_EXHAUSTED" ], "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": "sourcePath", "displayModel": { "pathModel": { "type": "ANY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "the path to the file to be copied", "modelProperties": {} }, { "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": 2 }, "allowedStereotypeModels": [], "name": "targetPath", "displayModel": { "pathModel": { "type": "DIRECTORY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "the target directory", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "true", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 3 }, "allowedStereotypeModels": [], "name": "createParentDirectories", "description": "whether or not to attempt creating any parent directories which don\u0027t exists.", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "false", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 4 }, "allowedStereotypeModels": [], "name": "overwrite", "description": "whether or not overwrite the file if the target destination already exists.", "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": 5 }, "allowedStereotypeModels": [], "name": "renameTo", "description": "moved file\u0027s new name. If not provided, original file name will be kept.", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} }, { "parameters": [ { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "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": 6, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "reconnectionStrategy", "description": "A retry strategy in case of connectivity errors", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-reconnection-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "move", "displayModel": { "summary": "Moves a file" }, "description": "Moves the file at the sourcePath into the targetPath. \u003cp\u003e If targetPath doesn\u0027t exist, and neither does its parent, then an attempt will be made to create depending on the value of the createParentFolder argument. If such argument is , then a FILE:ILLEGAL_PATH will be thrown. \u003cp\u003e If the target file already exists, then it will be overwritten if the overwrite argument is true. Otherwise, FILE:FILE_ALREADY_EXISTS error will be thrown. \u003cp\u003e As for the sourcePath, it can either be a file or a directory. If it points to a directory, then it will be moved recursively.", "modelProperties": {}, "kind": "operation" }, { "blocking": true, "executionType": "BLOCKING", "output": { "type": { "format": "java", "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.extension.file.api.LocalFileAttributes" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": true, "supportsStreaming": true, "notifications": [], "nestedComponents": [], "errors": [ "FILE:CONNECTIVITY", "FILE:FILE_LOCK", "FILE:ILLEGAL_PATH", "FILE:RETRY_EXHAUSTED", "FILE:ACCESS_DENIED" ], "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": "path", "displayModel": { "displayName": "File Path", "pathModel": { "type": "FILE", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "the path to the file to be read", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "false", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 2, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "lock", "description": "whether or not to lock the file. Defaults to false.", "modelProperties": {} }, { "type": { "format": "java", "type": "Number", "annotations": { "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 }, "int": {} } }, "hasDynamicType": false, "required": false, "isConfigOverride": true, "expressionSupport": "SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 3, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "timeBetweenSizeCheck", "description": "wait time between size checks to determine if a file is ready to be read.", "modelProperties": {} }, { "type": { "format": "java", "type": "String", "annotations": { "typeId": "java.util.concurrent.TimeUnit", "enum": { "type": "[Ljava.lang.String;", "values": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "hasDynamicType": false, "required": false, "isConfigOverride": true, "expressionSupport": "SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 4, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "timeBetweenSizeCheckUnit", "description": "time unit to be used in the wait time between size checks.", "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": 5, "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": 6, "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": "inMemorySize" }, "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": 7, "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": 8, "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": 9, "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": {} }, { "parameters": [ { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "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": 10, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "reconnectionStrategy", "description": "A retry strategy in case of connectivity errors", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-reconnection-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 3 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "read", "displayModel": { "summary": "Obtains the content and metadata of a file at a given path" }, "description": "Obtains the content and metadata of a file at a given path. The operation itself returns a Message which payload is a InputStream with the file\u0027s content, and the metadata is represent as a LocalFileAttributes object that\u0027s placed as the message Message#getAttributes() attributes. \u003cp\u003e If the lock parameter is set to true, then a file system level lock will be placed on the file until the input stream this operation returns is closed or fully consumed. Because the lock is actually provided by the host file system, its behavior might change depending on the mounted drive and the operation system on which mule is running. Take that into consideration before blindly relying on this lock. \u003cp\u003e This method also makes a best effort to determine the mime type of the file being read. The file\u0027s extension will be used to make an educated guess on the file\u0027s mime type. The user also has the chance to force the output encoding and mimeType through the outputEncoding and outputMimeType optional parameters.", "modelProperties": {}, "kind": "operation" }, { "blocking": true, "executionType": "BLOCKING", "output": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "outputAttributes": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": true, "supportsStreaming": false, "notifications": [], "nestedComponents": [], "errors": [ "FILE:CONNECTIVITY", "FILE:ILLEGAL_PATH", "FILE:FILE_ALREADY_EXISTS", "FILE:RETRY_EXHAUSTED", "FILE:ACCESS_DENIED" ], "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": "path", "displayModel": { "pathModel": { "type": "ANY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "the path to the file to be renamed", "modelProperties": {} }, { "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": 2 }, "allowedStereotypeModels": [], "name": "to", "displayModel": { "displayName": "New Name" }, "description": "the file\u0027s new name", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "false", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 3 }, "allowedStereotypeModels": [], "name": "overwrite", "description": "whether or not overwrite the file if the target destination already exists.", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} }, { "parameters": [ { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "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": "reconnectionStrategy", "description": "A retry strategy in case of connectivity errors", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-reconnection-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "rename", "displayModel": { "summary": "Renames a file" }, "description": "Renames the file pointed by path to the name provided on the to parameter \u003cp\u003e to argument should not contain any path separator. FILE:ILLEGAL_PATH will be thrown if this precondition is not honored.", "modelProperties": {}, "kind": "operation" }, { "blocking": true, "executionType": "BLOCKING", "output": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "outputAttributes": { "type": { "format": "java", "type": "Void" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": true, "supportsStreaming": false, "notifications": [], "nestedComponents": [], "errors": [ "FILE:ILLEGAL_CONTENT", "FILE:CONNECTIVITY", "FILE:FILE_LOCK", "FILE:ILLEGAL_PATH", "FILE:FILE_ALREADY_EXISTS", "FILE:RETRY_EXHAUSTED", "FILE:ACCESS_DENIED" ], "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": "path", "displayModel": { "pathModel": { "type": "FILE", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "the path of the file to be written", "modelProperties": {} }, { "type": { "format": "java", "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, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "#[payload]", "role": "PRIMARY_CONTENT", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": false, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "allowedStereotypeModels": [], "name": "content", "displayModel": { "summary": "Content to be written into the file" }, "description": "the content to be written into the file. Defaults to the current Message payload", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "true", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 3 }, "allowedStereotypeModels": [], "name": "createParentDirectories", "description": "whether or not to attempt creating any parent directories which don\u0027t exists.", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "false", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 4, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "lock", "description": "whether or not to lock the file. Defaults to false", "modelProperties": {} }, { "type": { "format": "java", "type": "String", "annotations": { "typeId": "org.mule.extension.file.common.api.FileWriteMode", "enum": { "type": "[Ljava.lang.String;", "values": [ "OVERWRITE", "APPEND", "CREATE_NEW" ] } } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "OVERWRITE", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 5 }, "allowedStereotypeModels": [], "name": "mode", "displayModel": { "displayName": "Write Mode", "summary": "How the file is going to be written" }, "description": "a FileWriteMode. Defaults to OVERWRITE", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} }, { "parameters": [ { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "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": 6, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "reconnectionStrategy", "description": "A retry strategy in case of connectivity errors", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-reconnection-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "write", "displayModel": { "summary": "Writes the given \"Content\" in the file pointed by \"Path\"" }, "description": "Writes the content into the file pointed by path. \u003cp\u003e If the directory on which the file is attempting to be written doesn\u0027t exist, then the operation will either throw FILE:ILLEGAL_PATH error or create such folder depending on the value of the createParentDirectory. \u003cp\u003e If the file itself already exists, then the behavior depends on the supplied mode. \u003cp\u003e This operation also supports locking support depending on the value of the lock argument, but following the same rules and considerations as described in the read operation.", "modelProperties": {}, "kind": "operation" } ], "connectionProviders": [ { "connectionManagementType": "CACHED", "externalLibraryModels": [], "supportsConnectivityTesting": true, "stereotype": { "type": "CONNECTION", "namespace": "FILE", "parent": { "type": "CONNECTION", "namespace": "MULE" } }, "parameterGroupModels": [ { "parameters": [ { "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": 1 }, "allowedStereotypeModels": [], "name": "workingDir", "displayModel": { "displayName": "Working Directory", "summary": "Directory to be considered as the root of every relative path used with this connector. Defaults to the user\u0027s home", "pathModel": { "type": "ANY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "The directory to be considered as the root of every relative path used with this connector. If not provided, it will default to the value of the user.home system property. If that system property is not set, then the connector will fail to initialise.", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} }, { "parameters": [ { "type": { "format": "java", "type": "Object", "annotations": { "typeId": "Reconnection" }, "fields": [ { "key": { "name": "failsDeployment" }, "model": { "type": "Boolean", "annotations": { "default": "false" } }, "annotations": { "description": { "value": "When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn\u0027t pass after exhausting the associated reconnection strategy" } } }, { "key": { "name": "reconnectionStrategy" }, "model": { "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "annotations": { "description": { "value": "The reconnection strategy to use" } } } ] }, "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": "reconnection", "description": "When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn\u0027t pass after exhausting the associated reconnection strategy", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "reconnection", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "connection", "displayModel": { "displayName": "Local FileSystem Connection" }, "description": "A ConnectionProvider which provides instances of FileSystem from instances of FileConnector", "modelProperties": {} } ], "messageSources": [ { "hasResponse": false, "runsOnPrimaryNodeOnly": false, "successCallback": { "parameterGroupModels": [ { "parameters": [ { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "false", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 13 }, "allowedStereotypeModels": [], "name": "autoDelete", "description": "Whether each file should be deleted after processing or not", "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": 14 }, "allowedStereotypeModels": [], "name": "moveToDirectory", "displayModel": { "pathModel": { "type": "DIRECTORY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "If provided, each processed file will be moved to a directory pointed by this path.", "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": 15 }, "allowedStereotypeModels": [], "name": "renameTo", "description": "This parameter works in tandem with moveToDirectory. Use this parameter to enter the name under which the file should be moved. Do not set this parameter if moveToDirectory hasn\u0027t been set as well.", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "true", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 16 }, "allowedStereotypeModels": [], "name": "applyPostActionWhenFailed", "description": "Whether any of the post actions (autoDelete and moveToDirectory) should also be applied in case the file failed to be processed. If set to false, no failed files will be moved nor deleted.", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false }, "showInDsl": false, "name": "Post processing action", "description": "", "modelProperties": {} } ], "name": "onSuccess", "description": "", "modelProperties": {} }, "errorCallback": { "parameterGroupModels": [ { "parameters": [ { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "false", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 17 }, "allowedStereotypeModels": [], "name": "autoDelete", "description": "Whether each file should be deleted after processing or not", "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": 18 }, "allowedStereotypeModels": [], "name": "moveToDirectory", "displayModel": { "pathModel": { "type": "DIRECTORY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "If provided, each processed file will be moved to a directory pointed by this path.", "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": 19 }, "allowedStereotypeModels": [], "name": "renameTo", "description": "This parameter works in tandem with moveToDirectory. Use this parameter to enter the name under which the file should be moved. Do not set this parameter if moveToDirectory hasn\u0027t been set as well.", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "SUPPORTED", "defaultValue": "true", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 20 }, "allowedStereotypeModels": [], "name": "applyPostActionWhenFailed", "description": "Whether any of the post actions (autoDelete and moveToDirectory) should also be applied in case the file failed to be processed. If set to false, no failed files will be moved nor deleted.", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false }, "showInDsl": false, "name": "Post processing action", "description": "", "modelProperties": {} } ], "name": "onError", "description": "", "modelProperties": {} }, "terminateCallbackModel": { "parameterGroupModels": [], "name": "onTerminate", "description": "", "modelProperties": {} }, "output": { "type": { "format": "java", "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.extension.file.api.LocalFileAttributes" }, "hasDynamicType": false, "description": "", "modelProperties": {} }, "transactional": false, "requiresConnection": true, "supportsStreaming": true, "notifications": [], "nestedComponents": [], "errors": [], "stereotype": { "type": "SOURCE", "namespace": "MULE" }, "parameterGroupModels": [ { "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": 1 }, "allowedStereotypeModels": [], "name": "directory", "displayModel": { "pathModel": { "type": "DIRECTORY", "fileExtensions": [], "acceptsUrls": false, "location": "ANY" } }, "description": "The directory on which polled files are contained", "modelProperties": {} }, { "type": { "format": "java", "type": "Boolean", "annotations": { "typeId": "boolean" } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "NOT_SUPPORTED", "defaultValue": "true", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "allowedStereotypeModels": [], "name": "recursive", "displayModel": { "summary": "Whether or not to also catch files created on sub directories" }, "description": "Whether or not to also files contained in sub directories.", "modelProperties": {} }, { "type": { "format": "java", "type": "@ref:org.mule.extension.file.api.LocalFileMatcher" }, "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": 3 }, "allowedStereotypeModels": [], "name": "matcher", "displayModel": { "displayName": "Matcher" }, "description": "A matcher used to filter events on files which do not meet the matcher\u0027s criteria", "modelProperties": {} }, { "type": { "format": "java", "type": "String", "annotations": { "typeId": "org.mule.extension.file.api.WatermarkMode", "enum": { "type": "[Ljava.lang.String;", "values": [ "DISABLED", "MODIFIED_TIMESTAMP", "CREATED_TIMESTAMP" ] } } }, "hasDynamicType": false, "required": false, "isConfigOverride": false, "expressionSupport": "NOT_SUPPORTED", "defaultValue": "DISABLED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 4 }, "allowedStereotypeModels": [], "name": "watermarkMode", "description": "Controls whether or not to do watermarking, and if so, if the watermark should consider the file\u0027s modification or creation timestamps", "modelProperties": {} }, { "type": { "format": "java", "type": "Number", "annotations": { "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 }, "int": {} } }, "hasDynamicType": false, "required": false, "isConfigOverride": true, "expressionSupport": "NOT_SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 5 }, "allowedStereotypeModels": [], "name": "timeBetweenSizeCheck", "displayModel": { "summary": "Wait time in milliseconds between size checks to determine if a file is ready to be read." }, "description": "Wait time in milliseconds between size checks to determine if a file is ready to be read. This allows a file write to complete before processing. You can disable this feature by omitting a value. When enabled, Mule performs two size checks waiting the specified time between calls. If both checks return the same value, the file is ready to be read.", "modelProperties": {} }, { "type": { "format": "java", "type": "String", "annotations": { "typeId": "java.util.concurrent.TimeUnit", "enum": { "type": "[Ljava.lang.String;", "values": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "hasDynamicType": false, "required": false, "isConfigOverride": true, "expressionSupport": "NOT_SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": true, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 6 }, "allowedStereotypeModels": [], "name": "timeBetweenSizeCheckUnit", "displayModel": { "summary": "Time unit to be used in the wait time between size checks" }, "description": "A TimeUnit which qualifies the #timeBetweenSizeCheck attribute.", "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": 7, "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": 8, "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": 21, "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": "@ref:org.mule.runtime.core.api.source.scheduler.Scheduler" }, "hasDynamicType": false, "required": true, "isConfigOverride": false, "expressionSupport": "NOT_SUPPORTED", "role": "BEHAVIOUR", "dslConfiguration": { "allowsInlineDefinition": true, "allowsReferences": false, "allowTopLevelDefinition": false }, "layoutModel": { "password": false, "text": false, "query": false, "order": 9 }, "allowedStereotypeModels": [], "name": "schedulingStrategy", "description": "Configures the scheduler that triggers the polling", "modelProperties": { "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 10 }, "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "scheduling-strategy", "prefix": "mule" } } } }, { "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": "inMemorySize" }, "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": 10, "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": 11, "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": {} }, { "parameters": [ { "type": { "format": "java", "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "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": 12, "tabName": "Advanced" }, "allowedStereotypeModels": [], "name": "reconnectionStrategy", "description": "A retry strategy in case of connectivity errors", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "abstract-reconnection-strategy", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "listener", "displayModel": { "displayName": "On New or Updated File", "summary": "Triggers when a new file is created in a directory" }, "description": "Polls a directory looking for files that have been created or updated. One message will be generated for each file that is found. \u003cp\u003e The key part of this functionality is how to determine that a file is actually new. There\u0027re three strategies for that: \u003cul\u003e \u003cli\u003eSet the \u003ci\u003eautoDelete\u003c/i\u003e parameter to \u003ci\u003etrue\u003c/i\u003e: This will delete each processed file after it has been processed, causing all files obtained in the next poll to be necessarily new\u003c/li\u003e \u003cli\u003eSet \u003ci\u003emoveToDirectory\u003c/i\u003e parameter: This will move each processed file to a different directory after it has been processed, achieving the same effect as \u003ci\u003eautoDelete\u003c/i\u003e but without loosing the file\u003c/li\u003e \u003cli\u003e\u003c/li\u003e \u003cli\u003eUse the \u003ci\u003ewatermarkMode\u003c/i\u003e parameter to only pick files that have been created/updated after the last poll was executed.\u003c/li\u003e \u003c/ul\u003e \u003cp\u003e A matcher can also be used for additional filtering of files.", "modelProperties": {}, "kind": "source" } ], "name": "config", "description": "Default configuration", "modelProperties": {} } ], "operations": [], "functions": [], "constructs": [], "connectionProviders": [ { "connectionManagementType": "CACHED", "externalLibraryModels": [], "supportsConnectivityTesting": true, "stereotype": { "type": "CONNECTION", "namespace": "FILE", "parent": { "type": "CONNECTION", "namespace": "MULE" } }, "parameterGroupModels": [ { "parameters": [ { "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": 1 }, "allowedStereotypeModels": [], "name": "workingDir", "displayModel": { "displayName": "Working Directory", "summary": "Directory to be considered as the root of every relative path used with this connector. Defaults to the user\u0027s home", "pathModel": { "type": "ANY", "fileExtensions": [], "acceptsUrls": false, "location": "EXTERNAL" } }, "description": "The directory to be considered as the root of every relative path used with this connector. If not provided, it will default to the value of the user.home system property. If that system property is not set, then the connector will fail to initialise.", "modelProperties": {} } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 1 }, "showInDsl": false, "name": "General", "description": "", "modelProperties": {} }, { "parameters": [ { "type": { "format": "java", "type": "Object", "annotations": { "typeId": "Reconnection" }, "fields": [ { "key": { "name": "failsDeployment" }, "model": { "type": "Boolean", "annotations": { "default": "false" } }, "annotations": { "description": { "value": "When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn\u0027t pass after exhausting the associated reconnection strategy" } } }, { "key": { "name": "reconnectionStrategy" }, "model": { "type": "Union", "annotations": { "typeId": "ReconnectionStrategy" }, "of": [ { "type": "Object", "annotations": { "typeId": "reconnect" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } }, { "key": { "name": "count" }, "model": { "type": "Number", "annotations": { "int": {}, "default": "2" } }, "annotations": { "description": { "value": "How many reconnection attempts to make" } } } ] }, { "type": "Object", "annotations": { "typeId": "reconnect-forever" }, "fields": [ { "key": { "name": "frequency" }, "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": "2000" } }, "annotations": { "description": { "value": "How often (in ms) to reconnect" } } } ] } ] }, "annotations": { "description": { "value": "The reconnection strategy to use" } } } ] }, "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": "reconnection", "description": "When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn\u0027t pass after exhausting the associated reconnection strategy", "modelProperties": { "org.mule.runtime.extension.api.property.QNameModelProperty": { "value": { "namespaceURI": "http://www.mulesoft.org/schema/mule/core", "localPart": "reconnection", "prefix": "mule" } }, "org.mule.runtime.extension.api.property.InfrastructureParameterModelProperty": { "sequence": 3 } } } ], "exclusiveParametersModels": [], "layoutModel": { "password": false, "text": false, "query": false, "order": 2 }, "showInDsl": false, "name": "Connection", "description": "", "modelProperties": {} } ], "name": "connection", "displayModel": { "displayName": "Local FileSystem Connection" }, "description": "A ConnectionProvider which provides instances of FileSystem from instances of FileConnector", "modelProperties": {} } ], "messageSources": [], "notifications": [], "errors": [ { "error": "FILE:CONNECTIVITY", "parent": "MULE:CONNECTIVITY", "handleable": true }, { "error": "MULE:CONNECTIVITY", "parent": "MULE:ANY", "handleable": true }, { "error": "MULE:ANY", "handleable": true }, { "error": "MULE:RETRY_EXHAUSTED", "parent": "MULE:ANY", "handleable": true }, { "error": "FILE:RETRY_EXHAUSTED", "parent": "MULE:RETRY_EXHAUSTED", "handleable": true }, { "error": "FILE:SERVICE_NOT_AVAILABLE", "parent": "FILE:CONNECTIVITY", "handleable": true }, { "error": "FILE:UNKNOWN_HOST", "parent": "FILE:CONNECTIVITY", "handleable": true }, { "error": "FILE:FILE_LOCK", "parent": "MULE:ANY", "handleable": true }, { "error": "FILE:FILE_IS_NOT_DIRECTORY", "parent": "FILE:CONNECTIVITY", "handleable": true }, { "error": "FILE:CONNECTION_TIMEOUT", "parent": "FILE:CONNECTIVITY", "handleable": true }, { "error": "FILE:DISCONNECTED", "parent": "FILE:CONNECTIVITY", "handleable": true }, { "error": "FILE:FILE_NOT_FOUND", "parent": "MULE:ANY", "handleable": true }, { "error": "FILE:FILE_DOESNT_EXIST", "parent": "FILE:CONNECTIVITY", "handleable": true }, { "error": "FILE:ILLEGAL_CONTENT", "parent": "MULE:ANY", "handleable": true }, { "error": "FILE:INVALID_CREDENTIALS", "parent": "FILE:CONNECTIVITY", "handleable": true }, { "error": "FILE:ILLEGAL_PATH", "parent": "MULE:ANY", "handleable": true }, { "error": "FILE:CANNOT_REACH", "parent": "FILE:CONNECTIVITY", "handleable": true }, { "error": "FILE:FILE_ALREADY_EXISTS", "parent": "MULE:ANY", "handleable": true }, { "error": "FILE:ACCESS_DENIED", "parent": "MULE:ANY", "handleable": true } ], "modelProperties": {}, "types": [ { "format": "java", "type": "Object", "annotations": { "typeId": "org.mule.extension.file.api.LocalFileAttributes", "classInformation": { "classname": "org.mule.extension.file.api.LocalFileAttributes", "hasDefaultConstructor": false, "isInterface": false, "isInstantiable": false, "isAbstract": false, "isFinal": false, "implementedInterfaces": [], "parent": "org.mule.extension.file.common.api.AbstractFileAttributes", "genericTypes": [], "isMap": false }, "typeAlias": { "value": "LocalFileAttributes" } }, "fields": [ { "key": { "name": "lastModifiedTime", "required": "true" }, "model": { "type": "DateTime", "annotations": { "typeId": "java.time.LocalDateTime" } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" } } }, { "key": { "name": "lastAccessTime", "required": "true" }, "model": { "type": "DateTime", "annotations": { "typeId": "java.time.LocalDateTime" } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" } } }, { "key": { "name": "creationTime", "required": "true" }, "model": { "type": "DateTime", "annotations": { "typeId": "java.time.LocalDateTime" } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" } } }, { "key": { "name": "size", "required": "true" }, "model": { "type": "Number", "annotations": { "classInformation": { "classname": "long", "hasDefaultConstructor": false, "isInterface": false, "isInstantiable": false, "isAbstract": true, "isFinal": true, "implementedInterfaces": [], "parent": "", "genericTypes": [], "isMap": false }, "int": {} } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" } } }, { "key": { "name": "regularFile" }, "model": { "type": "Boolean", "annotations": { "typeId": "boolean" } }, "annotations": { "default": "false", "expressionSupport": { "value": "SUPPORTED" } } }, { "key": { "name": "directory" }, "model": { "type": "Boolean", "annotations": { "typeId": "boolean" } }, "annotations": { "default": "false", "expressionSupport": { "value": "SUPPORTED" } } }, { "key": { "name": "symbolicLink" }, "model": { "type": "Boolean", "annotations": { "typeId": "boolean" } }, "annotations": { "default": "false", "expressionSupport": { "value": "SUPPORTED" } } }, { "key": { "name": "path", "required": "true" }, "model": { "type": "String" }, "annotations": { "expressionSupport": { "value": "SUPPORTED" } } }, { "key": { "name": "fileName", "required": "true" }, "model": { "type": "String" }, "annotations": { "expressionSupport": { "value": "SUPPORTED" } } } ] }, { "format": "java", "type": "Object", "annotations": { "typeId": "org.mule.extension.file.api.LocalFileMatcher", "classInformation": { "classname": "org.mule.extension.file.api.LocalFileMatcher", "hasDefaultConstructor": true, "isInterface": false, "isInstantiable": true, "isAbstract": false, "isFinal": false, "implementedInterfaces": [], "parent": "org.mule.extension.file.common.api.matcher.FileMatcher", "genericTypes": [], "isMap": false }, "typeDsl": { "allowInlineDefinition": true, "allowTopLevelDefinition": true }, "typeAlias": { "value": "matcher" } }, "fields": [ { "key": { "name": "createdSince" }, "model": { "type": "DateTime", "annotations": { "typeId": "java.time.LocalDateTime" } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Files created before this date are rejected." } } } }, { "key": { "name": "createdUntil" }, "model": { "type": "DateTime", "annotations": { "typeId": "java.time.LocalDateTime" } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Files created after this date are rejected" } } } }, { "key": { "name": "updatedSince" }, "model": { "type": "DateTime", "annotations": { "typeId": "java.time.LocalDateTime" } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Files modified before this date are rejected" } } } }, { "key": { "name": "updatedUntil" }, "model": { "type": "DateTime", "annotations": { "typeId": "java.time.LocalDateTime" } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Files modified after this date are rejected" } } } }, { "key": { "name": "accessedSince" }, "model": { "type": "DateTime", "annotations": { "typeId": "java.time.LocalDateTime" } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Files which were last accessed before this date are rejected" } } } }, { "key": { "name": "accessedUntil" }, "model": { "type": "DateTime", "annotations": { "typeId": "java.time.LocalDateTime" } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Files which were last accessed after this date are rejected" } } } }, { "key": { "name": "notUpdatedInTheLast" }, "model": { "type": "Number", "annotations": { "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 }, "int": {} } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Minimum time that should have passed since a file was updated to not be rejected. This attribute works in tandem with timeUnit.", "example": "10000" } } } }, { "key": { "name": "updatedInTheLast" }, "model": { "type": "Number", "annotations": { "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 }, "int": {} } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Maximum time that should have passed since a file was updated to not be rejected. This attribute works in tandem with timeUnit.", "example": "10000" } } } }, { "key": { "name": "timeUnit" }, "model": { "type": "String", "annotations": { "typeId": "java.util.concurrent.TimeUnit", "enum": { "type": "[Ljava.lang.String;", "values": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "annotations": { "default": "MILLISECONDS", "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Time unit to be used to interpret the parameters \u0027notUpdatedInTheLast\u0027 and \u0027updatedInTheLast\u0027" } } } }, { "key": { "name": "filenamePattern" }, "model": { "type": "String" }, "annotations": { "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "A matching pattern to be applied on the file name." } } } }, { "key": { "name": "pathPattern" }, "model": { "type": "String" }, "annotations": { "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "A matching pattern to be applied on the file path" } } } }, { "key": { "name": "directories" }, "model": { "type": "String", "annotations": { "typeId": "org.mule.extension.file.common.api.matcher.MatchPolicy", "enum": { "type": "[Ljava.lang.String;", "values": [ "REQUIRE", "INCLUDE", "EXCLUDE" ] } } }, "annotations": { "default": "INCLUDE", "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Indicates whether accept only directories or non directories files" } } } }, { "key": { "name": "regularFiles" }, "model": { "type": "String", "annotations": { "typeId": "org.mule.extension.file.common.api.matcher.MatchPolicy", "enum": { "type": "[Ljava.lang.String;", "values": [ "REQUIRE", "INCLUDE", "EXCLUDE" ] } } }, "annotations": { "default": "INCLUDE", "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Indicates whether accept only regular files (files which are not directories, nor symbolic links) or only not regular files" } } } }, { "key": { "name": "symLinks" }, "model": { "type": "String", "annotations": { "typeId": "org.mule.extension.file.common.api.matcher.MatchPolicy", "enum": { "type": "[Ljava.lang.String;", "values": [ "REQUIRE", "INCLUDE", "EXCLUDE" ] } } }, "annotations": { "default": "INCLUDE", "expressionSupport": { "value": "SUPPORTED" }, "display": { "displayModel": { "summary": "Indicates whether accept only symbolic links files or accept only not symbolic links files" } } } }, { "key": { "name": "minSize" }, "model": { "type": "Number", "annotations": { "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 }, "int": {} } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" } } }, { "key": { "name": "maxSize" }, "model": { "type": "Number", "annotations": { "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 }, "int": {} } }, "annotations": { "expressionSupport": { "value": "SUPPORTED" } } } ] }, { "format": "java", "type": "Object", "annotations": { "typeId": "org.mule.extension.file.api.subset.LocalSubsetList", "classInformation": { "classname": "org.mule.extension.file.api.subset.LocalSubsetList", "hasDefaultConstructor": true, "isInterface": false, "isInstantiable": true, "isAbstract": false, "isFinal": false, "implementedInterfaces": [ "org.mule.extension.file.common.api.subset.SubsetList" ], "parent": "", "genericTypes": [], "isMap": false }, "typeAlias": { "value": "LocalSubsetList" } }, "fields": [ { "key": { "name": "limit" }, "model": { "type": "Number", "annotations": { "classInformation": { "classname": "java.lang.Integer", "hasDefaultConstructor": false, "isInterface": false, "isInstantiable": false, "isAbstract": false, "isFinal": true, "implementedInterfaces": [ "java.lang.Comparable" ], "parent": "java.lang.Number", "genericTypes": [], "isMap": false }, "int": {} } }, "annotations": { "default": "0", "expressionSupport": { "value": "SUPPORTED" }, "parameterDsl": { "allowInlineDefinition": true, "allowReferences": false }, "display": { "displayModel": { "displayName": "Limit", "summary": "Limits the number of files returned by the operation." } } } }, { "key": { "name": "offset" }, "model": { "type": "Number", "annotations": { "classInformation": { "classname": "java.lang.Integer", "hasDefaultConstructor": false, "isInterface": false, "isInstantiable": false, "isAbstract": false, "isFinal": true, "implementedInterfaces": [ "java.lang.Comparable" ], "parent": "java.lang.Number", "genericTypes": [], "isMap": false }, "int": {} } }, "annotations": { "default": "0", "expressionSupport": { "value": "SUPPORTED" }, "parameterDsl": { "allowInlineDefinition": true, "allowReferences": false }, "display": { "displayModel": { "displayName": "Offset", "summary": "Specifies how many files are skipped." } } } }, { "key": { "name": "criteria" }, "model": { "type": "String", "annotations": { "typeId": "org.mule.extension.file.api.subset.ListComparator", "enum": { "type": "[Ljava.lang.String;", "values": [ "ALPHABETICALLY", "DATE_MODIFIED", "DATE_CREATED", "SIZE", "PATH" ] } } }, "annotations": { "default": "DATE_MODIFIED", "expressionSupport": { "value": "SUPPORTED" }, "parameterDsl": { "allowInlineDefinition": true, "allowReferences": false }, "display": { "displayModel": { "displayName": "Criteria", "summary": "The criteria according to which files are sorted." } } } }, { "key": { "name": "order" }, "model": { "type": "String", "annotations": { "typeId": "org.mule.extension.file.api.subset.SortOrder", "enum": { "type": "[Ljava.lang.String;", "values": [ "ASCENDING", "DESCENDING" ] } } }, "annotations": { "default": "DESCENDING", "expressionSupport": { "value": "SUPPORTED" }, "parameterDsl": { "allowInlineDefinition": true, "allowReferences": false }, "display": { "displayModel": { "displayName": "Order", "summary": "Specifies whether the order is ASCENDING or DESCENDING according to the criteria." } } } } ] } ] }