rvicemix.servicemix-truezip.2011.01.source-code.servicemix-truezip.xsd.wiki Maven / Gradle / Ivy

Go to download
h3. Elements By Type
{anchor:org.apache.servicemix.truezip.TrueZipComponent-types}
h4. The _[org.apache.servicemix.truezip.TrueZipComponent|#org.apache.servicemix.truezip.TrueZipComponent-types]_ Type Implementations
    | _[|#component-element]_ | {html}File Component{html} |

{anchor:org.apache.servicemix.truezip.TrueZipEndpointType-types}
h4. The _[org.apache.servicemix.truezip.TrueZipEndpointType|#org.apache.servicemix.truezip.TrueZipEndpointType-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 endpoint which receives a message and writes the content to a file.{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}File Component{html} |


{anchor:component-element}
h3. The _[|#component-element]_ Element
    {html}File Component{html}
h4. Properties
    || Property Name || Type || Description ||
    | endpoints | (_[org.apache.servicemix.truezip.TrueZipEndpointType|#org.apache.servicemix.truezip.TrueZipEndpointType-types]_)\* | {html}{html} |
    | executorFactory | _org.apache.servicemix.executors.ExecutorFactory_ | {html}The executor factory to use to create the executor.
If none is provided, one will be retrieved from the JBI container when the component
is deployed into ServiceMix 3.x, or a default implementation will be used.{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 ||
    | autoCreateDirectory | _boolean_ | {html}{html} |
    | component | _[org.apache.servicemix.common.DefaultComponent|#org.apache.servicemix.common.DefaultComponent-types]_ | {html}{html} |
    | concurrentPolling | _boolean_ | {html}Sets whether more than one poll can be active at a time (true means yes). Default value is false.{html} |
    | delay | _long_ | {html}Sets the amount of time in milliseconds that the endpoint should wait before making the first poll.{html} |
    | deleteFile | _boolean_ | {html}Returns whether or not we should delete the file when its processed{html} |
    | endpoint | _java.lang.String_ | {html}The name of the endpoint.{html} |
    | file | _java.io.File_ | {html}Sets the file to poll, which can be a directory or a file.{html} |
    | filter | _java.io.FileFilter_ | {html}Sets the optional filter to choose which files to process{html} |
    | firstTime | _java.util.Date_ | {html}Sets the date on which the first poll will be executed. If a delay is
also set using setDelay, the delay interval will be added
after the date specified.{html} |
    | interfaceName | _javax.xml.namespace.QName_ | {html}The qualified name of the interface exposed by the endpoint.{html} |
    | lockManager | _org.apache.servicemix.common.locks.LockManager_ | {html}{html} |
    | marshaler | _org.apache.servicemix.components.util.FileMarshaler_ | {html}{html} |
    | period | _long_ | {html}Sets the number of milliseconds between polling attempts.{html} |
    | recursive | _boolean_ | {html}{html} |
    | scheduler | _org.apache.servicemix.common.scheduler.Scheduler_ | {html}Set a custom Scheduler implementation if you need more fine-grained control over the polling schedule.{html} |
    | service | _javax.xml.namespace.QName_ | {html}The qualified name of the service the endpoint exposes.{html} |
    | serviceUnit | _org.apache.servicemix.common.ServiceUnit_ | {html}{html} |
    | targetEndpoint | _java.lang.String_ | {html}the name of the endpoint to which requests are sent{html} |
    | targetInterface | _javax.xml.namespace.QName_ | {html}the QName of the interface to which requests are sent{html} |
    | targetOperation | _javax.xml.namespace.QName_ | {html}the QName of the operation to which requests are sent{html} |
    | targetService | _javax.xml.namespace.QName_ | {html}the QName of the service to which requests are sent{html} |
    | targetUri | _java.lang.String_ | {html}Set the target service/endpoint/interface using a URI.{html} |

{anchor:sender-element}
h3. The _[|#sender-element]_ Element
    {html}An endpoint which receives a message and writes the content to a file.{html}
h4. Properties
    || Property Name || Type || Description ||
    | autoCreateDirectory | _boolean_ | {html}{html} |
    | component | _[org.apache.servicemix.truezip.TrueZipComponent|#org.apache.servicemix.truezip.TrueZipComponent-types]_ | {html}{html} |
    | directory | _java.io.File_ | {html}{html} |
    | endpoint | _java.lang.String_ | {html}The name of the endpoint.{html} |
    | interfaceName | _javax.xml.namespace.QName_ | {html}The qualified name of the interface exposed by the endpoint.{html} |
    | marshaler | _org.apache.servicemix.components.util.FileMarshaler_ | {html}{html} |
    | service | _javax.xml.namespace.QName_ | {html}The qualified name of the service the endpoint exposes.{html} |
    | tempFilePrefix | _java.lang.String_ | {html}{html} |
    | tempFileSuffix | _java.lang.String_ | {html}{html} |

h3. Element Index
    | _[|#component-element]_ | {html}File 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} |
    | _[|#sender-element]_ | {html}An endpoint which receives a message and writes the content to a file.{html} |