/*
* JBoss, Home of Professional Open Source
* Copyright 2009 Red Hat Inc. and/or its affiliates and other
* contributors as indicated by the @author tags. All rights reserved.
* See the copyright.txt in the distribution for a full listing of
* individual contributors.
*
* This 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 software 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 software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.infinispan.marshall.jboss;
import org.infinispan.config.GlobalConfiguration;
import org.infinispan.context.InvocationContext;
import org.infinispan.context.InvocationContextContainer;
import org.infinispan.marshall.StreamingMarshaller;
import org.jboss.marshalling.ClassResolver;
/**
* A JBoss Marshalling based marshaller that is oriented at internal, embedded,
* Infinispan usage. It uses of a custom object table for Infinispan based
* Externalizer instances that are either internal or user defined.
* <p />
* The reason why this is implemented specially in Infinispan rather than resorting to Java serialization or even the
* more efficient JBoss serialization is that a lot of efficiency can be gained when a majority of the serialization
* that occurs has to do with a small set of known types such as {@link org.infinispan.transaction.xa.GlobalTransaction} or
* {@link org.infinispan.commands.ReplicableCommand}, and class type information can be replaced with simple magic
* numbers.
* <p/>
* Unknown types (typically user data) falls back to Java serialization.
*
* @author Galder ZamarreƱo
* @author Sanne Grinovero
* @since 4.0
*/
public final class JBossMarshaller extends AbstractJBossMarshaller implements StreamingMarshaller {
ExternalizerTable externalizerTable;
public void inject(ExternalizerTable externalizerTable, ClassLoader cl,
InvocationContextContainer icc, GlobalConfiguration globalCfg) {
log.debug("Using JBoss Marshalling");
this.externalizerTable = externalizerTable;
baseCfg.setObjectTable(externalizerTable);
ClassResolver classResolver = globalCfg.getClassResolver();
if (classResolver == null) {
// Override the class resolver with one that can detect injected
// classloaders via AdvancedCache.with(ClassLoader) calls.
classResolver = new EmbeddedContextClassResolver(cl, icc);
}
baseCfg.setClassResolver(classResolver);
}
@Override
public void stop() {
super.stop();
// Just in case, to avoid leaking class resolver which references classloader
baseCfg.setClassResolver(null);
}
@Override
public boolean isMarshallableCandidate(Object o) {
return super.isMarshallableCandidate(o) || externalizerTable.isMarshallableCandidate(o);
}
/**
* An embedded context class resolver that is able to retrieve a class
* loader from the embedded Infinispan call context. This might happen when
* {@link org.infinispan.AdvancedCache#with(ClassLoader)} is used.
*/
public static final class EmbeddedContextClassResolver extends DefaultContextClassResolver {
private final InvocationContextContainer icc;
public EmbeddedContextClassResolver(ClassLoader defaultClassLoader, InvocationContextContainer icc) {
super(defaultClassLoader);
this.icc = icc;
}
@Override
protected ClassLoader getClassLoader() {
if (icc != null) {
InvocationContext ctx = icc.getInvocationContext(true);
if (ctx != null) {
ClassLoader cl = ctx.getClassLoader();
if (cl != null) return cl;
}
}
return super.getClassLoader();
}
}
}