Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8227667

Java Watch Service cannot watch all the folders defined as UNC Path in Hierarchy

XMLWordPrintable

    • x86_64
    • windows_10

      A DESCRIPTION OF THE PROBLEM :
      I have been trying to watch folders through UNC. There are a lot of folders in the main folder. When I run the watch service it is registering all the folders with watch service. After all these folders are registered the watch service receives the events with Invalid key i-e key.isValid() returns false. And at this moment the particular folder is excluded from watch. I have reset the key but it is also giving me false. In short I am unable to watch for those folders which are excluded from key. I even tried to re register the folders but that again generates the invalid key and cannot be watched. I have tried this with normal folders in the same machine. They are working fine. Please help me if I am missing something. If I limit the folders to around 50-60 watch service doesn't receive any invalid key event and everything is working fine.


      STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
      Run CreateDir.java to create the folders on network.
      Run WatchDir.java to start watching those folders.

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      Watch Service should watch all the folders accessed through UNC or symbolic link
      ACTUAL -
      After watching some folders it is generating invalid key events for folders.

      ---------- BEGIN SOURCE ----------
      import java.io.File;

      public class CreateDir {
          public static void main(String args[]){
              for(int j=0; j<1000; j++){
                  String folderName = "Folder"+j;
                  new File("\\\\Server2\\Shared Folder\\test\\" + folderName + "\\" + folderName + "_Folder1" + "\\" + folderName + "_Folder2" + "\\"
                          + folderName + "_Folder3" + "\\" + folderName + "_Folder4" + "\\" + folderName + "_Folder5"+"\\"
                          + folderName + "_Folder6" + "\\" + folderName + "_Folder7" + "\\" + folderName + "_Folder8" + "\\"
                          + folderName + "_Folder9" + "\\" + folderName + "_Folder10").mkdirs();
              }

          }
      }

      This is the class that is actually watching these UNC Paths and giving information regarding events.

      import java.nio.file.*;
      import static java.nio.file.StandardWatchEventKinds.*;
      import static java.nio.file.LinkOption.*;
      import java.nio.file.attribute.*;
      import java.io.*;
      import java.util.*;

      public class WatchDir {

          private final WatchService watcher;
          private final Map<WatchKey,Path> keys;
          private final boolean recursive;
          private boolean trace = false;
          private int total = 0;

          @SuppressWarnings("unchecked")
          static <T> WatchEvent<T> cast(WatchEvent<?> event) {
              return (WatchEvent<T>)event;
          }

          /**
           * Register the given directory with the WatchService
           */
          private void register(Path dir, PrintWriter writer) throws IOException {
              WatchKey key = dir.register(watcher, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY);
              if (trace) {
                  Path prev = keys.get(key);
                  if (prev == null) {
                      writer.println("register:"+dir);
                  } else {
                      if (!dir.equals(prev)) {
                          writer.println("update.........");
                      }
                  }
              }
              keys.put(key, dir);
          }

          /**
           * Register the given directory, and all its sub-directories, with the
           * WatchService.
           */
          private void registerAll(final Path start, PrintWriter writer){
              // register directory and sub-directories
              try{
              Files.walkFileTree(start, new SimpleFileVisitor<Path>() {
                  @Override
                  public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs)
                  {
                      writer.println(++total+"Registering Path...."+dir.toUri());

                      try{
                          register(dir,writer);
                      }catch(IOException ex){
                          writer.println("Error occurred for Path..."+dir.getFileName());
                      }catch(Exception ex){
                          System.out.println("error");
                      }
                      return FileVisitResult.CONTINUE;
                  }
              });
              }catch(Exception ex){
                  writer.println("Not Registered ....."+ex.getMessage());
              }
          }

          /**
           * Creates a WatchService and registers the given directory
           */
          WatchDir(Path dir, boolean recursive, PrintWriter writer) throws IOException {
              this.watcher = FileSystems.getDefault().newWatchService();
              this.keys = new HashMap<WatchKey,Path>();
              this.recursive = recursive;

              if (recursive) {
                  System.out.println("Starting Registering Path");
                  writer.println("Scanning %s ...\n"+ dir);
                  registerAll(dir, writer);
                  writer.println("Done.");
                  System.out.println("Done");
                  writer.println("Total Folders in Watch "+ total);
                  System.out.println("Total Folders in Watch "+ total);
              } else {
                  register(dir,writer);
              }

              // enable trace after initial registration
              this.trace = true;
          }

          /**
           * Process all events for keys queued to the watcher
           * @throws UnsupportedEncodingException
           * @throws FileNotFoundException
           */
          void processEvents() throws FileNotFoundException, UnsupportedEncodingException {
              PrintWriter writer1 = new PrintWriter("C:\\test\\key.txt");
              for (;;) {

                  // wait for key to be signalled
                  WatchKey key;
                  try {
                      key = watcher.take();
                      writer1.println("Folder is "+key.watchable()+" And Key is "+ key.isValid());
                      System.out.println("Folder is "+key.watchable()+" And Key is "+ key.isValid());
                  } catch (InterruptedException x) {
                      writer1.println("Interupped Exception.........");
                      return;
                  }

                  Path dir = keys.get(key);
                  if (dir == null) {
                      writer1.println("WatchKey not recognized!!");
                      continue;
                  }

                  for (WatchEvent<?> event: key.pollEvents()) {
                      WatchEvent.Kind kind = event.kind();

                      // TBD - provide example of how OVERFLOW event is handled
                      if (kind == OVERFLOW) {
                          writer1.println("Overflow event is caught.");
                          continue;
                      }

                      // Context for directory entry event is the file name of entry
                      WatchEvent<Path> ev = cast(event);
                      Path name = ev.context();
                      Path child = dir.resolve(name);

                      // print out event
                      System.out.format("%s: %s\n", event.kind().name(), child);
                      writer1.println("Event Kind is "+event.kind().name() +" And Name is "+child);

                      // if directory is created, and watching recursively, then
                      // register it and its sub-directories
                      if (recursive && (kind == ENTRY_CREATE)) {
                          try {
                              if (Files.isDirectory(child, NOFOLLOW_LINKS)) {
                                  registerAll(child, writer1);
                              }
                          } catch (Exception x) {
                              // ignore to keep sample readbale
                          }
                      }
                  }

                  // reset key and remove from set if directory no longer accessible
                  boolean valid = key.reset();
                  if (!valid) {
                      keys.remove(key);

                      // all directories are inaccessible
                      if (keys.isEmpty()) {
                          break;
                      }
                  }
              }
          }

          static void usage() {
              System.err.println("usage: java WatchDir [-r] dir");
              System.exit(-1);
          }

          public static void main(String[] args) throws IOException {
              // register directory and process its events
              PrintWriter writer = new PrintWriter("C:\\test\\watch.txt");
              Path dir = Paths.get("\\\\Server1\\Shared Folder\\test");
              new WatchDir(dir, true,writer).processEvents();
          }
      }
      ---------- END SOURCE ----------

      FREQUENCY : always


            bpb Brian Burkhalter
            webbuggrp Webbug Group
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: