INT-3418: xsd-2.2 -> 3.0
This commit is contained in:
Artem Bilan
@@ -1,565 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<xsd:schema xmlns="http://www.springframework.org/schema/integration/file"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:beans="http://www.springframework.org/schema/beans"
|
||||
xmlns:tool="http://www.springframework.org/schema/tool"
|
||||
xmlns:integration="http://www.springframework.org/schema/integration"
|
||||
targetNamespace="http://www.springframework.org/schema/integration/file"
|
||||
elementFormDefault="qualified"
|
||||
attributeFormDefault="unqualified">
|
||||
|
||||
<xsd:import namespace="http://www.springframework.org/schema/beans"/>
|
||||
<xsd:import namespace="http://www.springframework.org/schema/integration"
|
||||
schemaLocation="http://www.springframework.org/schema/integration/spring-integration-2.2.xsd"/>
|
||||
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Defines the configuration elements for Spring Integration File Adapters.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
|
||||
<xsd:element name="inbound-channel-adapter">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Configures an inbound Channel Adapter that polls a directory and sends Messages whose payloads are
|
||||
instances of java.io.File.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
<xsd:sequence>
|
||||
<xsd:choice minOccurs="0" maxOccurs="1" >
|
||||
<xsd:sequence>
|
||||
<xsd:element ref="integration:poller" />
|
||||
<xsd:choice minOccurs="0" maxOccurs="1">
|
||||
<xsd:element ref="locker"/>
|
||||
<xsd:element ref="nio-locker"/>
|
||||
</xsd:choice>
|
||||
</xsd:sequence>
|
||||
<xsd:sequence>
|
||||
<xsd:choice>
|
||||
<xsd:element ref="locker"/>
|
||||
<xsd:element ref="nio-locker"/>
|
||||
</xsd:choice>
|
||||
<xsd:element ref="integration:poller" minOccurs="0" maxOccurs="1"/>
|
||||
</xsd:sequence>
|
||||
</xsd:choice>
|
||||
</xsd:sequence>
|
||||
<xsd:attribute name="id" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Identifies the underlying Spring bean definition (SourcePollingChannelAdapter)
|
||||
|
||||
Keep in mind that if no "channel" attribute is defined, then the "id" attribute is required.
|
||||
In that case the "id" attribute's value will be used as the channel name and ".adapter" will be
|
||||
appended to the "id" value of the underlying bean definition.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="channel" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Defines the message channel to which the payload shall be forwarded to.
|
||||
|
||||
Keep in mind that any Channel Adapter can be created without a "channel" reference in which case
|
||||
it will implicitly create an instance of DirectChannel. The created channel's name will match
|
||||
the "id" attribute of the <inbound-channel-adapter/> element. Therefore, if the "channel" attribute
|
||||
is not provided, then the "id" attribute is required.
|
||||
]]></xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.MessageChannel"/>
|
||||
</tool:annotation>
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="directory" type="xsd:string" use="required">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Specifies the input directory (The directory to poll from) e.g.:
|
||||
directory="file:/absolute/input" or directory="file:relative/input"]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="comparator" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Specify a Comparator to be used when ordering Files. If none is provided, the
|
||||
order will be determined by the java.io.File implementation of Comparable. MUTUALLY EXCLUSIVE with queue-size.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="filter" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Specify a FileListFilter to be used. By default, an AcceptOnceFileListFilter is used,
|
||||
which ensures files are picked up only once from the directory.
|
||||
|
||||
You can also apply multiple filters by referencing a CompositeFileListFilter.
|
||||
]]></xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.file.filters.FileListFilter"/>
|
||||
</tool:annotation>
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="filename-pattern" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Only files matching this ant style path will be picked up by this adapter. Note that
|
||||
in Spring Integration 1.0 this attribute accepted a regular expression, but from 2.0
|
||||
filename-regex should be used for that purpose instead.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="filename-regex" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Only files matching this regular expression will be picked up by this adapter.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="scanner" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Reference to a custom DirectoryScanner implementation.]]></xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type
|
||||
type="org.springframework.integration.file.DirectoryScanner"/>
|
||||
</tool:annotation>
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="prevent-duplicates" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
A boolean flag indicating whether duplicates should be prevented. If a 'filter' reference is
|
||||
provided, duplicate prevention will not be enabled by default (the assumption is that the
|
||||
provided filter is sufficient), but setting this to true will enable it. If a 'filename-pattern'
|
||||
is provided, duplicate prevention will be enabled by default (preceding the pattern matching),
|
||||
but setting this to false will disable it. If neither 'filter' or 'filename-pattern' is provided,
|
||||
duplicate prevention is enabled by default, but setting this to false will disable it. For more
|
||||
detail on the actual duplicate prevention, see the javadoc for AcceptOnceFileListFilter.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="auto-startup" type="xsd:string" default="true">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Lifecycle attribute signaling if this component should be started during Application Context startup.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="auto-create-directory" type="xsd:string" default="true">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Specify whether to automatically create the source directory if it does not yet exist when this
|
||||
adapter is being initialized. The default value is 'true'. If set to 'false' and the directory
|
||||
does not exist upon initialization, an Exception will be thrown.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="queue-size" type="xsd:integer">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Specify the maximum number of files stored in memory by the underlying FileReadingMessageSource.
|
||||
This is useful to limit the memory footprint of this endpoint. Using a stateful filter would counter
|
||||
this benefit, so AcceptOnceFileListFilter is not used when this attribute is specified.
|
||||
MUTUALLY EXCLUSIVE with comparator, if comparator is set this attribute will be ignored.
|
||||
MUTUALLY EXCLUSIVE with stateful filtering.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
<xsd:element name="outbound-channel-adapter">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Configures an outbound Channel Adapter that writes Message payloads to a File.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
<xsd:complexContent>
|
||||
<xsd:extension base="outboundFileBaseType">
|
||||
<xsd:attribute name="channel" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>The channel through which outgoing messages will arrive.</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.MessageChannel"/>
|
||||
</tool:annotation>
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:extension>
|
||||
</xsd:complexContent>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
<xsd:element name="outbound-gateway">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Configures an outbound Gateway that writes request Message payloads to a File and then generates a
|
||||
reply Message containing the newly written File as its payload.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
<xsd:complexContent>
|
||||
<xsd:extension base="outboundFileBaseType">
|
||||
<xsd:attribute name="request-channel" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>The channel through which outgoing messages will arrive.</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.MessageChannel"/>
|
||||
</tool:annotation>
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="reply-channel" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[After writing the File, it will be sent to the specified reply channel as the payload of a Message.
|
||||
Another way of providing the 'reply-channel' is by setting the MessageHeaders.REPLY_CHANNEL Message Header]]>
|
||||
</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.MessageChannel"/>
|
||||
</tool:annotation>
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="reply-timeout" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Allows you to specify how long this gateway will wait for
|
||||
the reply message to be sent successfully to the reply channel
|
||||
before throwing an exception. This attribute only applies when the
|
||||
channel might block, for example when using a bounded queue channel that
|
||||
is currently full.
|
||||
|
||||
Also, keep in mind that when sending to a DirectChannel, the
|
||||
invocation will occur in the sender's thread. Therefore,
|
||||
the failing of the send operation may be caused by other
|
||||
components further downstream.
|
||||
|
||||
The "reply-timeout" attribute maps to the "sendTimeout" property of the
|
||||
underlying 'MessagingTemplate' instance (org.springframework.integration.core.MessagingTemplate).
|
||||
|
||||
The attribute will default, if not specified, to '-1', meaning that
|
||||
by default, the Gateway will wait indefinitely. The value is
|
||||
specified in milliseconds.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:extension>
|
||||
</xsd:complexContent>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
<xsd:complexType name="outboundFileBaseType">
|
||||
<xsd:choice minOccurs="0" maxOccurs="2">
|
||||
<xsd:element ref="integration:poller" minOccurs="0" maxOccurs="1"/>
|
||||
<xsd:element name="request-handler-advice-chain" type="integration:adviceChainType" minOccurs="0" maxOccurs="1" />
|
||||
</xsd:choice>
|
||||
<xsd:attribute name="id" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Identifies the underlying Spring bean definition (EventDrivenConsumer)]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="directory" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Specifies the output directory, e.g.:
|
||||
directory="file:/absolute/output" or directory="file:relative/output"
|
||||
Either this attribute or 'directory-expression' must be provided.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="directory-expression" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Specifies the output directory using a SpEL expression.
|
||||
This allows you to dynamically specify the output directory
|
||||
on a per message basis. For example a message header or payload
|
||||
property can be used for specifying the destination directory
|
||||
at runtime.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="filename-generator" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Allows you to provide a reference to the FileNameGenerator strategy
|
||||
to use when generating the destination file's name. If not specified the
|
||||
DefaultFileNameGenerator is used.]]>
|
||||
</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.file.FileNameGenerator"/>
|
||||
</tool:annotation>
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="filename-generator-expression" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Allows you to provide a SpEL expression which will compute the file name of
|
||||
the target file (e.g., assuming payload is java.io.File "payload.name + '.transferred'");
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="temporary-file-suffix" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Extension used when uploading files. We change it after we know it's uploaded.
|
||||
This attribute is mutualy exclusive with 'append' since the append is done to the
|
||||
actual file and not its temporary counterpart. The default value of this attribute (i.e., .writing)
|
||||
is ignored when 'append' is set to true.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="mode">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
This attribute defaults to 'REPLACE' if not set explicitly.
|
||||
|
||||
The following options are available:
|
||||
|
||||
APPEND:
|
||||
|
||||
If append is specified, the data will be appended
|
||||
to the existing file if such file exists, otherwise the
|
||||
new file will be created as usual but once created the
|
||||
subsequent data will be appended to it. This attribute
|
||||
is mutualy exclusive with the 'temporary-file-suffix'
|
||||
since append is done to the actual file and not its
|
||||
temporary counterpart.
|
||||
|
||||
If set to APPEND, the component will also create a real
|
||||
instance of the LockRegistry to ensure that there are no
|
||||
collisions when multiple threads are writing to the same
|
||||
file.
|
||||
|
||||
FAIL:
|
||||
|
||||
If the target file exists, a MessageHandlingException
|
||||
is thrown.
|
||||
|
||||
IGNORE:
|
||||
|
||||
If the target file exists, the message payload is silently
|
||||
ignored.
|
||||
|
||||
REPLACE:
|
||||
|
||||
This is the default behavior when writing files. If the
|
||||
target file already exists, it will be overwritten.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:simpleType>
|
||||
<xsd:union memberTypes="mode xsd:string"/>
|
||||
</xsd:simpleType>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="delete-source-files" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Specify whether to delete source files after writing to the destination directory.
|
||||
This will take effect if the Message payload is the actual source File instance
|
||||
or if the original File instance (or its path) is available in the header value
|
||||
associated with the FileHeaders.ORIGINAL_FILE constant. The default value is false.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="order" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Specifies the order for invocation when this endpoint is connected as a
|
||||
subscriber to a SubscribableChannel.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="auto-create-directory" type="xsd:string" default="true">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Specify whether to automatically create the destination directory if it does not yet exist when this
|
||||
adapter is being initialized. The default value is 'true'. If set to 'false' and the directory does
|
||||
not exist upon initialization, an Exception will be thrown.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="auto-startup" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Lifecycle attribute signaling if this component should be started during Application Context startup.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="charset" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Set the charset name to use when writing a File from a String-based
|
||||
Message payload, e.g. charset="UTF-8". If not set, the default charset of this
|
||||
Java virtual machine is used.
|
||||
]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:complexType>
|
||||
|
||||
<xsd:element name="file-to-string-transformer">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Creates a Transformer that converts a File payload to a String.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
<xsd:complexContent>
|
||||
<xsd:extension base="transformerType">
|
||||
<xsd:attribute name="charset" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Set the charset name to use when converting a File
|
||||
payload to a String, e.g. charset="UTF-8". If not set, the default charset of this
|
||||
Java virtual machine is used.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:extension>
|
||||
</xsd:complexContent>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
<xsd:element name="file-to-bytes-transformer">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Creates a Transformer that converts a File payload to an array of bytes.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
<xsd:complexContent>
|
||||
<xsd:extension base="transformerType"/>
|
||||
</xsd:complexContent>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
<xsd:complexType name="transformerType">
|
||||
<xsd:attribute name="id" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Identifies the underlying Spring bean definition (EventDrivenConsumer)]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="input-channel" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[The input channel of the transformer.]]>
|
||||
</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.MessageChannel"/>
|
||||
</tool:annotation>
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="output-channel" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[The channel to which the transformer will send the transformed message.
|
||||
Optional, because incoming messages can specify a reply channel using the 'replyChannel'
|
||||
message header value themselves.]]>
|
||||
</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.MessageChannel"/>
|
||||
</tool:annotation>
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="delete-files" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[The delete-files option signals to the transformer that it should delete the
|
||||
inbound File after the transformation is complete.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:complexType>
|
||||
|
||||
<xsd:element name="locker">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[When multiple processes are reading from the same
|
||||
directory it can be desirable to lock files to prevent them
|
||||
from being picked up concurrently. To do this you can specify a reference to a FileLocker.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
<xsd:attribute name="ref" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[The reference to the FileLocker.]]>
|
||||
</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.file.FileLocker"/>
|
||||
</tool:annotation>
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
<xsd:element name="nio-locker">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[When multiple processes are reading from the same directory
|
||||
it can be desirable to lock files to prevent them from being picked up
|
||||
concurrently. This is a java.nio based implementation available out of the box.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:element>
|
||||
|
||||
<xsd:simpleType name="mode">
|
||||
<xsd:restriction base="xsd:token">
|
||||
<xsd:enumeration value="REPLACE">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
This is the default behavior when writing files. If the
|
||||
target file already exists, it will be overwritten.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:enumeration>
|
||||
<xsd:enumeration value="APPEND">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
If append is specified, the data will be appended
|
||||
to the existing file if such file exists, otherwise the
|
||||
new file will be created as usual but once created the
|
||||
subsequent data will be appended to it. This attribute
|
||||
is mutualy exclusive with the 'temporary-file-suffix'
|
||||
since append is done to the actual file and not its
|
||||
temporary counterpart.
|
||||
|
||||
If set to APPEND, the component will also create a real
|
||||
instance of the LockRegistry to ensure that there are no
|
||||
collisions when multiple threads are writing to the same
|
||||
file.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:enumeration>
|
||||
<xsd:enumeration value="FAIL">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
If the target file exists, a MessageHandlingException
|
||||
is thrown.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:enumeration>
|
||||
<xsd:enumeration value="IGNORE">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
If the target file exists, the message payload is silently
|
||||
ignored.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:enumeration>
|
||||
</xsd:restriction>
|
||||
</xsd:simpleType>
|
||||
|
||||
</xsd:schema>
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
<xsd:import namespace="http://www.springframework.org/schema/beans"/>
|
||||
<xsd:import namespace="http://www.springframework.org/schema/integration"
|
||||
schemaLocation="http://www.springframework.org/schema/integration/spring-integration-2.1.xsd"/>
|
||||
schemaLocation="http://www.springframework.org/schema/integration/spring-integration-2.2.xsd"/>
|
||||
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
@@ -47,7 +47,7 @@
|
||||
<xsd:attribute name="id" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Identifies the underlying Spring bean definition (SourcePollingChannelAdapter)
|
||||
|
||||
|
||||
Keep in mind that if no "channel" attribute is defined, then the "id" attribute is required.
|
||||
In that case the "id" attribute's value will be used as the channel name and ".adapter" will be
|
||||
appended to the "id" value of the underlying bean definition.
|
||||
@@ -57,9 +57,9 @@
|
||||
<xsd:attribute name="channel" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Defines the message channel to which the payload shall be forwarded to.
|
||||
|
||||
Keep in mind that any Channel Adapter can be created without a "channel" reference in which case
|
||||
it will implicitly create an instance of DirectChannel. The created channel's name will match
|
||||
|
||||
Keep in mind that any Channel Adapter can be created without a "channel" reference in which case
|
||||
it will implicitly create an instance of DirectChannel. The created channel's name will match
|
||||
the "id" attribute of the <inbound-channel-adapter/> element. Therefore, if the "channel" attribute
|
||||
is not provided, then the "id" attribute is required.
|
||||
]]></xsd:documentation>
|
||||
@@ -74,7 +74,7 @@
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Specifies the input directory (The directory to poll from) e.g.:
|
||||
directory="file:/absolute/input" or directory="file:relative/input"]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="comparator" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
@@ -87,11 +87,11 @@
|
||||
<xsd:attribute name="filter" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Specify a FileListFilter to be used. By default, an AcceptOnceFileListFilter is used,
|
||||
Specify a FileListFilter to be used. By default, an AcceptOnceFileListFilter is used,
|
||||
which ensures files are picked up only once from the directory.
|
||||
|
||||
|
||||
You can also apply multiple filters by referencing a CompositeFileListFilter.
|
||||
]]></xsd:documentation>
|
||||
]]></xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.file.filters.FileListFilter"/>
|
||||
@@ -144,7 +144,7 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:documentation>
|
||||
Lifecycle attribute signaling if this component should be started during Application Context startup.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="auto-create-directory" type="xsd:string" default="true">
|
||||
<xsd:annotation>
|
||||
@@ -174,7 +174,7 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:documentation>
|
||||
Configures an outbound Channel Adapter that writes Message payloads to a File.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
<xsd:complexContent>
|
||||
<xsd:extension base="outboundFileBaseType">
|
||||
@@ -199,11 +199,11 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
Configures an outbound Gateway that writes request Message payloads to a File and then generates a
|
||||
reply Message containing the newly written File as its payload.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
<xsd:complexContent>
|
||||
<xsd:extension base="outboundFileBaseType">
|
||||
<xsd:attribute name="request-channel" type="xsd:string" use="required">
|
||||
<xsd:attribute name="request-channel" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>The channel through which outgoing messages will arrive.</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
@@ -216,7 +216,7 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:attribute name="reply-channel" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[After writing the File, it will be sent to the specified reply channel as the payload of a Message.
|
||||
<![CDATA[After writing the File, it will be sent to the specified reply channel as the payload of a Message.
|
||||
Another way of providing the 'reply-channel' is by setting the MessageHeaders.REPLY_CHANNEL Message Header]]>
|
||||
</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
@@ -226,33 +226,71 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
</xsd:appinfo>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="reply-timeout" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Allows you to specify how long this gateway will wait for
|
||||
the reply message to be sent successfully to the reply channel
|
||||
before throwing an exception. This attribute only applies when the
|
||||
channel might block, for example when using a bounded queue channel that
|
||||
is currently full.
|
||||
|
||||
Also, keep in mind that when sending to a DirectChannel, the
|
||||
invocation will occur in the sender's thread. Therefore,
|
||||
the failing of the send operation may be caused by other
|
||||
components further downstream.
|
||||
|
||||
The "reply-timeout" attribute maps to the "sendTimeout" property of the
|
||||
underlying 'MessagingTemplate' instance (org.springframework.integration.core.MessagingTemplate).
|
||||
|
||||
The attribute will default, if not specified, to '-1', meaning that
|
||||
by default, the Gateway will wait indefinitely. The value is
|
||||
specified in milliseconds.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:extension>
|
||||
</xsd:complexContent>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
<xsd:complexType name="outboundFileBaseType">
|
||||
<xsd:sequence>
|
||||
<xsd:choice minOccurs="0" maxOccurs="2">
|
||||
<xsd:element ref="integration:poller" minOccurs="0" maxOccurs="1"/>
|
||||
</xsd:sequence>
|
||||
<xsd:element name="request-handler-advice-chain" type="integration:adviceChainType" minOccurs="0" maxOccurs="1" />
|
||||
</xsd:choice>
|
||||
<xsd:attribute name="id" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Identifies the underlying Spring bean definition (EventDrivenConsumer)]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="directory" type="xsd:string" use="required">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[Specifies the output directory, e.g.:
|
||||
directory="file:/absolute/output" or directory="file:relative/output"]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="directory" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Specifies the output directory, e.g.:
|
||||
directory="file:/absolute/output" or directory="file:relative/output"
|
||||
Either this attribute or 'directory-expression' must be provided.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="directory-expression" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Specifies the output directory using a SpEL expression.
|
||||
This allows you to dynamically specify the output directory
|
||||
on a per message basis. For example a message header or payload
|
||||
property can be used for specifying the destination directory
|
||||
at runtime.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="filename-generator" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Allows you to provide a reference to the FileNameGenerator strategy
|
||||
<![CDATA[Allows you to provide a reference to the FileNameGenerator strategy
|
||||
to use when generating the destination file's name. If not specified the
|
||||
DefaultFileNameGenerator is used.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.file.FileNameGenerator"/>
|
||||
@@ -263,7 +301,7 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:attribute name="filename-generator-expression" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Allows you to provide a SpEL expression which will compute the file name of
|
||||
Allows you to provide a SpEL expression which will compute the file name of
|
||||
the target file (e.g., assuming payload is java.io.File "payload.name + '.transferred'");
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
@@ -272,9 +310,54 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
Extension used when uploading files. We change it after we know it's uploaded.
|
||||
This attribute is mutualy exclusive with 'append' since the append is done to the
|
||||
actual file and not its temporary counterpart. The default value of this attribute (i.e., .writing)
|
||||
is ignored when 'append' is set to true.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="mode">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
This attribute defaults to 'REPLACE' if not set explicitly.
|
||||
|
||||
The following options are available:
|
||||
|
||||
APPEND:
|
||||
|
||||
If append is specified, the data will be appended
|
||||
to the existing file if such file exists, otherwise the
|
||||
new file will be created as usual but once created the
|
||||
subsequent data will be appended to it. This attribute
|
||||
is mutualy exclusive with the 'temporary-file-suffix'
|
||||
since append is done to the actual file and not its
|
||||
temporary counterpart.
|
||||
|
||||
If set to APPEND, the component will also create a real
|
||||
instance of the LockRegistry to ensure that there are no
|
||||
collisions when multiple threads are writing to the same
|
||||
file.
|
||||
|
||||
FAIL:
|
||||
|
||||
If the target file exists, a MessageHandlingException
|
||||
is thrown.
|
||||
|
||||
IGNORE:
|
||||
|
||||
If the target file exists, the message payload is silently
|
||||
ignored.
|
||||
|
||||
REPLACE:
|
||||
|
||||
This is the default behavior when writing files. If the
|
||||
target file already exists, it will be overwritten.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:simpleType>
|
||||
<xsd:union memberTypes="mode xsd:string"/>
|
||||
</xsd:simpleType>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="delete-source-files" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
@@ -306,18 +389,18 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:documentation>
|
||||
<![CDATA[Lifecycle attribute signaling if this component should be started during Application Context startup.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
<xsd:attribute name="charset" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Set the charset name to use when writing a File from a String-based
|
||||
Message payload, e.g. charset="UTF-8". If not set, the default charset of this
|
||||
<![CDATA[Set the charset name to use when writing a File from a String-based
|
||||
Message payload, e.g. charset="UTF-8". If not set, the default charset of this
|
||||
Java virtual machine is used.
|
||||
]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:complexType>
|
||||
|
||||
<xsd:element name="file-to-string-transformer">
|
||||
@@ -332,11 +415,11 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:attribute name="charset" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[Set the charset name to use when converting a File
|
||||
payload to a String, e.g. charset="UTF-8". If not set, the default charset of this
|
||||
<![CDATA[Set the charset name to use when converting a File
|
||||
payload to a String, e.g. charset="UTF-8". If not set, the default charset of this
|
||||
Java virtual machine is used.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:extension>
|
||||
</xsd:complexContent>
|
||||
@@ -348,7 +431,7 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:documentation>
|
||||
Creates a Transformer that converts a File payload to an array of bytes.
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
<xsd:complexContent>
|
||||
<xsd:extension base="transformerType"/>
|
||||
@@ -366,7 +449,7 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[The input channel of the transformer.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.MessageChannel"/>
|
||||
@@ -377,10 +460,10 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:attribute name="output-channel" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[The channel to which the transformer will send the transformed message.
|
||||
Optional, because incoming messages can specify a reply channel using the 'replyChannel'
|
||||
<![CDATA[The channel to which the transformer will send the transformed message.
|
||||
Optional, because incoming messages can specify a reply channel using the 'replyChannel'
|
||||
message header value themselves.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.MessageChannel"/>
|
||||
@@ -391,27 +474,27 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:attribute name="delete-files" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[The delete-files option signals to the transformer that it should delete the
|
||||
<![CDATA[The delete-files option signals to the transformer that it should delete the
|
||||
inbound File after the transformation is complete.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
</xsd:attribute>
|
||||
</xsd:complexType>
|
||||
|
||||
<xsd:element name="locker">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[When multiple processes are reading from the same
|
||||
directory it can be desirable to lock files to prevent them
|
||||
<![CDATA[When multiple processes are reading from the same
|
||||
directory it can be desirable to lock files to prevent them
|
||||
from being picked up concurrently. To do this you can specify a reference to a FileLocker.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
<xsd:attribute name="ref" type="xsd:string">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[The reference to the FileLocker.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:documentation>
|
||||
<xsd:appinfo>
|
||||
<tool:annotation kind="ref">
|
||||
<tool:expected-type type="org.springframework.integration.file.FileLocker"/>
|
||||
@@ -425,11 +508,58 @@ Only files matching this regular expression will be picked up by this adapter.
|
||||
<xsd:element name="nio-locker">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation>
|
||||
<![CDATA[When multiple processes are reading from the same directory
|
||||
it can be desirable to lock files to prevent them from being picked up
|
||||
<![CDATA[When multiple processes are reading from the same directory
|
||||
it can be desirable to lock files to prevent them from being picked up
|
||||
concurrently. This is a java.nio based implementation available out of the box.]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:element>
|
||||
|
||||
<xsd:simpleType name="mode">
|
||||
<xsd:restriction base="xsd:token">
|
||||
<xsd:enumeration value="REPLACE">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
This is the default behavior when writing files. If the
|
||||
target file already exists, it will be overwritten.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:enumeration>
|
||||
<xsd:enumeration value="APPEND">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
If append is specified, the data will be appended
|
||||
to the existing file if such file exists, otherwise the
|
||||
new file will be created as usual but once created the
|
||||
subsequent data will be appended to it. This attribute
|
||||
is mutualy exclusive with the 'temporary-file-suffix'
|
||||
since append is done to the actual file and not its
|
||||
temporary counterpart.
|
||||
|
||||
If set to APPEND, the component will also create a real
|
||||
instance of the LockRegistry to ensure that there are no
|
||||
collisions when multiple threads are writing to the same
|
||||
file.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:enumeration>
|
||||
<xsd:enumeration value="FAIL">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
If the target file exists, a MessageHandlingException
|
||||
is thrown.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:enumeration>
|
||||
<xsd:enumeration value="IGNORE">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
If the target file exists, the message payload is silently
|
||||
ignored.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:enumeration>
|
||||
</xsd:restriction>
|
||||
</xsd:simpleType>
|
||||
|
||||
</xsd:schema>
|
||||
|
||||
Reference in New Issue
Block a user