org.glassfish.deployment.autodeploy.AutoDeployedFilesManager Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
/*
* AutoDeployedFilesManager.java
*
* Created on September 4, 2003
*
*/
package org.glassfish.deployment.autodeploy;
import java.io.*;
import java.net.URI;
import java.util.*;
import java.util.logging.Logger;
import java.util.logging.Level;
import org.glassfish.logging.annotation.LogMessageInfo;
/**
* Contains the status of list of files that have been autodeployed.
*
* @author Mahesh Rangamani
*/
public class AutoDeployedFilesManager {
public static final Logger deplLogger =
org.glassfish.deployment.autodeploy.AutoDeployer.deplLogger;
@LogMessageInfo(message = "Attempt to create file {0} failed; no further information.", level="WARNING")
private static final String CREATE_FAILED = "NCLS-DEPLOYMENT-02041";
@LogMessageInfo(message = "Attempt to set last modified date/time of file {0} failed; no further information.", level="WARNING")
private static final String MODIFIED_DATE_FAILED = "NCLS-DEPLOYMENT-02042";
@LogMessageInfo(message = "Attempt to delete file {0} failed; no further information.", level="WARNING")
private static final String DELETE_FAILED = "NCLS-DEPLOYMENT-02043";
@LogMessageInfo(message = "Attempt to create directory {0} failed; no further information.", level="WARNING")
private static final String MKDIRS_FAILED = "NCLS-DEPLOYMENT-02044";
static final String STATUS_DIR_NAME = ".autodeploystatus";
/*
* Macs use .DS_Store in a folder to track information about
* changes to the contents of the folder. If a user uses Finder to move
* a previously-autodeployed file to the Trash, the system creates and/or updates .DS_Store.
* Clearly we do not want to try deploying that file.
*/
private static final String DS_STORE = ".DS_Store";
/*
* We need to exclude the osgi bundles from being processed by AutoDeployer
* and let FileInstall monitor them.
*/
private static final String OSGI_AUTODEPLOY_DIR ="bundles";
private List FILE_NAMES_TO_IGNORE_FOR_AUTODEPLOY =
new ArrayList();
protected String statDir = null;
public AutoDeployedFilesManager() {
}
protected AutoDeployedFilesManager(String s) {
statDir = s;
FILE_NAMES_TO_IGNORE_FOR_AUTODEPLOY.add(DS_STORE);
FILE_NAMES_TO_IGNORE_FOR_AUTODEPLOY.add(OSGI_AUTODEPLOY_DIR);
}
/**
* Create an instance from the persisted file in the specified directory.
* @param statusDir Directory in which the status file is to read.
*/
public static AutoDeployedFilesManager loadStatus(File statusDir) throws Exception {
return loadStatus(statusDir.getAbsolutePath());
}
public static AutoDeployedFilesManager loadStatus(String autoDeploymentDir) throws Exception {
String statusDir = autoDeploymentDir + File.separator + STATUS_DIR_NAME;
AutoDeployedFilesManager adfm = new AutoDeployedFilesManager(statusDir);
return adfm;
}
public void writeStatus() throws Exception {
// Nothing to do
}
/**
* Update the status of the file as deployed.
*
*/
public void setDeployedFileInfo(File f) throws Exception {
try {
File statusFile = getStatusFile(f);
if ( ! statusFile.createNewFile()) {
deplLogger.log(Level.WARNING,
CREATE_FAILED,
statusFile.getAbsolutePath());
}
if ( ! statusFile.setLastModified(f.lastModified())) {
deplLogger.log(Level.WARNING,
MODIFIED_DATE_FAILED,
statusFile.getAbsolutePath());
}
} catch (Exception e) { throw e; }
}
/*
* Delete status info for file
*/
public void deleteDeployedFileInfo(File f) throws Exception {
try {
File statusFile = getStatusFile(f);
if ( ! statusFile.delete()) {
deplLogger.log(Level.WARNING,
DELETE_FAILED,
f.getAbsolutePath());
}
} catch (Exception e) { throw e;}
}
// calculate the status file path.
private File getStatusFile(File f) {
File outDir = new File(this.statDir);
outDir = obtainFileStatusDir(f, outDir, outDir.getParentFile());
return new File(outDir, f.getName());
}
static File obtainFileStatusDir(File f, File statDir, File autoDeployDir) {
File dir = f.getParentFile();
while (!dir.getAbsolutePath().equals(autoDeployDir.getAbsolutePath())) {
statDir = new File(statDir, dir.getName());
dir = dir.getParentFile();
}
/*
* Do not create all the required directories if the ancestor
* autoDeployDir does not already exist. This helps with a race condition
* in which a user has stopped the domain (which returns before the
* domain has really stopped) and then deleted the domain. In some
* cases the delete-domain processing deletes files only for the
* autodeployer - still running - to create the autodeploy directory
* and all intervening ones again.
*/
if (autoDeployDir.exists()) {
if ( ! statDir.exists() && ! statDir.mkdirs()) {
deplLogger.log(Level.WARNING,
MKDIRS_FAILED,
autoDeployDir.getAbsolutePath());
}
}
return statDir;
}
/**
* Compare the list of files with the current status info
* and determine the files that need to be deployed
*
*/
public File[] getFilesForDeployment(File[] latestFiles) {
if (latestFiles == null) return new File[0];
ArrayList arrList = new ArrayList();
for (File deployDirFile : latestFiles) {
if (FILE_NAMES_TO_IGNORE_FOR_AUTODEPLOY.contains(deployDirFile.getName())) {
if (deplLogger.isLoggable(Level.FINE)) {
deplLogger.fine("Skipping " + deployDirFile.getAbsolutePath() + " because its name is in the list of files to ignore");
}
continue;
}
File statusFile = getStatusFile(deployDirFile);
if (!statusFile.exists() || deployDirFile.lastModified() != statusFile.lastModified()) {
if (deplLogger.isLoggable(Level.FINE)) {
deplLogger.fine("Including " + deployDirFile.getAbsolutePath() + " in candidate files for deployment");
}
arrList.add(deployDirFile);
} else {
if (deplLogger.isLoggable(Level.FINE)) {
deplLogger.fine("Skipping " + deployDirFile.getAbsolutePath() + " its status file exists and the timestamps on the status file and the autodeployed file match");
}
}
}
return arrList.toArray(new File[arrList.size()]);
}
/**
* Compare the list of files with the current status info
* and determine the apps that need to be undeployed.
*
*/
public File[] getFilesForUndeployment(File[] latestFiles) {
File statusDir = new File(statDir);
Set statusFiles =
AutoDeployDirectoryScanner.getListOfFilesAsSet(statusDir, true);
// The file might have been deleted. In that case, return null.
if (statusFiles == null || statusFiles.isEmpty()){
return null;
}
// now let's get the latestFiles status files names to remove them
// from the list of status files, any remaining ones will need to
// be undeployed
for (File deployDirFile : latestFiles) {
statusFiles.remove(getStatusFile(deployDirFile));
}
ArrayList appNames = new ArrayList();
File autodeployDir = statusDir.getParentFile();
for(File statusDirFile : statusFiles) {
// calculate the original file as it was copied in the autodeploy
// directory
File filePath = autodeployDir;
File f = statusDirFile.getParentFile();
while (!f.equals(statusDir)) {
filePath = new File(filePath, f.getName());
f = f.getParentFile();
}
filePath = new File(filePath, statusDirFile.getName());
// Make sure a _deployed marker exists for this file before
// trying to undeploy it.
File _deployedMarkerFile = new File(filePath + AutoDeployConstants.DEPLOYED);
if (_deployedMarkerFile.exists()) {
appNames.add(filePath);
}
}
// Add to the app names files any entries for which auto-undeployment
// has been requested by the user's creation of xxx_undeploy_requested.
appNames.addAll(getFilesToUndeployByRequest(autodeployDir, statusDir));
return appNames.toArray(new File[appNames.size()]);
}
/*
* Returns files to be undeployed due to the presence of a xxx_undeployRequested
* file in the autodeploy directory.
* @param latestFiles the files in the autodeploy directory
* @return Collection of File objects to undeploy due to the request marker files
*/
private Collection getFilesToUndeployByRequest(File autodeployDir, File statusDir) {
ArrayList appsRequested = new ArrayList();
for (File f : statusDir.listFiles()) {
/*
* See if there is a corresponding _undeployRequested file for this
* file.
*/
if (isUndeployRequested(autodeployDir, f)) {
appsRequested.add(new UndeployRequestedFile(new File(autodeployDir, f.getName())));
}
}
if (deplLogger.isLoggable(Level.FINE) && ! appsRequested.isEmpty()) {
StringBuilder sb = new StringBuilder("Undeployment requested using *_undeployRequested for ");
for (File app : appsRequested) {
sb.append(" " + app.getName() + System.getProperty("line.separator"));
}
deplLogger.fine(sb.toString());
}
return appsRequested;
}
/*
* Returns whether there is a request to undeploy the specified file.
* @param f the file to check
* @return whether or not an undeployment has been requested for the specified file
*/
private static boolean isUndeployRequested(File autodeployDir, File f) {
return appToUndeployRequestFile(autodeployDir, f).exists();
}
/*
* Returns the File object for the undeployment request for the specified app
* file or directory.
* @param f the File to check for an undeployment request
* @return a File object for the undeploy request file itself
*/
protected static File appToUndeployRequestFile(File autodeployDir, File f) {
File undeployRequest = new File(autodeployDir, f.getName() + AutoDeployConstants.UNDEPLOY_REQUESTED);
return undeployRequest;
}
protected static File appToUndeployRequestFile(File f) {
return appToUndeployRequestFile(f.getParentFile(), f);
}
/*
* A marker class to indicate that the file is to be undeployed and then
* deleted by the autodeployer.
*/
protected static final class UndeployRequestedFile extends File {
public UndeployRequestedFile(File parent, String child) {
super(parent, child);
}
public UndeployRequestedFile(String path) {
super(path);
}
public UndeployRequestedFile(String parent, String child) {
super(parent, child);
}
public UndeployRequestedFile(URI uri) {
super(uri);
}
public UndeployRequestedFile(File f) {
super(f.getAbsolutePath());
}
}
}