src/jdk.dns.client/share/classes/jdk/dns/client/internal/util/ReloadTracker.java
author aefimov
Thu, 31 Oct 2019 16:16:21 +0000
branchaefimov-dns-client-branch
changeset 58870 35c438a6d45c
child 59101 258033faefc9
permissions -rw-r--r--
aefimov-dns-client-branch: Add jdk.dns.client source
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58870
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
     1
/*
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
     2
 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
     4
 *
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    10
 *
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    15
 * accompanied this code).
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    16
 *
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    20
 *
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    23
 * questions.
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    24
 */
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    25
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    26
package jdk.dns.client.internal.util;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    27
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    28
import java.io.IOException;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    29
import java.nio.file.Files;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    30
import java.nio.file.Path;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    31
import java.security.AccessController;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    32
import java.security.PrivilegedAction;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    33
import java.security.PrivilegedActionException;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    34
import java.security.PrivilegedExceptionAction;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    35
import java.util.concurrent.atomic.AtomicLong;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    36
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    37
public class ReloadTracker {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    38
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    39
    public static ReloadTracker newInstance(Path fileToTrack, long refreshTimeoutMillis) {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    40
        Path absolutePath = fileToTrack.toAbsolutePath();
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    41
        return new ReloadTracker(absolutePath, refreshTimeoutMillis);
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    42
    }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    43
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    44
    public static class ReloadStatus {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    45
        private final boolean isReloadNeeded;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    46
        private final long lastModificationTimestamp;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    47
        private final boolean fileExists;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    48
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    49
        ReloadStatus(boolean fileExists, boolean isReloadNeeded, long lastModificationTimestamp) {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    50
            this.isReloadNeeded = fileExists && isReloadNeeded;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    51
            this.lastModificationTimestamp = lastModificationTimestamp;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    52
            this.fileExists = fileExists;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    53
        }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    54
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    55
        public boolean isFileExists() {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    56
            return fileExists;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    57
        }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    58
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    59
        public boolean isReloadNeeded() {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    60
            return isReloadNeeded;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    61
        }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    62
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    63
        public long getLastModificationTimestamp() {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    64
            return lastModificationTimestamp;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    65
        }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    66
    }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    67
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    68
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    69
    private ReloadTracker(Path filePath, long refreshTimeoutMillis) {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    70
        this.filePath = filePath;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    71
        this.refreshTimeoutMillis = refreshTimeoutMillis;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    72
    }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    73
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    74
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    75
    public ReloadStatus getReloadStatus() {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    76
        boolean fileExists;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    77
        var pa = (PrivilegedAction<Boolean>) () -> filePath.toFile().isFile();
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    78
        fileExists = System.getSecurityManager() == null ? pa.run() : AccessController.doPrivileged(pa);
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    79
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    80
        long lastModificationTime = -1;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    81
        long lastReload = lastRefreshed.get();
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    82
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    83
        // Do not update lastModification time if file doesn't exist
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    84
        if (fileExists) {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    85
            try {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    86
                var pea = (PrivilegedExceptionAction<Long>) () -> Files.getLastModifiedTime(filePath).toMillis();
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    87
                lastModificationTime = System.getSecurityManager() == null ? pea.run()
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    88
                        : AccessController.doPrivileged(pea);
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    89
            } catch (Exception e) {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    90
                // In case of Exception the tracked file will be reloaded, ie lastModificationTime == -1
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    91
            }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    92
        }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    93
        return new ReloadStatus(fileExists,
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    94
                (lastModificationTime != lastSeenChanged.get()) ||
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    95
                        (System.currentTimeMillis() - lastReload > refreshTimeoutMillis),
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    96
                lastModificationTime);
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    97
    }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    98
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
    99
    public void updateTimestamps(ReloadStatus rs) {
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   100
        lastSeenChanged.set(rs.lastModificationTimestamp);
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   101
        lastRefreshed.set(System.currentTimeMillis());
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   102
    }
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   103
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   104
    // Last timestamp when tracked file has been reloaded by consumer of this utility class
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   105
    private final AtomicLong lastRefreshed = new AtomicLong(-1);
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   106
    // Last processed FS last modified timestamp
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   107
    private final AtomicLong lastSeenChanged = new AtomicLong(-1);
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   108
    // Refresh timeout
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   109
    private final long refreshTimeoutMillis;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   110
    // Path of the tracked file
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   111
    private final Path filePath;
35c438a6d45c aefimov-dns-client-branch: Add jdk.dns.client source
aefimov
parents:
diff changeset
   112
}