/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2000-2010 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.
*/
/*
* @(#)PropertiesFile.java 1.22 08/28/07
*/
package com.sun.messaging.jmq.jmsserver.persist.file;
import com.sun.messaging.jmq.jmsserver.config.*;
import com.sun.messaging.jmq.util.PHashMap;
import com.sun.messaging.jmq.util.PHashMapLoadException;
import com.sun.messaging.jmq.io.VRFileWarning;
import com.sun.messaging.jmq.util.log.Logger;
import com.sun.messaging.jmq.util.SizeString;
import com.sun.messaging.jmq.jmsserver.Globals;
import com.sun.messaging.jmq.jmsserver.util.*;
import com.sun.messaging.jmq.jmsserver.resources.*;
import com.sun.messaging.jmq.jmsserver.persist.Store;
import com.sun.messaging.jmq.jmsserver.persist.LoadException;
import java.io.*;
import java.util.*;
/**
* Keep track of persisted properties by using PHashMap.
*/
class PropertiesFile {
Logger logger = Globals.getLogger();
BrokerResources br = Globals.getBrokerResources();
BrokerConfig config = Globals.getConfig();
// initial size of backing file
static final String PROP_FILE_SIZE_PROP
= FileStore.FILE_PROP_PREFIX + "property.file.size";
static final long DEFAULT_PROP_FILE_SIZE = 1024; // 1024k = 1M
static final String BASENAME = "property"; // basename of properties file
// all persisted properties
// maps property name -> property value
private PHashMap propMap = null;
private File backingFile = null;
private LoadException loadException = null;
// when instantiated, all data are loaded
PropertiesFile(File topDir, boolean clear) throws BrokerException {
SizeString filesize = config.getSizeProperty(PROP_FILE_SIZE_PROP,
DEFAULT_PROP_FILE_SIZE);
backingFile = new File(topDir, BASENAME);
try {
// safe=false; caller controls data synchronization
propMap = new PHashMap(backingFile, filesize.getBytes(),
false, clear);
} catch (IOException e) {
logger.logStack(logger.ERROR, br.X_LOAD_PROPERTIES_FAILED, e);
throw new BrokerException(
br.getString(br.X_LOAD_PROPERTIES_FAILED), e);
}
try {
propMap.load();
} catch (IOException e) {
logger.logStack(logger.ERROR, br.X_LOAD_PROPERTIES_FAILED, e);
throw new BrokerException(
br.getString(br.X_LOAD_PROPERTIES_FAILED), e);
} catch (ClassNotFoundException e) {
logger.logStack(logger.ERROR, br.X_LOAD_PROPERTIES_FAILED, e);
throw new BrokerException(
br.getString(br.X_LOAD_PROPERTIES_FAILED), e);
} catch (PHashMapLoadException le) {
while (le != null) {
logger.log(Logger.WARNING, br.X_FAILED_TO_LOAD_A_PROPERTY, le);
// save info in LoadException
LoadException e = new LoadException(le.getMessage(),
le.getCause());
e.setKey(le.getKey());
e.setValue(le.getValue());
e.setKeyCause(le.getKeyCause());
e.setValueCause(le.getValueCause());
e.setNextException(loadException);
loadException = e;
// get the chained exception
le = le.getNextException();
}
}
VRFileWarning w = propMap.getWarning();
if (w != null) {
logger.log(logger.WARNING,
"possible loss of persisted properties", w);
}
if (clear && Store.getDEBUG()) {
logger.log(logger.DEBUGHIGH,
"PropertiesFile initialized with clear option");
}
if (Store.getDEBUG()) {
logger.log(logger.DEBUG, "PropertiesFile: loaded " +
propMap.size() + " properties");
}
}
LoadException getLoadException() {
return loadException;
}
// when instantiated, old data are upgraded
PropertiesFile(FileStore p, File topDir, File oldTop)
throws BrokerException {
File oldFile = new File(oldTop, BASENAME);
PHashMap olddata = null;
backingFile = new File(topDir, BASENAME);
try {
// load old data
// safe=false; reset=false
olddata = new PHashMap(oldFile, false, false);
} catch (IOException e) {
logger.log(logger.ERROR, br.X_UPGRADE_PROPERTIES_FAILED,
oldFile, backingFile, e);
throw new BrokerException(
br.getString(br.X_UPGRADE_PROPERTIES_FAILED,
oldFile, backingFile), e);
}
try {
olddata.load();
} catch (IOException e) {
logger.log(logger.ERROR, br.X_UPGRADE_PROPERTIES_FAILED, oldFile,
backingFile, e);
throw new BrokerException(
br.getString(br.X_UPGRADE_PROPERTIES_FAILED,
oldFile, backingFile), e);
} catch (ClassNotFoundException e) {
logger.log(logger.ERROR, br.X_UPGRADE_PROPERTIES_FAILED, oldFile,
backingFile, e);
throw new BrokerException(
br.getString(br.X_UPGRADE_PROPERTIES_FAILED,
oldFile, backingFile), e);
} catch (PHashMapLoadException le) {
while (le != null) {
logger.log(Logger.WARNING,
br.X_FAILED_TO_LOAD_A_PROPERTY_FROM_OLDSTORE, le);
// save info in LoadException
LoadException e = new LoadException(le.getMessage(),
le.getCause());
e.setKey(le.getKey());
e.setValue(le.getValue());
e.setKeyCause(le.getKeyCause());
e.setValueCause(le.getValueCause());
e.setNextException(loadException);
loadException = e;
// get the chained exception
le = le.getNextException();
}
}
VRFileWarning w = olddata.getWarning();
if (w != null) {
logger.log(logger.WARNING,
"possible loss of persisted properties in old store", w);
}
try {
// pass in safe=false; let caller decide when to sync
// safe=false; reset=false
propMap = new PHashMap(backingFile, oldFile.length(), false, false);
} catch (IOException e) {
logger.log(logger.ERROR, br.X_UPGRADE_DESTINATIONS_FAILED,
oldFile, backingFile, e);
throw new BrokerException(
br.getString(br.X_UPGRADE_DESTINATIONS_FAILED,
oldFile, backingFile), e);
}
try {
propMap.load();
} catch (IOException e) {
// should not happen so throw exception
logger.log(logger.ERROR, br.X_UPGRADE_PROPERTIES_FAILED, oldFile,
backingFile, e);
throw new BrokerException(
br.getString(br.X_UPGRADE_PROPERTIES_FAILED,
oldFile, backingFile), e);
} catch (ClassNotFoundException e) {
// should not happen so throw exception
logger.log(logger.ERROR, br.X_UPGRADE_PROPERTIES_FAILED, oldFile,
backingFile, e);
throw new BrokerException(
br.getString(br.X_UPGRADE_PROPERTIES_FAILED,
oldFile, backingFile), e);
} catch (PHashMapLoadException e) {
// should not happen so throw exception
logger.log(logger.ERROR, br.X_UPGRADE_PROPERTIES_FAILED,
oldFile, backingFile, e);
throw new BrokerException(
br.getString(br.X_UPGRADE_PROPERTIES_FAILED,
oldFile, backingFile), e);
}
w = propMap.getWarning();
if (w != null) {
logger.log(logger.WARNING,
"possible loss of persisted properties", w);
}
// just copy old data to new store
Iterator itr = olddata.entrySet().iterator();
while (itr.hasNext()) {
Map.Entry entry = (Map.Entry)itr.next();
Object key = entry.getKey();
Object value = entry.getValue();
propMap.put(key, value);
}
olddata.close();
// if upgradeNoBackup, remove oldfile
if (p.upgradeNoBackup()) {
if (!oldFile.delete()) {
logger.log(logger.ERROR, br.I_DELETE_FILE_FAILED, oldFile);
}
}
}
/**
* Persist the specified property name/value pair.
* If the property identified by name exists in the store already,
* it's value will be updated with the new value.
* If value is null, the property will be removed.
* The value object needs to be serializable.
*
* @param name name of the property
* @param value value of the property
* @exception BrokerException if an error occurs while persisting the
* timestamp
*/
void updateProperty(String name, Object value, boolean sync)
throws BrokerException {
try {
boolean updated = false;
if (value == null) {
// remove it
Object old = propMap.remove(name);
updated = (old != null);
} else {
// update it
propMap.put(name, value);
updated = true;
}
if (updated && sync) {
sync();
}
} catch (RuntimeException e) {
logger.log(logger.ERROR, br.X_PERSIST_PROPERTY_FAILED, name);
throw new BrokerException(
br.getString(br.X_PERSIST_PROPERTY_FAILED, name), e);
}
}
/**
* Retrieve the value for the specified property.
*
* @param name name of the property whose value is to be retrieved
* @return the property value; null is returned if the specified
* property does not exist in the store
* @exception BrokerException if an error occurs while retrieving the
* data
* @exception NullPointerException if <code>name</code> is
* <code>null</code>
*/
Object getProperty(String name) throws BrokerException {
return propMap.get(name);
}
/**
* Return the names of all persisted properties.
*
* @return an array of property names; an empty array will be returned
* if no property exists in the store.
*/
String[] getPropertyNames() throws BrokerException {
Set keys = propMap.keySet();
return (String[])keys.toArray(new String[keys.size()]);
}
Properties getProperties() throws BrokerException {
Properties props = new Properties();
Iterator itr = propMap.entrySet().iterator();
while (itr.hasNext()) {
Map.Entry e = (Map.Entry)itr.next();
props.put(e.getKey(), e.getValue());
}
return props;
}
/**
* Clear all records
*/
// clear the store; when this method returns, the store has a state
// that is the same as an empty store
void clearAll(boolean sync) {
if (Store.getDEBUG()) {
logger.log(logger.DEBUGHIGH, "PropertiesFile.clearAll() called");
}
propMap.clear();
if (sync) {
try {
sync();
} catch (BrokerException e) {
logger.log(logger.ERROR,
"Got exception while synchronizing data to disk", e);
}
}
}
void close(boolean cleanup) {
if (Store.getDEBUG()) {
logger.log(logger.DEBUGHIGH,
"PropertiesFile: closing, "+propMap.size()+
" properties");
}
propMap.close();
}
/**
* Get debug information about the store.
* @return A Hashtable of name value pair of information
*/
Hashtable getDebugState() {
Hashtable t = new Hashtable();
t.put("Properties", String.valueOf(propMap.size()));
return t;
}
// for internal use; not synchronized
void printInfo(PrintStream out) {
out.println("\nProperties");
out.println("----------");
out.println("backing file: "+ backingFile);
// print all property name/value pairs
Set entries = propMap.entrySet();
Iterator itor = entries.iterator();
while (itor.hasNext()) {
Map.Entry entry = (Map.Entry)itor.next();
out.println((String)entry.getKey() + "="
+ entry.getValue().toString());
}
}
private void sync() throws BrokerException {
try {
if(Store.getDEBUG_SYNC())
{
String msg = "PropertiesFile sync()";
logger.log(Logger.DEBUG,msg);
}
propMap.force();
} catch (IOException e) {
throw new BrokerException(
"Failed to synchronize file: " + backingFile, e);
}
}
}