Skip to content

Commit c5ec2d9

Browse files
committed
Remove double commas in docs for link syntax
1 parent 175223d commit c5ec2d9

23 files changed

+55
-55
lines changed

src/reference/asciidoc/chain.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ In this case, it is 'somethingChain$child#1'.
121121
Note, this transformer is not registered as a bean within the application context, so it does not get a `beanName`.
122122
However its `componentName` has a value that is useful for logging and other purposes.
123123

124-
The `id` attribute for `<chain>` elements lets them be eligible for <<./jmx.adoc#jmx-mbean-exporter,,JMX export>>, and they are trackable in the <<./message-history.adoc#message-history,,message history>>.
124+
The `id` attribute for `<chain>` elements lets them be eligible for <<./jmx.adoc#jmx-mbean-exporter,JMX export>>, and they are trackable in the <<./message-history.adoc#message-history,message history>>.
125125
You can access them from the `BeanFactory` by using the appropriate bean name, as discussed earlier.
126126

127127
TIP: It is useful to provide an explicit `id` attribute on `<chain>` elements to simplify the identification of sub-components in logs and to provide access to them from the `BeanFactory` etc.

src/reference/asciidoc/changes-2.1-2.2.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ For more information, see <<./mongodb.adoc#mongodb-outbound-channel-adapter,Mong
2727
Spring Integration now includes components for the Java Persistence API (JPA) for retrieving and persisting JPA entity objects.
2828
The JPA Adapter includes the following components:
2929

30-
* <<./jpa.adoc#jpa-inbound-channel-adapter,,Inbound channel adapter>>
31-
* <<./jpa.adoc#jpa-outbound-channel-adapter,,Outbound channel adapter>>
32-
* <<./jpa.adoc#jpa-updating-outbound-gateway,,Updating outbound gateway>>
33-
* <<./jpa.adoc#jpa-retrieving-outbound-gateway,,Retrieving outbound gateway>>
30+
* <<./jpa.adoc#jpa-inbound-channel-adapter,Inbound channel adapter>>
31+
* <<./jpa.adoc#jpa-outbound-channel-adapter,Outbound channel adapter>>
32+
* <<./jpa.adoc#jpa-updating-outbound-gateway,Updating outbound gateway>>
33+
* <<./jpa.adoc#jpa-retrieving-outbound-gateway,Retrieving outbound gateway>>
3434

3535
For more information, see <<./jpa.adoc#jpa,JPA Support>>.
3636

src/reference/asciidoc/changes-4.3-5.0.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ See <<./jms.adoc#jms,JMS Support>> for more information.
129129
===== Mail Changes
130130

131131
Some inconsistencies with rendering IMAP mail content have been resolved.
132-
See <<./mail.adoc#imap-format-important,,the note in the "`Mail-receiving Channel Adapter`" section>> for more information.
132+
See <<./mail.adoc#imap-format-important,the note in the "`Mail-receiving Channel Adapter`" section>> for more information.
133133

134134
===== Feed Changes
135135

src/reference/asciidoc/configuration.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ The next section describes what happens if exceptions occur within the asynchron
152152
[[namespace-errorhandler]]
153153
=== Error Handling
154154

