Интерфейс WatchService

public interface WatchService extends Closeable

Служба наблюдения, которая отслеживает зарегистрированные объекты на предмет изменений и событий. Например, файловый менеджер может использовать службу наблюдения для мониторинга каталога на предмет изменений, чтобы обновлять отображаемый список файлов при создании или удалении файлов.

Объект Watchable регистрируется в службе наблюдения вызовом метода register, который возвращает WatchKey, представляющий регистрацию. При обнаружении события для объекта ключ активируется и, если он ещё не активирован, помещается в очередь службы наблюдения, чтобы его могли получить потребители, вызывающие методы poll или take для получения ключей и обработки событий. После обработки событий потребитель вызывает метод reset ключа, чтобы сбросить его и разрешить повторную активацию ключа и помещение его в очередь при поступлении новых событий.

Регистрация в службе наблюдения отменяется вызовом метода cancel ключа. Ключ, находящийся в очереди на момент отмены, остаётся в очереди до момента его извлечения. В зависимости от объекта ключ может быть отменён автоматически. Например, предположим, что ведётся наблюдение за каталогом и служба обнаруживает, что он был удалён или его файловая система стала недоступна. При такой отмене ключ активируется и помещается в очередь, если он ещё не активирован. Чтобы уведомить потребителя, возвращаемое значение метода reset указывает, является ли ключ действительным.

Службу наблюдения безопасно использовать нескольким одновременно работающим потребителям. Чтобы гарантировать, что события для определённого объекта в каждый момент времени обрабатывает только один потребитель, следует следить за тем, чтобы метод reset ключа вызывался только после обработки его событий. Метод close можно вызвать в любое время, чтобы закрыть службу; все потоки, ожидающие получения ключей, получат исключение ClosedWatchServiceException.

Файловые системы могут сообщать о событиях быстрее, чем их удаётся получать или обрабатывать, и реализация может устанавливать неуказанный предел на количество накапливаемых событий. Если реализация заведомо отбрасывает события, она обеспечивает возврат методом pollEvents ключа элемента с типом события OVERFLOW. Потребитель может использовать это событие как сигнал для повторной проверки состояния объекта.

Если сообщается о событии, указывающем на изменение файла в отслеживаемом каталоге, это не гарантирует, что программа (или программы), изменившая файл, завершила работу. Следует координировать доступ с другими программами, которые могут обновлять файл. Класс FileChannel определяет методы блокировки областей файла от доступа других программ.

Зависимость от платформы

Реализация, отслеживающая события файловой системы, предназначена для непосредственного использования встроенного механизма уведомления о файловых событиях, если он доступен, либо для применения простого механизма, например опроса, если встроенный механизм недоступен. Поэтому многие детали обнаружения событий, своевременность их обнаружения и сохранение порядка событий в значительной степени зависят от реализации. Например, изменение файла в отслеживаемом каталоге в одних реализациях может привести к одному событию ENTRY_MODIFY, а в других — к нескольким событиям. Простые реализации, периодически опрашивающие файловую систему для обнаружения изменений, могут не обнаружить кратковременно существующие файлы (то есть файлы, которые удаляются вскоре после создания).

Если отслеживаемый файл находится не на локальном устройстве хранения данных, возможность обнаружения изменений файла зависит от реализации. В частности, обнаружение изменений файлов, выполненных в удалённых системах, не гарантируется.