org.glassfish.deployment.autodeploy.AutoDeployDirectoryScanner Maven / Gradle / Ivy
Show all versions of payara-embedded-web Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2018-2019] Payara Foundation and/or affiliates
/*
* DirectoryScanner.java
*
*
* Created on February 19, 2003, 10:17 AM
*/
package org.glassfish.deployment.autodeploy;
import com.sun.enterprise.util.LocalStringManagerImpl;
import java.io.File;
import java.util.Set;
import java.util.HashSet;
import java.util.logging.Logger;
import java.util.logging.LogRecord;
import java.util.logging.Level;
import org.glassfish.logging.annotation.LogMessageInfo;
/**
* Implementation of Directory scanner for autodeployment
* Providing functionality for scanning the input source directory
* and return the list of deployable components for autodeployment.
* Provide the list of deployable modules/application, depending upon the "type" entry
* passed to getAllDeployableEntity(File autodeployDir, String type).
*
*@author vikas
*/
public class AutoDeployDirectoryScanner implements DirectoryScanner{
public static final Logger deplLogger =
org.glassfish.deployment.autodeploy.AutoDeployer.deplLogger;
@LogMessageInfo(message = "Error occurred: {0}", cause="An exception was caught when the operation was attempted", action="See the exception to determine how to fix the error", level="SEVERE")
private static final String EXCEPTION_OCCURRED = "NCLS-DEPLOYMENT-00040";
private static final LocalStringManagerImpl localStrings = new LocalStringManagerImpl(AutoDeployDirectoryScanner.class);
public AutoDeployDirectoryScanner() {
}
@Override
public void deployedEntity(File autodeployDir, File deployedEntity) {
try {
AutoDeployedFilesManager adfm = AutoDeployedFilesManager.loadStatus(autodeployDir);
adfm.setDeployedFileInfo(deployedEntity);
adfm.writeStatus();
} catch (Exception e) {
printException(e);
// Do nothing
}
}
@Override
public void undeployedEntity(File autodeployDir, File undeployedEntity) {
try {
AutoDeployedFilesManager adfm = AutoDeployedFilesManager.loadStatus(autodeployDir);
adfm.deleteDeployedFileInfo(undeployedEntity);
adfm.writeStatus();
} catch (Exception e) {
printException(e);
// Do nothing
}
}
/**
* return true if any new deployable entity is present in autodeployDir
* @param autodeployDir
* @return
*/
@Override
public boolean hasNewDeployableEntity(File autodeployDir) {
boolean newFilesExist=false;
try {
AutoDeployedFilesManager adfm = AutoDeployedFilesManager.loadStatus(autodeployDir);
if(adfm.getFilesForDeployment(getListOfFiles(autodeployDir)).length > 0) {
//atleast one new file is there
newFilesExist=true;
}
} catch (Exception e) {
printException(e);
return false;
}
return newFilesExist;
}
// this should never be called from system dir autodeploy code...
@Override
public File[] getAllFilesForUndeployment(File autodeployDir, boolean includeSubdir) {
try {
AutoDeployedFilesManager adfm = AutoDeployedFilesManager.loadStatus(autodeployDir);
return adfm.getFilesForUndeployment(getListOfFiles(autodeployDir, includeSubdir));
} catch (Exception e) {
printException(e);
return new File[0];
}
}
/**
* Get the list of all deployable files
* @param autodeployDir
* @param includeSubDir
* @return */
public File[] getAllDeployableModules(File autodeployDir, boolean includeSubDir) {
AutoDeployedFilesManager adfm = null;
try {
adfm = AutoDeployedFilesManager.loadStatus(autodeployDir);
} catch (Exception e) {
printException(e);
return new File[0];
}
return adfm.getFilesForDeployment(getListOfFiles(autodeployDir, includeSubDir));
}
protected void printException(Exception e) {
LogRecord lr = new LogRecord(Level.SEVERE, EXCEPTION_OCCURRED);
Object args[] = { e.getMessage() };
lr.setParameters(args);
lr.setThrown(e);
deplLogger.log(lr);
}
protected File[] getListOfFiles(File dir) {
return getListOfFiles(dir, false);
}
protected File[] getListOfFiles(File dir, boolean includeSubDir) {
final Set fileSet = getListOfFilesAsSet(dir, includeSubDir);
return fileSet.toArray(new File[fileSet.size()]);
}
static Set getListOfFilesAsSet(File dir, boolean includeSubDir) {
Set result = new HashSet();
File[] dirFiles = dir.listFiles();
if (dirFiles == null) {
return null;
}
for (File dirFile : dirFiles) {
String name = dirFile.getName();
String fileType = name.substring(name.lastIndexOf('.') + 1);
if ( ! dirFile.isDirectory()) {
if (fileType != null && !fileType.equals("") &&
! typeIsMarkerType(fileType)) {
result.add(dirFile);
continue;
}
} else {
if (! dirFile.getName().equals(AutoDeployer.STATUS_SUBDIR_PATH)) {
if (includeSubDir) {
result.addAll(getListOfFilesAsSet(dirFile, true));
} else {
result.add(dirFile);
}
}
}
}
return result;
}
private static boolean typeIsMarkerType(String fileType) {
for (String markerSuffix : AutoDeployConstants.MARKER_FILE_SUFFIXES) {
if (fileType.endsWith(markerSuffix)) {
return true;
}
}
return false;
}
}