Schema "mule-file.xsd"

Target Namespace:

http://www.mulesoft.org/schema/mule/file

Defined Components:

11 global elements, 7 complexTypes, 4 attribute groups

Default Namespace-Qualified Form:

Local Elements: qualified; Local Attributes: unqualified

Schema Location:

http://www.mulesoft.org/schema/mule/file/3.3/mule-file.xsd; see XML source

Imports Schemas (3):

mule-schemadoc.xsd [src], mule.xsd [src], xml.xsd [src]

Imported by Schemas (3):

_mule-all-included.xsd, mule-ftp.xsd [src], mule-sftp.xsd [src]

Annotation

The File transport allows files to be read and written to and from directories on the local file system. The connector can be configured to filter the file it reads and the way files are written, such as whether binary output is used or the file is appended.

All Element Summary

abstract-filenameParser

The abstract-filenameParser element is a placeholder for filename parser elements.

Type:	filenameParserType
Content:	empty
Abstract:	(may not be used directly in instance XML documents)
Subst.Gr:	may be substituted with 2 elements
Defined:	globally; see XML source
Used:	at 5 locations

connector

The File connector configures the default behavior for File endpoints that reference the connector.

Type:	fileConnectorType
Content:	complex, 18 attributes, attr. wildcard, 7 elements
Subst.Gr:	may substitute for element mule:abstract-connector
Defined:	globally; see XML source
Used:	never

custom-filename-parser

The custom-filename-parser element allows the user to specify a custom filename parser.

Type:	customFilenameParserType
Content:	empty, 1 attribute
Subst.Gr:	may substitute for element abstract-filenameParser
Defined:	globally; see XML source
Used:	never

endpoint

Type:	globalEndpointType
Content:	complex, 18 attributes, attr. wildcard, 16 elements
Subst.Gr:	may substitute for element mule:abstract-global-endpoint
Defined:	globally; see XML source
Used:	never

expression-filename-parser

The expression-filename-parser element configures the ExpressionFilenameParser, which can use any expression language supported by Mule to construct a file name for the current message.

Type:	expressionFilenameParserType
Content:	empty
Subst.Gr:	may substitute for element abstract-filenameParser
Defined:	globally; see XML source
Used:	never

file-to-byte-array-transformer

The file-to-byte-array-transformer element configures a transformer that reads the contents of a java.io.File into a byte array (byte[]).

Type:	mule:abstractTransformerType
Content:	complex, 5 attributes, attr. wildcard, 1 element
Subst.Gr:	may substitute for elements: mule:abstract-transformer, mule:abstract-message-processor
Defined:	globally; see XML source
Used:	never

file-to-string-transformer

The file-to-string-transformer element configures a transformer that reads the contents of a java.io.File into a java.lang.String.

Type:	mule:abstractTransformerType
Content:	complex, 5 attributes, attr. wildcard, 1 element
Subst.Gr:	may substitute for elements: mule:abstract-transformer, mule:abstract-message-processor
Defined:	globally; see XML source
Used:	never

filename-regex-filter

The filename-regex-filter element configures a filter that can be used to restrict the files being processed by applying Java regular expressions to the filename, such as pattern="myCustomerFile(.*)".

Type:	mule:wildcardFilterType
Content:	complex, 3 attributes, attr. wildcard, 1 element
Subst.Gr:	may substitute for elements: mule:abstract-filter, mule:abstract-message-processor
Defined:	globally; see XML source
Used:	never

filename-wildcard-filter

The filename-wildcard-filter element configures a filter that can be used to restrict the files being processed by applying wildcard expressions to the filename.

Type:	mule:wildcardFilterType
Content:	complex, 3 attributes, attr. wildcard, 1 element
Subst.Gr:	may substitute for elements: mule:abstract-filter, mule:abstract-message-processor
Defined:	globally; see XML source
Used:	never

inbound-endpoint

Type:	inboundEndpointType
Content:	complex, 17 attributes, attr. wildcard, 16 elements
Subst.Gr:	may substitute for element mule:abstract-inbound-endpoint
Defined:	globally; see XML source
Used:	never

outbound-endpoint

