Интерфейс WatchService

public interface WatchService extends Closeable

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

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

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

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

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

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

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

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

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