complexType "fileConnectorType"

Namespace:	http://www.mulesoft.org/schema/mule/file
Content:	complex, 18 attributes, attr. wildcard, 7 elements
Defined:	globally in mule-file.xsd; see XML source
Includes:	definitions of 9 attributes, 1 element
Used:	at 1 location

Content Model Diagram

XML Representation Summary

<...

name	=	(xsd:string \| xsd:NMTOKEN)
dynamicNotification	=	(xsd:string \| xsd:boolean) : "false"
validateConnections	=	(xsd:string \| xsd:boolean) : "true"
dispatcherPoolFactory-ref	=	xsd:string
pollingFrequency	=	(xsd:string \| xsd:long)
fileAge	=	(xsd:string \| xsd:long)
moveToPattern	=	xsd:string
moveToDirectory	=	xsd:string
outputPattern	=	xsd:string
writeToDirectory	=	xsd:string
readFromDirectory	=	xsd:string
autoDelete	=	(xsd:string \| xsd:boolean) : "true"
outputAppend	=	(xsd:string \| xsd:boolean) : "false"
serialiseObjects	=	(xsd:string \| xsd:boolean)
streaming	=	(xsd:string \| xsd:boolean) : "true"
workDirectory	=	xsd:string
workFileNamePattern	=	xsd:string
recursive	=	(xsd:string \| xsd:boolean) : "false"

{any attribute with non-schema namespace}

Content:

mule:annotations?, spring:property*, mule:receiver-threading-profile?, mule:dispatcher-threading-profile?, mule:abstract-reconnection-strategy?, mule:service-overrides?, abstract-filenameParser?

</...>

Content Model Elements (7):

abstract-filenameParser, mule:abstract-reconnection-strategy, mule:annotations, mule:dispatcher-threading-profile, mule:receiver-threading-profile, mule:service-overrides, spring:property

All Direct / Indirect Based Elements (1):

connector

Known Usage Locations

As direct type of elements (1):
connector

Type Definition Detail

Type Derivation Tree

mule:annotatedType (extension)

mule:abstractConnectorType (extension)

mule:connectorType (extension)

fileConnectorType

XML Source (w/o annotations (9); see within schema source)

<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:attribute name="readFromDirectory" type="xsd:string"/>

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

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

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

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

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

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

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

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

Attribute Detail (all declarations; defined within this component only; 9/19)

autoDelete

Type:	mule:substitutableBoolean
Use:	optional

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.

Attribute Value

xsd:string | xsd:boolean

Default:

"true"

XML Source (w/o annotations (1); see within schema source)

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

outputAppend

Type:	mule:substitutableBoolean
Use:	optional

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

Attribute Value

xsd:string | xsd:boolean

Default:

"false"

XML Source (w/o annotations (1); see within schema source)

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

readFromDirectory

Type:	xsd:string, predefined
Use:	optional

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.

XML Source (w/o annotations (1); see within schema source)

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

recursive

Type:	mule:substitutableBoolean
Use:	optional

Whether to recurse or not when a directory is read

Attribute Value

xsd:string | xsd:boolean

Default:

"false"

XML Source (w/o annotations (1); see within schema source)

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

serialiseObjects

Type:	mule:substitutableBoolean
Use:	optional

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

Attribute Value

xsd:string | xsd:boolean

XML Source (w/o annotations (1); see within schema source)

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

streaming

Type:	mule:substitutableBoolean
Use:	optional

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

Attribute Value

xsd:string | xsd:boolean

Default:

"true"

XML Source (w/o annotations (1); see within schema source)

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

workDirectory

Type:	xsd:string, predefined
Use:	optional

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

XML Source (w/o annotations (1); see within schema source)

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

workFileNamePattern

Type:	xsd:string, predefined
Use:	optional

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

XML Source (w/o annotations (1); see within schema source)

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

writeToDirectory

Type:	xsd:string, predefined
Use:	optional

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.

XML Source (w/o annotations (1); see within schema source)

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

Content Element Detail (all declarations; defined within this component only; 1/7)

abstract-filenameParser

Type:	filenameParserType, empty content
Abstract:	(may not be used directly in instance XML documents)
Subst.Gr:	may be substituted with 2 elements

XML Source (see within schema source)

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

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.