Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

INT-1889 Add note regarding unlocking to reference documentation.

Browse Source 
When a NioLocker acquires locks from the FileReadingMessageSource, they are not released by Spring integration. There is no way to do that without surprising a user, so we leave it up to the user to do the unlocking when needed.
This commit is contained in:
Iwein Fuld
2011-05-06 09:09:03 +02:00
parent 1731bfb3b4
commit d31079a05c
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/src/reference/docbook/file.xml
View File

@@ -124,6 +124,15 @@
</file:inbound-channel-adapter>]]>
</programlisting>
</para>
<note>
<para>
When a file inbound adapter is configured with a locker, it will take the responsibility to acquire a
lock before the file is allowed to be received.
<strong>It will not assume the responsibility to unlock the file.</strong>
If you have processed the file and keeping the locks hanging around you have a memory leak. If this is
a problem in your case you should call FileLocker.unlock(File file) yourself at the appropriate time.
</para>
</note>
<para>
When filtering and locking files is not enough it might be needed to control the way files are listed entirely. To
implement this type of requirement you can use an implementation of <interfacename>DirectoryScanner</interfacename>.