org.archive.bdb.KryoBinding Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of heritrix-commons Show documentation

The Archive Commons Code Libraries project contains general Java utility libraries, as used by the Heritrix crawler and other projects.

There is a newer version: 3.4.0-20220727

Show newest version

/*
 *  This file is part of the Heritrix web crawler (crawler.archive.org).
 *
 *  Licensed to the Internet Archive (IA) by one or more individual 
 *  contributors. 
 *
 *  The IA licenses this file to You 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 org.archive.bdb;

import java.lang.ref.WeakReference;

import com.esotericsoftware.kryo.Kryo;
import com.esotericsoftware.kryo.ObjectBuffer;
import com.sleepycat.bind.EntryBinding;
import com.sleepycat.je.DatabaseEntry;

/**
 * Binding for use with BerkeleyDB-JE that uses Kryo serialization rather
 * than BDB's (custom version of) Java serialization.
 * 
 * @author gojomo
 */
public class KryoBinding implements EntryBinding {

    protected Class baseClass;
    protected AutoKryo kryo = new AutoKryo(); 
    protected ThreadLocal> threadBuffer = new ThreadLocal>() {
        @Override
        protected WeakReference initialValue() {
            return new WeakReference(new ObjectBuffer(kryo,16*1024,Integer.MAX_VALUE));
        }
    };
    
    /**
     * Constructor. Save parameters locally, as superclass 
     * fields are private. 
     * 
     * @param baseClass is the base class for serialized objects stored using
     * this binding
     */
    public KryoBinding(Class baseClass) {
        this.baseClass = baseClass;
        kryo.autoregister(baseClass);
        // TODO: reevaluate if explicit registration should be required
        kryo.setRegistrationOptional(true);
    }

    public Kryo getKryo() {
        return kryo;
    }
    
    private ObjectBuffer getBuffer() {
        WeakReference ref = threadBuffer.get();
        ObjectBuffer ob = ref.get();
        if (ob == null) {
            ob = new ObjectBuffer(kryo,16*1024,Integer.MAX_VALUE);
            threadBuffer.set(new WeakReference(ob));
        }
        return ob;        
    }
    
    /**
     * Copies superclass simply to allow different source for FastOoutputStream.
     * 
     * @see com.sleepycat.bind.serial.SerialBinding#entryToObject
     */
    public void objectToEntry(K object, DatabaseEntry entry) {
        entry.setData(getBuffer().writeObjectData(object));
    }

    @Override
    public K entryToObject(DatabaseEntry entry) {
        return getBuffer().readObjectData(entry.getData(), baseClass);
    }
}