Type:	outboundEndpointType
Content:	complex, 12 attributes, attr. wildcard, 16 elements
Subst.Gr:	may substitute for element mule:abstract-outbound-endpoint
Defined:	globally; see XML source
Used:	never

Complex Type Summary

customFilenameParserType

Content:	empty, 1 attribute
Defined:	globally; see XML source
Includes:	definition of 1 attribute
Used:	at 1 location

expressionFilenameParserType

Content:	empty
Defined:	globally; see XML source
Used:	at 1 location

fileConnectorType

Content:	complex, 18 attributes, attr. wildcard, 7 elements
Defined:	globally; see XML source
Includes:	definitions of 9 attributes, 1 element
Used:	at 1 location

filenameParserType

The filenameParser is used when writing files to a directory.

Content:	empty
Defined:	globally; see XML source
Used:	at 3 locations

globalEndpointType

Content:	complex, 18 attributes, attr. wildcard, 16 elements
Defined:	globally; see XML source
Used:	at 1 location

inboundEndpointType

Content:	complex, 17 attributes, attr. wildcard, 16 elements
Defined:	globally; see XML source
Used:	at 1 location

outboundEndpointType

Content:	complex, 12 attributes, attr. wildcard, 16 elements
Defined:	globally; see XML source
Used:	at 1 location

Attribute Group Summary

addressAttributes

Content:	1 attribute
Defined:	globally; see XML source
Includes:	definition of 1 attribute
Used:	at 3 locations

inboundAttributes

Content:	4 attributes
Defined:	globally; see XML source
Includes:	definitions of 4 attributes
Used:	at 3 locations

inboundEndpointAttributes

Content:	2 attributes
Defined:	globally; see XML source
Includes:	definitions of 2 attributes
Used:	at 2 locations

outboundAttributes

Content:	1 attribute
Defined:	globally; see XML source
Includes:	definition of 1 attribute
Used:	at 3 locations

XML Source

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.mulesoft.org/schema/mule/file" xmlns="http://www.mulesoft.org/schema/mule/file" xmlns:mule="http://www.mulesoft.org/schema/mule/core" xmlns:schemadoc="http://www.mulesoft.org/schema/mule/schemadoc" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:import namespace="http://www.w3.org/XML/1998/namespace"/>

<xsd:import namespace="http://www.mulesoft.org/schema/mule/core" schemaLocation="http://www.mulesoft.org/schema/mule/core/3.3/mule.xsd"/>

<xsd:import namespace="http://www.mulesoft.org/schema/mule/schemadoc" schemaLocation="http://www.mulesoft.org/schema/mule/schemadoc/3.3/mule-schemadoc.xsd"/>

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

<xsd:appinfo>

<schemadoc:short-name>File</schemadoc:short-name>

<schemadoc:page-title>File Transport</schemadoc:page-title>

<schemadoc:additional-documentation where="before-specific-elements">

h2. Filename Parsers

The filenameParser is set on the connector used when writing files to a directory. The parser will convert the outputPattern attribute to a string using the parser and the current message.

</schemadoc:additional-documentation>

<schemadoc:transport-features dispatchEvents="true" receiveEvents="true" requestEvents="true" streaming="true" transactions="false">

<schemadoc:MEPs default="one-way" supported="one-way"/>

</schemadoc:transport-features>

</xsd:appinfo>

</xsd:annotation>

<xsd:element name="connector" substitutionGroup="mule:abstract-connector" type="fileConnectorType">

<xsd:annotation>

<xsd:documentation>

The File connector configures the default behavior for File endpoints that reference the connector. If there is only one File connector configured, all file endpoints will use that connector.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:complexType name="fileConnectorType">

<xsd:complexContent>

<xsd:extension base="mule:connectorType">

<xsd:sequence maxOccurs="1" minOccurs="0">

<xsd:element ref="abstract-filenameParser"/>

</xsd:sequence>

<xsd:attributeGroup ref="inboundAttributes"/>

<xsd:attributeGroup ref="outboundAttributes"/>

<xsd:attribute name="writeToDirectory" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

The directory path where the file should be written on dispatch. This path is usually set as the endpoint of the dispatch event, however this allows you to explicitly force a single directory for the connector.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="readFromDirectory" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

