com.sun.enterprise.admin.util.cache.AdminCacheFileStore Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2013 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] Payara Foundation and/or affiliates
package com.sun.enterprise.admin.util.cache;
import com.sun.enterprise.admin.util.AdminLoggerInfo;
import com.sun.enterprise.security.store.AsadminSecurityUtil;
import com.sun.enterprise.util.io.FileUtils;
import java.io.*;
import java.util.Date;
import java.util.logging.Level;
import java.util.logging.Logger;
/** {@link AdminCahce} based on file system.
* Singleton
*
* @author mmares
*/
public class AdminCacheFileStore implements AdminCache {
private static final String DEFAULT_FILENAME = "#default#.cache";
private static final AdminCacheFileStore instance = new AdminCacheFileStore();
private static final Logger logger = AdminLoggerInfo.getLogger();
private AdminCacheUtils adminCahceUtils = AdminCacheUtils.getInstance();
private AdminCacheFileStore() {
}
@Override
public A get(String key, Class clazz) {
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("Attribute key must be unempty.");
}
if (clazz == null) {
throw new IllegalArgumentException("Attribute clazz can not be null.");
}
DataProvider provider = adminCahceUtils.getProvider(clazz);
if (provider == null) {
return null;
}
try (InputStream is = getInputStream(key)) {
return (A) provider.toInstance(is, clazz);
} catch (FileNotFoundException ex) {
return null;
} catch (IOException ex) {
if (logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, AdminLoggerInfo.mCannotReadCache,
new Object[] { key });
}
return null;
}
}
private InputStream getInputStream(String key) throws IOException {
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("Attribute key must be unempty.");
}
if (!adminCahceUtils.validateKey(key)) {
throw new IllegalArgumentException("Attribute key must be in form (([-_.a-zA-Z0-9]+/?)+)");
}
File f = getCacheFile(key);
return new BufferedInputStream(new FileInputStream(f));
}
private File getCacheFile(String key) throws IOException{
File dir = AsadminSecurityUtil.getDefaultClientDir();
int idx = key.lastIndexOf('/');
if (idx > 0) {
dir = new File(dir, key.substring(0, idx));
if(!FileUtils.mkdirsMaybe(dir))
throw new IOException("Can't create directory: " + dir);
key = key.substring(idx + 1);
if (key.isEmpty()) {
key = DEFAULT_FILENAME;
}
}
return new File(dir, key);
}
@Override
public synchronized void put(String key, Object data) {
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("Attribute key must be unempty.");
}
if (!adminCahceUtils.validateKey(key)) {
throw new IllegalArgumentException("Attribute key must be in form (([-_.a-zA-Z0-9]+/?)+)");
}
if (data == null) {
throw new IllegalArgumentException("Attribute data can not be null.");
}
DataProvider provider = adminCahceUtils.getProvider(data.getClass());
if (provider == null) {
throw new IllegalStateException("There is no data provider for " + data.getClass());
}
File cacheFile;
try {
cacheFile = getCacheFile(key);
}
catch (IOException ex) {
return;
}
try {
File tempFile = File.createTempFile("temp", "cache", cacheFile.getParentFile());
try (OutputStream os = new BufferedOutputStream(new FileOutputStream(tempFile))) {
provider.writeToStream(data, os);
}
if (!FileUtils.deleteFileMaybe(cacheFile) || !tempFile.renameTo(cacheFile)) {
if (logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, AdminLoggerInfo.mCannotWriteCache,
new Object[] { cacheFile.getPath() });
}
if(!FileUtils.deleteFileMaybe(tempFile)) {
logger.log(Level.FINE, "can\'t delete file: {0}", tempFile);
}
}
} catch (IOException e) {
if (logger.isLoggable(Level.WARNING)) {
logger.log(Level.WARNING, AdminLoggerInfo.mCannotWriteCache,
new Object[] { cacheFile.getPath() });
}
}
}
@Override
public boolean contains(String key) {
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("Attribute key must be unempty.");
}
if (!adminCahceUtils.validateKey(key)) {
throw new IllegalArgumentException("Attribute key must be in form (([-_.a-zA-Z0-9]+/?)+)");
}
File cacheFile;
try {
cacheFile = getCacheFile(key);
}
catch (IOException ex) {
return false;
}
return cacheFile.exists() && cacheFile.isFile();
}
@Override
public Date lastUpdated(String key) {
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("Attribute key must be unempty.");
}
if (!adminCahceUtils.validateKey(key)) {
throw new IllegalArgumentException("Attribute key must be in form (([-_.a-zA-Z0-9]+/?)+)");
}
File cacheFile;
try {
cacheFile = getCacheFile(key);
}
catch (IOException ex) {
return null;
}
if (!cacheFile.exists() || !cacheFile.isFile()) {
return null;
}
return new Date(cacheFile.lastModified());
}
public static AdminCacheFileStore getInstance() {
return instance;
}
}