Schema "mule-ftp.xsd"
Target Namespace:
http://www.mulesoft.org/schema/mule/ftp
Defined Components:
4 global elements, 4 complexTypes, 4 attribute groups
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
http://www.mulesoft.org/schema/mule/ftp/3.3/mule-ftp.xsd; see XML source
Imports Schemas (4):
mule-file.xsd [src], mule-schemadoc.xsd [src], mule.xsd [src], xml.xsd [src]
Imported by Schema:
_mule-all-included.xsd
Annotation
The FTP transport provides connectivity to FTP servers to allow files to be read and written as messages in Mule.
All Element Summary
connector The FTP connector is used to configure the default behavior for FTP endpoints that reference the connector.
Type:
ftpConnectorType
Content:
complex, 10 attributes, attr. wildcard, 7 elements
Subst.Gr:
may substitute for element mule:abstract-connector
Defined:
globally; see XML source
Used:
never
endpoint
Type:
globalEndpointType
Content:
complex, 19 attributes, attr. wildcard, 16 elements
Subst.Gr:
may substitute for element mule:abstract-global-endpoint
Defined:
globally; see XML source
Used:
never
inbound-endpoint
Type:
inboundEndpointType
Content:
complex, 18 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, 18 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
ftpConnectorType
Content:
complex, 10 attributes, attr. wildcard, 7 elements
Defined:
globally; see XML source
Includes:
definitions of 2 attributes, 1 element
Used:
at 1 location
globalEndpointType
Content:
complex, 19 attributes, attr. wildcard, 16 elements
Defined:
globally; see XML source
Used:
at 1 location
inboundEndpointType
Content:
complex, 18 attributes, attr. wildcard, 16 elements
Defined:
globally; see XML source
Used:
at 1 location
outboundEndpointType
Content:
complex, 18 attributes, attr. wildcard, 16 elements
Defined:
globally; see XML source
Used:
at 1 location
Attribute Group Summary
addressAttributes
Content:
5 attributes
Defined:
globally; see XML source
Includes:
definitions of 5 attributes
Used:
at 3 locations
commonAttributes
Content:
2 attributes
Defined:
globally; see XML source
Includes:
definitions of 2 attributes
Used:
at 4 locations
inboundAttributes
Content:
1 attribute
Defined:
globally; see XML source
Includes:
definition of 1 attribute
Used:
at 3 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/ftp" xmlns="http://www.mulesoft.org/schema/mule/ftp" xmlns:file="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/file" schemaLocation="http://www.mulesoft.org/schema/mule/file/3.3/mule-file.xsd"/>
<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>
The FTP transport provides connectivity to FTP servers to allow files to be read and written as messages in Mule.
</xsd:documentation>
<xsd:appinfo>
<schemadoc:short-name>FTP</schemadoc:short-name>
<schemadoc:page-title>FTP Transport</schemadoc:page-title>
<schemadoc:transport-features dispatchEvents="true" receiveEvents="true" requestEvents="true" retries="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="ftpConnectorType">
<xsd:annotation>
<xsd:documentation>
The FTP connector is used to configure the default behavior for FTP endpoints that reference the connector. If there is only one FTP connector configured, all FTP endpoints will use that connector.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="ftpConnectorType">
<xsd:complexContent>
<xsd:extension base="mule:connectorType">
<xsd:sequence maxOccurs="1" minOccurs="0">
<xsd:element ref="file:abstract-filenameParser">
<xsd:annotation>
<xsd:documentation>
The filenameParser is used when writing files to an FTP server. The parser will convert the outputPattern attribute to a string using the parser and the current message. To add a parser to your configuration, you import the "file" namespace into your XML configuration. For more information about filenameParsers, see the [File Transport Reference].
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attributeGroup ref="inboundAttributes"/>
<xsd:attributeGroup ref="outboundAttributes"/>
<xsd:attributeGroup ref="commonAttributes"/>
<xsd:attribute name="streaming" type="mule:substitutableBoolean">
<xsd:annotation>
<xsd:documentation>
Whether an InputStream should be sent as the message payload (if true) or a byte array (if false). Default is false.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="connectionFactoryClass" type="mule:substitutableClass">
<xsd:annotation>
<xsd:documentation>
A class that extends FtpConnectionFactory. The FtpConnectionFactory is responsible for creating a connection to the server using the credentials provided by the endpoint. The default implementation supplied with Mule uses the Commons Net project from Apache.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="inbound-endpoint" substitutionGroup="mule:abstract-inbound-endpoint" type="inboundEndpointType"/>
<xsd:complexType name="inboundEndpointType">
<xsd:complexContent>
<!--
The only valid exchange-pattern is one-way which is the default. No need to make
the exchange-pattern attribute configurable.
-->
<xsd:extension base="mule:inboundEndpointTypeWithoutExchangePattern">
<xsd:attributeGroup ref="addressAttributes"/>
<xsd:attributeGroup ref="commonAttributes"/>
<xsd:attributeGroup ref="inboundAttributes"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="outbound-endpoint" substitutionGroup="mule:abstract-outbound-endpoint" type="outboundEndpointType"/>
<xsd:complexType name="outboundEndpointType">
<xsd:complexContent>
<!--
The only valid exchange-pattern is one-way which is the default. No need to make
the exchange-pattern attribute configurable.
-->
<xsd:extension base="mule:outboundEndpointTypeWithoutExchangePattern">
<xsd:attributeGroup ref="addressAttributes"/>
<xsd:attributeGroup ref="commonAttributes"/>
<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>
<!--
The only valid exchange-pattern is one-way which is the default. No need to make
the exchange-pattern attribute configurable.
-->
<xsd:extension base="mule:globalEndpointTypeWithoutExchangePattern">
<xsd:attributeGroup ref="addressAttributes"/>
<xsd:attributeGroup ref="commonAttributes"/>
<xsd:attributeGroup ref="inboundAttributes"/>
<xsd:attributeGroup ref="outboundAttributes"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:attributeGroup name="inboundAttributes">
<xsd:attribute name="pollingFrequency" type="mule:substitutableLong">
<xsd:annotation>
<xsd:documentation>
How frequently in milliseconds to check the read directory. Note that the read directory is specified by the endpoint of the listening component.
</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="commonAttributes">
<xsd:attribute name="binary" type="mule:substitutableBoolean">
<xsd:annotation>
<xsd:documentation>
Select/disable binary file transfer type. Default is true.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="passive" type="mule:substitutableBoolean">
<xsd:annotation>
<xsd:documentation>
Select/disable passive protocol (more likely to work through firewalls). Default is true.
</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 location on the remote server.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="user" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
If FTP is authenticated, this is the username used for authenitcation.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="password" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
The password for the user being authenticated.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="host" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
An IP address (such as www.mulesoft.com, localhost, or 192.168.0.1).
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="port" type="mule:substitutablePortNumber">
<xsd:annotation>
<xsd:documentation>
The port number to connect on.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:attributeGroup>
</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.