The directory path where the file should be read from. This path is usually set as the inbound endpoint, however this allows you to explicitly force a single directory for the connector.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute default="true" name="autoDelete" type="mule:substitutableBoolean">

<xsd:annotation>

<xsd:documentation>

If set to true (the default), it will cause the file to be deleted once it is read. If streaming is turned on, this occurs when the InputStream for the file is closed. Otherwise the file will be read into memory and deleted immediately.

To access the java.io.File object set this property to false and specify a NoActionTransformer transformer for the connector. Mule will not delete the file, so it is up to the component to delete it when it is done. If the moveToDirectory is set, the file is first moved, then the File object of the moved file is passed to the component. It is recommended that a moveToDirectory is specified when turning autoDelete off.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute default="false" name="outputAppend" type="mule:substitutableBoolean">

<xsd:annotation>

<xsd:documentation>

Whether the output should be appended to the existing file. Default is false.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="serialiseObjects" type="mule:substitutableBoolean">

<xsd:annotation>

<xsd:documentation>

Determines whether objects should be serialized to the file. If false (the default), the raw bytes or text is written.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute default="true" name="streaming" type="mule:substitutableBoolean">

<xsd:annotation>

<xsd:documentation>

Whether a FileInputStream should be sent as the message payload (if true) or a byte array. (if false). The default is true.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="workDirectory" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

(As of Mule 2.1.4) The directory path where the file should be moved to prior to processing. The work directory must reside on the same file system as the read directory.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="workFileNamePattern" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

(As of Mule 2.1.4) The pattern to use when moving a file to a new location determined by the workDirectory property. You can use the patterns supported by the filename parser configured for this connector.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute default="false" name="recursive" type="mule:substitutableBoolean">

<xsd:annotation>

<xsd:documentation>

Whether to recurse or not when a directory is read

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

<xsd:element name="file-to-byte-array-transformer" substitutionGroup="mule:abstract-transformer" type="mule:abstractTransformerType">

<xsd:annotation>

<xsd:documentation>

The file-to-byte-array-transformer element configures a transformer that reads the contents of a java.io.File into a byte array (byte[]).

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="file-to-string-transformer" substitutionGroup="mule:abstract-transformer" type="mule:abstractTransformerType">

<xsd:annotation>

<xsd:documentation>

The file-to-string-transformer element configures a transformer that reads the contents of a java.io.File into a java.lang.String.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="filename-wildcard-filter" substitutionGroup="mule:abstract-filter" type="mule:wildcardFilterType">

<xsd:annotation>

<xsd:documentation>

The filename-wildcard-filter element configures a filter that can be used to restrict the files being processed by applying wildcard expressions to the filename. For example, you can read only .xml and .txt files by entering the following: <file:filename-wildcard-filter pattern="*.txt,*.xml"/>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="filename-regex-filter" substitutionGroup="mule:abstract-filter" type="mule:wildcardFilterType">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="inbound-endpoint" substitutionGroup="mule:abstract-inbound-endpoint" type="inboundEndpointType"/>

<xsd:complexType name="inboundEndpointType">

<xsd:complexContent>

<xsd:extension base="mule:inboundEndpointTypeWithoutExchangePattern">

<xsd:attributeGroup ref="addressAttributes"/>

<xsd:attributeGroup ref="inboundAttributes"/>

<xsd:attributeGroup ref="inboundEndpointAttributes"/>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

<xsd:element name="outbound-endpoint" substitutionGroup="mule:abstract-outbound-endpoint" type="outboundEndpointType"/>

<xsd:complexType name="outboundEndpointType">

<xsd:complexContent>

<xsd:extension base="mule:outboundEndpointTypeWithoutExchangePattern">

<xsd:attributeGroup ref="addressAttributes"/>

<xsd:attributeGroup ref="outboundAttributes"/>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

<xsd:element name="endpoint" substitutionGroup="mule:abstract-global-endpoint" type="globalEndpointType"/>

<xsd:complexType name="globalEndpointType">

<xsd:complexContent>

<xsd:extension base="mule:globalEndpointTypeWithoutExchangePattern">