155-
As described in the <<./overview.adoc#overview,,overview>> at the very beginning of this manual, one of the main motivations behind a message-oriented framework such as Spring Integration is to promote loose coupling between components.
155+
As described in the <<./overview.adoc#overview,overview>> at the very beginning of this manual, one of the main motivations behind a message-oriented framework such as Spring Integration is to promote loose coupling between components.
156156
The message channel plays an important role, in that producers and consumers do not have to know about each other.
157157
However, the advantages also have some drawbacks.
158158
Some things become more complicated in a loosely coupled environment, and one example is error handling.
@@ -210,7 +210,7 @@ Starting with version 4.3.10, Spring Integration provides the `ErrorMessagePubli
210210
You can use them as a general mechanism for publishing `ErrorMessage` instances.
211211
You can call or extend them in any error handling scenarios.
212212
The `ErrorMessageSendingRecoverer` extends this class as a `RecoveryCallback` implementation that can be used with retry, such as the
213-
<<./handler-advice.adoc#retry-advice,, `RequestHandlerRetryAdvice`>>.
213+
<<./handler-advice.adoc#retry-advice,`RequestHandlerRetryAdvice`>>.
214214
The `ErrorMessageStrategy` is used to build an `ErrorMessage` based on the provided exception and an `AttributeAccessor` context.
215215
It can be injected into any `MessageProducerSupport` or `MessagingGatewaySupport`.
216216
The `requestMessage` is stored under `ErrorMessageUtils.INPUT_MESSAGE_CONTEXT_KEY` in the `AttributeAccessor` context.
@@ -415,7 +415,7 @@ The processing of these annotations creates the same beans as the corresponding
415415
See <<annotations_on_beans>>.
416416
The bean names are generated from the following pattern: `[componentName].[methodName].[decapitalizedAnnotationClassShortName]`
417417
(for example, for the preceding example the bean name is `thingService.otherThing.serviceActivator`) for the `AbstractEndpoint` and the same name with an additional `.handler` (`.source`) suffix for the `MessageHandler` (`MessageSource`) bean.
418-
The `MessageHandler` instances (`MessageSource` instances) are also eligible to be tracked by <<./message-history.adoc#message-history,, the message history>>.
418+
The `MessageHandler` instances (`MessageSource` instances) are also eligible to be tracked by <<./message-history.adoc#message-history,the message history>>.
419419

420420
Starting with version 4.0, all messaging annotations provide `SmartLifecycle` options (`autoStartup` and `phase`) to allow endpoint lifecycle control on application context initialization.
421421
They default to `true` and `0`, respectively.

src/reference/asciidoc/content-enrichment.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ The Spring Integration `Core` module includes two enrichers:
1111

1212
It also includes three adapter-specific header enrichers:
1313

14-
* <<./xml.adoc#xml-xpath-header-enricher,,XPath Header Enricher (XML Module)>>
15-
* <<./mail.adoc#mail-namespace,,Mail Header Enricher (Mail Module)>>
16-
* <<./xmpp.adoc#xmpp-message-outbound-channel-adapter,,XMPP Header Enricher (XMPP Module)>>
14+
* <<./xml.adoc#xml-xpath-header-enricher,XPath Header Enricher (XML Module)>>
15+
* <<./mail.adoc#mail-namespace,Mail Header Enricher (Mail Module)>>
16+
* <<./xmpp.adoc#xmpp-message-outbound-channel-adapter,XMPP Header Enricher (XMPP Module)>>
1717

1818
See the adapter-specific sections of this reference manual to learn more about those adapters.
1919

src/reference/asciidoc/file.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,7 @@ By default, they append `.writing` to the file name and remove it when the trans
608608
Another common technique is to write a second "`marker`" file to indicate that the file transfer is complete.
609609
In this scenario, you should not consider `somefile.txt` (for example) to be available for use until `somefile.txt.complete` is also present.
610610
Spring Integration version 5.0 introduced new filters to support this mechanism.
611-
Implementations are provided for the file system (`FileSystemMarkerFilePresentFileListFilter`), <<./ftp.adoc#ftp-incomplete,, FTP>> and <<./sftp.adoc#sftp-incomplete,, SFTP>>.
611+
Implementations are provided for the file system (`FileSystemMarkerFilePresentFileListFilter`), <<./ftp.adoc#ftp-incomplete,FTP>> and <<./sftp.adoc#sftp-incomplete,SFTP>>.
612612
They are configurable such that the marker file can have any name, although it is usually related to the file being transferred.
613613
See the https://docs.spring.io/spring-integration/api/org/springframework/integration/file/filters/FileSystemMarkerFilePresentFileListFilter.html[Javadoc] for more information.
614614

@@ -950,7 +950,7 @@ It is often better to use a sequence of transformers than to put all transformat
950950
In that case the `File` to `byte[]` conversion might be a logical first step.
951951

952952
`FileToStringTransformer` extends `AbstractFilePayloadTransformer` convert a `File` object to a `String`.
953-
If nothing else, this can be useful for debugging (consider using it with a <<./channel.adoc#channel-wiretap,,wire tap>>).
953+
If nothing else, this can be useful for debugging (consider using it with a <<./channel.adoc#channel-wiretap,wire tap>>).
954954

955955
To configure file-specific transformers, you can use the appropriate elements from the file namespace, as the following example shows:
956956

@@ -1057,7 +1057,7 @@ This line is not included in the sequence header (if `applySequence` is true) no
10571057
If a file contains only the header line, the file is treated as empty and, therefore, only `FileMarker` instances are emitted during splitting (if markers are enabled -- otherwise, no messages are emitted).
10581058
By default (if no header name is set), the first line is considered to be data and becomes the payload of the first emitted message.
10591059

1060-
If you need more complex logic about header extraction from the file content (not first line, not the whole content of the line, not one particular header, and so on), consider using <<./content-enrichment.adoc#header-enricher,, header enricher>> ahead of the `FileSplitter`.
1060+
If you need more complex logic about header extraction from the file content (not first line, not the whole content of the line, not one particular header, and so on), consider using <<./content-enrichment.adoc#header-enricher,header enricher>> ahead of the `FileSplitter`.
10611061
Note that the lines that have been moved to the headers might be filtered downstream from the normal content process.
10621062

10631063
==== Configuring with Java Configuration

src/reference/asciidoc/ftp.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ The default `MetadataStore` is a `SimpleMetadataStore`, which stores state in me
354354
Since version 4.1.5, these filters have a new property (`flushOnUpdate`) that causes them to flush the
355355
metadata store on every update (if the store implements `Flushable`).
356356

357-
IMPORTANT: Further, if you use a distributed `MetadataStore` (such as <<./redis.adoc#redis-metadata-store,,Redis>> or <<./gemfire.adoc#gemfire-metadata-store,,GemFire>>), you can have multiple instances of the same adapter or application and be sure that each file is processed only once.
357+
IMPORTANT: Further, if you use a distributed `MetadataStore` (such as <<./redis.adoc#redis-metadata-store,Redis>> or <<./gemfire.adoc#gemfire-metadata-store,GemFire>>), you can have multiple instances of the same adapter or application and be sure that each file is processed only once.
358358

359359
The actual local filter is a `CompositeFileListFilter` that contains the supplied filter and a pattern filter that prevents processing files that are in the process of being downloaded (based on the `temporary-file-suffix`).
360360
Files are downloaded with this suffix (the default is `.writing`), and the file is renamed to its final name when the transfer is complete, making it 'visible' to the filter.
@@ -805,7 +805,7 @@ When all files are consumed, the remote fetch is attempted again, to pick up any
805805
IMPORTANT: When you deploy multiple instances of an application, we recommend a small `max-fetch-size`, to avoid one instance "`grabbing`" all the files and starving other instances.
806806

807807
Another use for `max-fetch-size` is if you want to stop fetching remote files but continue to process files that have already been fetched.
808-
Setting the `maxFetchSize` property on the `MessageSource` (programmatically, with JMX, or with a <<./control-bus.adoc#control-bus,,control bus>>) effectively stops the adapter from fetching more files but lets the poller continue to emit messages for files that have previously been fetched.
808+
Setting the `maxFetchSize` property on the `MessageSource` (programmatically, with JMX, or with a <<./control-bus.adoc#control-bus,control bus>>) effectively stops the adapter from fetching more files but lets the poller continue to emit messages for files that have previously been fetched.
809809
If the poller is active when the property is changed, the change takes effect on the next poll.
810810

811811
Starting with version 5.1, the synchronizer can be provided with a `Comparator<FTPFile>`.
@@ -1068,10 +1068,10 @@ The `file_remoteDirectory` header provides the remote directory name, and the `f
10681068

