Started refactorying the config object registry so that we can make a
database-backed implementation to replace the Java preferences backed version. git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3869 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
@@ -0,0 +1,337 @@
|
||||
//
|
||||
// $Id$
|
||||
//
|
||||
// Narya library - tools for developing networked games
|
||||
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
|
||||
// http://www.threerings.net/code/narya/
|
||||
//
|
||||
// This library is free software; you can redistribute it and/or modify it
|
||||
// under the terms of the GNU Lesser General Public License as published
|
||||
// by the Free Software Foundation; either version 2.1 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
// Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public
|
||||
// License along with this library; if not, write to the Free Software
|
||||
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
package com.threerings.admin.server;
|
||||
|
||||
import java.io.ByteArrayInputStream;
|
||||
import java.io.IOException;
|
||||
import java.lang.reflect.Field;
|
||||
import java.lang.reflect.Modifier;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.Iterator;
|
||||
|
||||
import com.samskivert.io.ByteArrayOutInputStream;
|
||||
import com.samskivert.util.Config;
|
||||
import com.samskivert.util.StringUtil;
|
||||
|
||||
import com.threerings.io.ObjectInputStream;
|
||||
import com.threerings.io.ObjectOutputStream;
|
||||
import com.threerings.io.Streamable;
|
||||
|
||||
import com.threerings.presents.dobj.AccessController;
|
||||
import com.threerings.presents.dobj.AttributeChangeListener;
|
||||
import com.threerings.presents.dobj.AttributeChangedEvent;
|
||||
import com.threerings.presents.dobj.DObject;
|
||||
import com.threerings.presents.dobj.DSet;
|
||||
import com.threerings.presents.dobj.EntryAddedEvent;
|
||||
import com.threerings.presents.dobj.EntryRemovedEvent;
|
||||
import com.threerings.presents.dobj.EntryUpdatedEvent;
|
||||
import com.threerings.presents.dobj.SetListener;
|
||||
|
||||
import com.threerings.admin.Log;
|
||||
import com.threerings.presents.dobj.ObjectAccessException;
|
||||
|
||||
/**
|
||||
* Implements the {@link ConfigRegistry} using the Java preferences system as a
|
||||
* persistent store for the configuration information (see {@link Config} for
|
||||
* more information on how that works).
|
||||
*/
|
||||
public class PrefsConfigRegistry extends ConfigRegistry
|
||||
{
|
||||
// documentation inherited
|
||||
public void registerObject (String key, String path, DObject object)
|
||||
{
|
||||
// create a new config record for this object
|
||||
_configs.put(key, new ConfObjRecord(path, object));
|
||||
}
|
||||
|
||||
// documentation inherited
|
||||
public DObject getObject (String key)
|
||||
{
|
||||
ConfObjRecord record = (ConfObjRecord)_configs.get(key);
|
||||
return (record == null) ? null : record.confObj;
|
||||
}
|
||||
|
||||
// documentation inherited
|
||||
public String[] getKeys ()
|
||||
{
|
||||
String[] keys = new String[_configs.size()];
|
||||
Iterator iter = _configs.keySet().iterator();
|
||||
for (int ii = 0; iter.hasNext(); ii++) {
|
||||
keys[ii] = (String)iter.next();
|
||||
}
|
||||
return keys;
|
||||
}
|
||||
|
||||
/**
|
||||
* Contains all necessary info for a configuration object registration.
|
||||
*/
|
||||
protected static class ConfObjRecord
|
||||
implements AttributeChangeListener, SetListener
|
||||
{
|
||||
public DObject confObj;
|
||||
public Config config;
|
||||
|
||||
public ConfObjRecord (String path, DObject confObj)
|
||||
{
|
||||
this.config = new Config(path);
|
||||
this.confObj = confObj;
|
||||
|
||||
// read in the initial configuration settings from the persistent
|
||||
// configuration repository
|
||||
Class cclass = confObj.getClass();
|
||||
try {
|
||||
Field[] fields = cclass.getFields();
|
||||
for (int ii = 0; ii < fields.length; ii++) {
|
||||
int mods = fields[ii].getModifiers();
|
||||
if ((mods & Modifier.STATIC) != 0 ||
|
||||
(mods & Modifier.PUBLIC) == 0 ||
|
||||
(mods & Modifier.TRANSIENT) != 0) {
|
||||
continue;
|
||||
}
|
||||
initField(fields[ii]);
|
||||
}
|
||||
|
||||
// listen for attribute updates
|
||||
confObj.addListener(this);
|
||||
|
||||
} catch (SecurityException se) {
|
||||
Log.warning("Unable to reflect on " + cclass.getName() + ": " +
|
||||
se + ". Refusing to monitor object.");
|
||||
}
|
||||
}
|
||||
|
||||
// documentation inherited
|
||||
public void entryAdded (EntryAddedEvent event)
|
||||
{
|
||||
serializeAttribute(event.getName());
|
||||
}
|
||||
|
||||
// documentation inherited
|
||||
public void entryUpdated (EntryUpdatedEvent event)
|
||||
{
|
||||
serializeAttribute(event.getName());
|
||||
}
|
||||
|
||||
// documentation inherited
|
||||
public void entryRemoved (EntryRemovedEvent event)
|
||||
{
|
||||
serializeAttribute(event.getName());
|
||||
}
|
||||
|
||||
public void attributeChanged (AttributeChangedEvent event)
|
||||
{
|
||||
// mirror this configuration update to the on-disk config
|
||||
String key = fieldToKey(event.getName());
|
||||
Object value = event.getValue();
|
||||
|
||||
if (value instanceof Boolean) {
|
||||
config.setValue(key, ((Boolean)value).booleanValue());
|
||||
} else if (value instanceof Short) {
|
||||
config.setValue(key, ((Short)value).shortValue());
|
||||
} else if (value instanceof Integer) {
|
||||
config.setValue(key, ((Integer)value).intValue());
|
||||
} else if (value instanceof Long) {
|
||||
config.setValue(key, ((Long)value).longValue());
|
||||
} else if (value instanceof Float) {
|
||||
config.setValue(key, ((Float)value).floatValue());
|
||||
} else if (value instanceof String) {
|
||||
config.setValue(key, (String)value);
|
||||
} else if (value instanceof float[]) {
|
||||
config.setValue(key, (float[])value);
|
||||
} else if (value instanceof int[]) {
|
||||
config.setValue(key, (int[])value);
|
||||
} else if (value instanceof String[]) {
|
||||
config.setValue(key, (String[])value);
|
||||
} else if (value instanceof long[]) {
|
||||
config.setValue(key, (long[]) value);
|
||||
} else if (value instanceof DSet) {
|
||||
serializeAttribute(event.getName());
|
||||
} else {
|
||||
Log.info("Unable to flush config object change " +
|
||||
"[cobj=" + confObj.getClass().getName() +
|
||||
", key=" + key +
|
||||
", type=" + value.getClass().getName() +
|
||||
", value=" + value + "].");
|
||||
}
|
||||
}
|
||||
|
||||
/** Initializes a single field of a config distributed object from
|
||||
* its corresponding value in the associated config repository. */
|
||||
protected void initField (Field field)
|
||||
{
|
||||
String key = fieldToKey(field.getName());
|
||||
Class type = field.getType();
|
||||
|
||||
try {
|
||||
if (type.equals(Boolean.TYPE)) {
|
||||
boolean defval = field.getBoolean(confObj);
|
||||
field.setBoolean(confObj, config.getValue(key, defval));
|
||||
|
||||
} else if (type.equals(Short.TYPE)) {
|
||||
short defval = field.getShort(confObj);
|
||||
defval = (short)config.getValue(key, defval);
|
||||
field.setShort(confObj, defval);
|
||||
|
||||
} else if (type.equals(Integer.TYPE)) {
|
||||
int defval = field.getInt(confObj);
|
||||
field.setInt(confObj, config.getValue(key, defval));
|
||||
|
||||
} else if (type.equals(Long.TYPE)) {
|
||||
long defval = field.getLong(confObj);
|
||||
field.setLong(confObj, config.getValue(key, defval));
|
||||
|
||||
} else if (type.equals(Float.TYPE)) {
|
||||
float defval = field.getFloat(confObj);
|
||||
field.setFloat(confObj, config.getValue(key, defval));
|
||||
|
||||
} else if (type.equals(String.class)) {
|
||||
String defval = (String)field.get(confObj);
|
||||
field.set(confObj, config.getValue(key, defval));
|
||||
|
||||
} else if (type.equals(INT_ARRAY_PROTO.getClass())) {
|
||||
int[] defval = (int[])field.get(confObj);
|
||||
field.set(confObj, config.getValue(key, defval));
|
||||
|
||||
} else if (type.equals(FLOAT_ARRAY_PROTO.getClass())) {
|
||||
float[] defval = (float[])field.get(confObj);
|
||||
field.set(confObj, config.getValue(key, defval));
|
||||
|
||||
} else if (type.equals(STRING_ARRAY_PROTO.getClass())) {
|
||||
String[] defval = (String[])field.get(confObj);
|
||||
field.set(confObj, config.getValue(key, defval));
|
||||
|
||||
} else if (type.equals(LONG_ARRAY_PROTO.getClass())) {
|
||||
long[] defval = (long[])field.get(confObj);
|
||||
field.set(confObj, config.getValue(key, defval));
|
||||
|
||||
} else if (Streamable.class.isAssignableFrom(type)) {
|
||||
// don't freak out if the conf is blank.
|
||||
String value = config.getValue(key, "");
|
||||
if (StringUtil.isBlank(value)) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
ByteArrayInputStream bin = new ByteArrayInputStream(
|
||||
StringUtil.unhexlate(value));
|
||||
ObjectInputStream oin = new ObjectInputStream(bin);
|
||||
field.set(confObj, oin.readObject());
|
||||
} catch (Exception e) {
|
||||
Log.warning("Failure decoding config value [type=" +
|
||||
type + ", field=" + field + ", exception=" +
|
||||
e + "].");
|
||||
}
|
||||
|
||||
} else {
|
||||
Log.warning("Can't init field of unknown type " +
|
||||
"[cobj=" + confObj.getClass().getName() +
|
||||
", key=" + key +
|
||||
", type=" + type.getName() + "].");
|
||||
}
|
||||
|
||||
} catch (IllegalAccessException iae) {
|
||||
Log.warning("Can't set field " +
|
||||
"[cobj=" + confObj.getClass().getName() +
|
||||
", key=" + key + ", error=" + iae + "].");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a mixed case field name (for example,
|
||||
* <code>millisPerTick</code>) to a lower case, underscored key
|
||||
* name (in this case, <code>millis_per_tick</code>).
|
||||
*/
|
||||
protected String fieldToKey (String fieldName)
|
||||
{
|
||||
StringBuffer key = new StringBuffer();
|
||||
int flength = fieldName.length();
|
||||
boolean seenLower = false;
|
||||
for (int ii = 0; ii < flength; ii++) {
|
||||
char c = fieldName.charAt(ii);
|
||||
if (Character.isUpperCase(c)) {
|
||||
if (seenLower) {
|
||||
key.append("_");
|
||||
}
|
||||
key.append(Character.toLowerCase(c));
|
||||
seenLower = false;
|
||||
} else {
|
||||
key.append(c);
|
||||
seenLower = true;
|
||||
}
|
||||
}
|
||||
return key.toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the specified attribute from the configuration object, and
|
||||
* serialize it.
|
||||
*/
|
||||
protected void serializeAttribute (String attributeName)
|
||||
{
|
||||
String key = fieldToKey(attributeName);
|
||||
Object value;
|
||||
try {
|
||||
value = confObj.getAttribute(attributeName);
|
||||
} catch (ObjectAccessException oae) {
|
||||
Log.warning("Exception getting field [name=" + attributeName +
|
||||
"exception=" + oae + "].");
|
||||
return;
|
||||
}
|
||||
|
||||
if (value instanceof Streamable) {
|
||||
serialize(key, value);
|
||||
} else {
|
||||
Log.info("Unable to flush config object change " +
|
||||
"[cobj=" + confObj.getClass().getName() +
|
||||
", key=" + key +
|
||||
", type=" + value.getClass().getName() +
|
||||
", value=" + value + "].");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Save the specified object as serialized data associated with
|
||||
* the specified key.
|
||||
*/
|
||||
protected void serialize (String key, Object value)
|
||||
{
|
||||
ByteArrayOutInputStream out = new ByteArrayOutInputStream();
|
||||
ObjectOutputStream oout = new ObjectOutputStream(out);
|
||||
try {
|
||||
oout.writeObject(value);
|
||||
oout.flush();
|
||||
config.setValue(key, StringUtil.hexlate(out.toByteArray()));
|
||||
} catch (IOException ioe) {
|
||||
Log.info("Error serializing value " + value);
|
||||
}
|
||||
}
|
||||
|
||||
protected static final int[] INT_ARRAY_PROTO = new int[0];
|
||||
protected static final float[] FLOAT_ARRAY_PROTO = new float[0];
|
||||
protected static final String[] STRING_ARRAY_PROTO = new String[0];
|
||||
protected static final long[] LONG_ARRAY_PROTO = new long[0];
|
||||
}
|
||||
|
||||
/** A mapping from identifying key to config object. */
|
||||
protected HashMap _configs = new HashMap();
|
||||
}
|
||||
Reference in New Issue
Block a user