<xsd:attributeGroup ref="addressAttributes"/>

<xsd:attributeGroup ref="inboundAttributes"/>

<xsd:attributeGroup ref="inboundEndpointAttributes"/>

<xsd:attributeGroup ref="outboundAttributes"/>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

<xsd:complexType name="filenameParserType">

<xsd:annotation>

<xsd:documentation>

The filenameParser is used when writing files to a directory. The parser will convert the outputPattern attribute to a string using the parser and the current message. The default implmentation used is SimpleFilenameParser.

</xsd:documentation>

</xsd:annotation>

</xsd:complexType>

<xsd:attributeGroup name="inboundAttributes">

<xsd:attribute name="pollingFrequency" type="mule:substitutableLong">

<xsd:annotation>

<xsd:documentation>

The frequency in milliseconds that the read directory should be checked (default is 0). Note that the read directory is specified by the endpoint of the listening component.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="fileAge" type="mule:substitutableLong">

<xsd:annotation>

<xsd:documentation>

Miniumum age (ms) for a file to be processed. This can be useful when consuming large files. It tells Mule to wait for a period of time before consuming the file, allowing the file to be completely written before the file is processed.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="moveToPattern" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

The pattern to use when moving a read file to a new location determined by the moveToDirectory property. This can use the patterns supported by the filename parser configured for this connector.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="moveToDirectory" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

The directory path where the file should be written after it has been read. If this is not set, the file is deleted after it has been read.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

</xsd:attributeGroup>

<xsd:attributeGroup name="inboundEndpointAttributes">

<xsd:attribute name="comparator" type="mule:substitutableClass">

<xsd:annotation>

<xsd:documentation>

Sorts incoming files using the specified comparator, such as comparator="org.mule.transport.file.comparator.OlderFirstComparator". The class must implement the java.util.Comparator interface.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="reverseOrder" type="mule:substitutableBoolean">

<xsd:annotation>

<xsd:documentation>

Whether the comparator order should be reversed. Default is false.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

</xsd:attributeGroup>

<xsd:attributeGroup name="outboundAttributes">

<xsd:attribute name="outputPattern" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

The pattern to use when writing a file to disk. This can use the patterns supported by the filename parser configured for this connector.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

</xsd:attributeGroup>

<xsd:attributeGroup name="addressAttributes">

<xsd:attribute name="path" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

A file directory location.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

</xsd:attributeGroup>

<xsd:element name="expression-filename-parser" substitutionGroup="abstract-filenameParser" type="expressionFilenameParserType">

<xsd:annotation>

<xsd:documentation>

The expression-filename-parser element configures the ExpressionFilenameParser, which can use any expression language supported by Mule to construct a file name for the current message. Expressions can be xpath, xquery, ognl, mvel, header, function, and more.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:complexType name="expressionFilenameParserType">

<xsd:complexContent>

<xsd:extension base="filenameParserType"/>

</xsd:complexContent>

</xsd:complexType>

<xsd:element name="custom-filename-parser" substitutionGroup="abstract-filenameParser" type="customFilenameParserType">

<xsd:annotation>

<xsd:documentation>

The custom-filename-parser element allows the user to specify a custom filename parser. The implementation must implement org.mule.transport.file.FilenameParser.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:complexType name="customFilenameParserType">

<xsd:complexContent>

<xsd:extension base="filenameParserType">

<xsd:attribute name="class" type="xsd:string" use="required">

<xsd:annotation>

<xsd:documentation>

The implementation class name that implements org.mule.transport.file.FilenameParser.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

<xsd:element abstract="true" name="abstract-filenameParser" type="filenameParserType">

<xsd:annotation>

<xsd:documentation>

The abstract-filenameParser element is a placeholder for filename parser elements. The filename parser is set on the connector used when writing files to a directory. The parser will convert the outputPattern attribute to a string using the parser and the current message. The default implmentation used is expression-filename-parser, but you can also specify a custom-filename-parser.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

</xsd:schema>

XML schema documentation generated with DocFlex/XML RE 1.8.5 using DocFlex/XML XSDDoc 2.5.0 template set. All content model diagrams generated by Altova XMLSpy via DocFlex/XML XMLSpy Integration.