com.marklogic.appdeployer.command.ResourceFileManagerImpl Maven / Gradle / Ivy
Show all versions of ml-app-deployer Show documentation
/*
* Copyright (c) 2023 MarkLogic Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.marklogic.appdeployer.command;
import com.marklogic.client.ext.modulesloader.impl.PropertiesModuleManager;
import java.io.File;
import java.util.Date;
/**
* Extends the module-specific PropertiesModuleManager, as that class's behavior is exactly what's needed here as well.
* Just uses a different default file path for the properties file that keeps track of timestamps.
*/
public class ResourceFileManagerImpl extends PropertiesModuleManager implements ResourceFileManager {
public static final String DEFAULT_FILE_PATH = "build/com.marklogic.ml-app-deployer/resource-timestamps.properties";
public ResourceFileManagerImpl() {
this(DEFAULT_FILE_PATH);
}
public ResourceFileManagerImpl(String propertiesFilePath) {
super(propertiesFilePath);
}
/**
* One difference between this and the parent class is that if the resource file should be processed, its timestamp
* in the properties file is immediately updated, as opposed to that being done via a separate method.
*
* Note that this doesn't indicate that the resource file was successfully deployed. If an error occurs while
* deploying the resource, it is expected that a developer would then make a change to the resource file. If that
* doesn't occur - e.g. if the failure occurred due to an authentication issue, and thus the resource file doesn't
* have to be changed - the developer would need to turn off incremental support or delete the properties file that
* contains the timestamps.
*
* @param file
* @return
*/
@Override
public boolean shouldResourceFileBeProcessed(File file) {
// Need to initialize this on every check because the properties file may have been updated by
// some other command
this.initialize();
boolean shouldBeProcessed = hasFileBeenModifiedSinceLastLoaded(file);
if (shouldBeProcessed) {
if (logger.isDebugEnabled()) {
logger.debug("File is new or has been modified: " + file.getAbsolutePath());
}
super.saveLastLoadedTimestamp(file, new Date());
} else if (logger.isInfoEnabled()) {
logger.info("File is neither new nor modified: " + file.getAbsolutePath());
}
return shouldBeProcessed;
}
}