rvicemix.servicemix-ftp.3.2.1.source-code.servicemix-ftp.xsd.wiki Maven / Gradle / Ivy

Go to download
h3. Elements By Type
{anchor:org.apache.servicemix.ftp.FtpEndpointType-types}
h4. The _[org.apache.servicemix.ftp.FtpEndpointType|#org.apache.servicemix.ftp.FtpEndpointType-types]_ Type Implementations
    | _[|#poller-element]_ | {html}A polling endpoint which looks for a file or files in a directory
and sends the files into the JBI bus as messages, deleting the files
by default when they are processed.{html} |
    | _[|#sender-element]_ | {html}An FTP endpoint{html} |

{anchor:org.apache.servicemix.common.DefaultComponent-types}
h4. The _[org.apache.servicemix.common.DefaultComponent|#org.apache.servicemix.common.DefaultComponent-types]_ Type Implementations
    | _[|#component-element]_ | {html}FTP Component{html} |

{anchor:org.apache.servicemix.ftp.FTPClientPool-types}
h4. The _[org.apache.servicemix.ftp.FTPClientPool|#org.apache.servicemix.ftp.FTPClientPool-types]_ Type Implementations
    | _[|#pool-element]_ | {html}A pool of FTP clients for
the Jakarta Commons Net library{html} |

{anchor:org.apache.servicemix.ftp.FtpComponent-types}
h4. The _[org.apache.servicemix.ftp.FtpComponent|#org.apache.servicemix.ftp.FtpComponent-types]_ Type Implementations
    | _[|#component-element]_ | {html}FTP Component{html} |


{anchor:component-element}
h3. The _[|#component-element]_ Element
    {html}FTP Component{html}
h4. Properties
    || Property Name || Type || Description ||
    | endpoints | (_[org.apache.servicemix.ftp.FtpEndpointType|#org.apache.servicemix.ftp.FtpEndpointType-types]_)\* | {html}{html} |

{anchor:poller-element}
h3. The _[|#poller-element]_ Element
    {html}A polling endpoint which looks for a file or files in a directory
and sends the files into the JBI bus as messages, deleting the files
by default when they are processed.{html}
h4. Properties
    || Property Name || Type || Description ||
    | clientPool | _[org.apache.servicemix.ftp.FTPClientPool|#org.apache.servicemix.ftp.FTPClientPool-types]_ | {html}{html} |
    | component | _[org.apache.servicemix.common.DefaultComponent|#org.apache.servicemix.common.DefaultComponent-types]_ | {html}{html} |
    | definition | _javax.wsdl.Definition_ | {html}{html} |
    | delay | _long_ | {html}{html} |
    | deleteFile | _boolean_ | {html}Returns whether or not we should delete the file when its processed{html} |
    | description | _org.w3c.dom.Document_ | {html}{html} |
    | endpoint | _java.lang.String_ | {html}{html} |
    | filter | _java.io.FileFilter_ | {html}Sets the optional filter to choose which files to process{html} |
    | firstTime | _java.util.Date_ | {html}{html} |
    | interfaceName | _javax.xml.namespace.QName_ | {html}{html} |
    | marshaler | _org.apache.servicemix.components.util.FileMarshaler_ | {html}{html} |
    | period | _long_ | {html}{html} |
    | recursive | _boolean_ | {html}{html} |
    | scheduler | _org.apache.servicemix.components.varscheduler.Scheduler_ | {html}{html} |
    | service | _javax.xml.namespace.QName_ | {html}{html} |
    | serviceUnit | _org.apache.servicemix.common.ServiceUnit_ | {html}{html} |
    | targetEndpoint | _java.lang.String_ | {html}{html} |
    | targetInterface | _javax.xml.namespace.QName_ | {html}{html} |
    | targetOperation | _javax.xml.namespace.QName_ | {html}{html} |
    | targetService | _javax.xml.namespace.QName_ | {html}{html} |
    | targetUri | _java.lang.String_ | {html}{html} |
    | uri | _java.net.URI_ | {html}{html} |

{anchor:pool-element}
h3. The _[|#pool-element]_ Element
    {html}A pool of FTP clients for
the Jakarta Commons Net library{html}
h4. Properties
    || Property Name || Type || Description ||
    | address | _java.net.InetAddress_ | {html}{html} |
    | binaryMode | _boolean_ | {html}{html} |
    | config | _org.apache.commons.net.ftp.FTPClientConfig_ | {html}{html} |
    | controlEncoding | _java.lang.String_ | {html}{html} |
    | dataTimeout | _int_ | {html}{html} |
    | host | _java.lang.String_ | {html}{html} |
    | localAddress | _java.net.InetAddress_ | {html}{html} |
    | localPort | _int_ | {html}{html} |
    | passiveMode | _boolean_ | {html}{html} |
    | password | _java.lang.String_ | {html}{html} |
    | pool | _org.apache.commons.pool.ObjectPool_ | {html}{html} |
    | port | _int_ | {html}{html} |
    | username | _java.lang.String_ | {html}{html} |

{anchor:sender-element}
h3. The _[|#sender-element]_ Element
    {html}An FTP endpoint{html}
h4. Properties
    || Property Name || Type || Description ||
    | clientPool | _[org.apache.servicemix.ftp.FTPClientPool|#org.apache.servicemix.ftp.FTPClientPool-types]_ | {html}{html} |
    | component | _[org.apache.servicemix.ftp.FtpComponent|#org.apache.servicemix.ftp.FtpComponent-types]_ | {html}{html} |
    | definition | _javax.wsdl.Definition_ | {html}{html} |
    | description | _org.w3c.dom.Document_ | {html}{html} |
    | endpoint | _java.lang.String_ | {html}{html} |
    | interfaceName | _javax.xml.namespace.QName_ | {html}{html} |
    | marshaler | _org.apache.servicemix.components.util.FileMarshaler_ | {html}{html} |
    | overwrite | _boolean_ | {html}{html} |
    | service | _javax.xml.namespace.QName_ | {html}{html} |
    | serviceUnit | _org.apache.servicemix.common.ServiceUnit_ | {html}{html} |
    | uniqueFileName | _java.lang.String_ | {html}Sets the name used to make a unique name if no file name is available on the message.{html} |
    | uploadSuffix | _java.lang.String_ | {html}Set the file name suffix used during upload. The suffix will be automatically removed as soon as the upload has completed.
This allows other processes to discern completed files from files that are being uploaded.{html} |
    | uri | _java.net.URI_ | {html}Configures the endpoint from a URI{html} |

h3. Element Index
    | _[|#component-element]_ | {html}FTP Component{html} |
    | _[|#poller-element]_ | {html}A polling endpoint which looks for a file or files in a directory
and sends the files into the JBI bus as messages, deleting the files
by default when they are processed.{html} |
    | _[|#pool-element]_ | {html}A pool of FTP clients for
the Jakarta Commons Net library{html} |
    | _[|#sender-element]_ | {html}An FTP endpoint{html} |