10691069
The message payload resulting from a `get` operation is a `File` object that represents the retrieved file or an `InputStream` when you use the `-stream` option.
10701070
The `-stream` option allows retrieving the file as a stream.
1071-
For text files, a common use case is to combine this operation with a <<./file.adoc#file-splitter,,file splitter>> or a <<./transformer.adoc#stream-transformer,,stream transformer>>.
1071+
For text files, a common use case is to combine this operation with a <<./file.adoc#file-splitter,file splitter>> or a <<./transformer.adoc#stream-transformer,stream transformer>>.
10721072
When consuming remote files as streams, you are responsible for closing the `Session` after the stream is consumed.
10731073
For convenience, the `Session` is provided in the `closeableResource` header, which you can access with a convenience method on `IntegrationMessageHeaderAccessor`
1074-
The following example shows how to do use the covenience method:
1074+
The following example shows how to use the convenience method:
10751075

10761076
====
10771077
[source, java]
@@ -1083,7 +1083,7 @@ if (closeable != null) {
10831083
----
10841084
====
10851085

1086-
Framework components such as the <<./file.adoc#file-splitter,,file splitter>> and the <<./transformer.adoc#stream-transformer,,stream transformer>> automatically close the session after the data is transferred.
1086+
Framework components such as the <<./file.adoc#file-splitter,file splitter>> and the <<./transformer.adoc#stream-transformer,stream transformer>> automatically close the session after the data is transferred.
10871087

10881088
The following example shows how to consume a file as a stream:
10891089

src/reference/asciidoc/functions-support.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Starting with version 5.1, Spring Integration provides direct support for interfaces in the `java.util.function` package.
55
All messaging endpoints, (Service Activator, Transformer, Filter, etc.) can now refer to `Function` (or `Consumer`) beans.
6-
The <<./configuration.adoc#annotations,,Messaging Annotations>> can be applied directly on these beans similar to regular `MessageHandler` definitions.
6+
The <<./configuration.adoc#annotations,Messaging Annotations>> can be applied directly on these beans similar to regular `MessageHandler` definitions.
77
For example if you have this `Function` bean definition:
88

99

src/reference/asciidoc/gateway.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ It lets you configure an interface as a service, as the following example shows:
4646

4747
With this configuration defined, the `cafeService` can now be injected into other beans, and the code that invokes the methods on that proxied instance of the `Cafe` interface has no awareness of the Spring Integration API.
4848
The general approach is similar to that of Spring Remoting (RMI, HttpInvoker, and so on).
49-
See the <<./samples.adoc#samples,,"`Samples`">> Appendix for an example that uses the `gateway` element (in the Cafe demo).
49+
See the <<./samples.adoc#samples,"`Samples`">> Appendix for an example that uses the `gateway` element (in the Cafe demo).
5050

5151
The defaults in the preceding configuration are applied to all methods on the gateway interface.
5252
If a reply timeout is not specified, the calling thread waits indefinitely for a reply.
@@ -79,7 +79,7 @@ By defining a `default-reply-channel` you can point to a channel of your choosin
7979
In this case, that is a `publish-subscribe-channel`.
8080
The gateway creates a bridge from it to the temporary, anonymous reply channel that is stored in the header.
8181

82-
You might also want to explicitly provide a reply channel for monitoring or auditing through an interceptor (for example, <<./channel.adoc#channel-wiretap,, wiretap>>).
82+
You might also want to explicitly provide a reply channel for monitoring or auditing through an interceptor (for example, <<./channel.adoc#channel-wiretap,wiretap>>).
8383
To configure a channel interceptor, you need a named channel.
8484

8585
[[gateway-configuration-annotations]]

src/reference/asciidoc/handler-advice.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -682,9 +682,9 @@ The following example shows `<transactional>` in use:
682682
</bean>
683683
----
684684

685-
If you are familiar with the <<./jpa.adoc#jpa,, JPA integration components>>, such a configuration is not new, but now we can start a transaction from any point in our flow -- not only from the `<poller>` or a message-driven channel adapter such as <<./jms.adoc#jms-message-driven-channel-adapter,, JMS>>.
685+
If you are familiar with the <<./jpa.adoc#jpa,JPA integration components>>, such a configuration is not new, but now we can start a transaction from any point in our flow -- not only from the `<poller>` or a message-driven channel adapter such as <<./jms.adoc#jms-message-driven-channel-adapter,JMS>>.
686686

687-
Java configuration can be simplified by using the `TransactionInterceptorBuilder`, and the result bean name can be used in the <<./configuration.adoc#annotations,, messaging annotations>> `adviceChain` attribute, as the following example shows:
687+
Java configuration can be simplified by using the `TransactionInterceptorBuilder`, and the result bean name can be used in the <<./configuration.adoc#annotations,messaging annotations>> `adviceChain` attribute, as the following example shows:
688688

689689
[source,java]
690690
----

src/reference/asciidoc/ip.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -636,7 +636,7 @@ The following example shows how to configure a connection interceptor factory ch
636636
=== TCP Connection Events
637637

638638
Beginning with version 3.0, changes to `TcpConnection` instances are reported by `TcpConnectionEvent` instances.
639-
`TcpConnectionEvent` is a subclass of `ApplicationEvent` and can thus be received by any `ApplicationListener` defined in the `ApplicationContext` -- for example <<./event.adoc#appevent-inbound,,an event inbound channel adapter>>.
639+
`TcpConnectionEvent` is a subclass of `ApplicationEvent` and can thus be received by any `ApplicationListener` defined in the `ApplicationContext` -- for example <<./event.adoc#appevent-inbound,an event inbound channel adapter>>.
640640

641641
`TcpConnectionEvents` have the following properties:
642642

@@ -743,7 +743,7 @@ Two additional attributes support this mechanism.
743743
The `retry-interval` specifies (in milliseconds) how often the framework attempts to reconnect after a connection failure.
744744
The `scheduler` supplies a `TaskScheduler` to schedule the connection attempts and to test that the connection is still active.
745745

746-
If you don't provide a scheduler, the framework's default <<./configuration.adoc#namespace-taskscheduler,, taskScheduler>> bean is used.
746+
If you don't provide a scheduler, the framework's default <<./configuration.adoc#namespace-taskscheduler,taskScheduler>> bean is used.
747747

748748
For an outbound adapter, the connection is normally established when the first message is sent.
749749
The `client-mode="true"` on an outbound adapter causes the connection to be established when the adapter is started.

src/reference/asciidoc/jdbc.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -1094,10 +1094,10 @@ You can use the `JdbcMetadataStore` to maintain the metadata state across applic
10941094
This `MetadataStore` implementation can be used with adapters such as the following:
10951095

10961096

1097-
* <<./feed.adoc#feed-inbound-channel-adapter,,Feed inbound channel adapters>>
1098-
* <<./file.adoc#file-reading,,files>>
1099-
* <<./ftp.adoc#ftp-inbound,,FTP inbound channel adapters>>
1100-
* <<./sftp.adoc#sftp-inbound,,SFTP inbound channel adapters>>
1097+
* <<./feed.adoc#feed-inbound-channel-adapter,Feed inbound channel adapters>>
1098+
* <<./file.adoc#file-reading,File inbound channel adapters>>
1099+
* <<./ftp.adoc#ftp-inbound,FTP inbound channel adapters>>
1100+
* <<./sftp.adoc#sftp-inbound,SFTP inbound channel adapters>>
11011101

11021102
To configure these adapters to use the `JdbcMetadataStore`, declare a Spring bean by using a bean name of `metadataStore`.
11031103
The Feed inbound channel adapter and the feed inbound channel adapter both automatically pick up and use the declared `JdbcMetadataStore`, as the following example shows:

src/reference/asciidoc/message-store.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Spring Integration provides support for the message store pattern by:
1313
* Providing several implementations of this interface
1414
* Exposing a `message-store` attribute on all components that have the capability to buffer messages so that you can inject any instance that implements the `MessageStore` interface.
1515

16-
Details on how to configure a specific message store implementation and how to inject a `MessageStore` implementation into a specific buffering component are described throughout the manual (see the specific component, such as <<./channel.adoc#channel-configuration-queuechannel,,QueueChannel>>, <<./aggregator.adoc#aggregator,,Aggregator>>, <<./delayer.adoc#delayer,,Delayer>>, and others).
16+
Details on how to configure a specific message store implementation and how to inject a `MessageStore` implementation into a specific buffering component are described throughout the manual (see the specific component, such as <<./channel.adoc#channel-configuration-queuechannel,QueueChannel>>, <<./aggregator.adoc#aggregator,Aggregator>>, <<./delayer.adoc#delayer,Delayer>>, and others).
1717
The following pair of examples show how to add a reference to a message store for a `QueueChannel` and for an aggregator:
1818

1919
.QueueChannel

0 commit comments

Comments
 (0)