/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. 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.jboss.remoting.marshal;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.management.MBeanServer;
import javax.management.ObjectName;
import org.jboss.logging.Logger;
import org.jboss.mx.loading.LoaderRepository;
import org.jboss.mx.loading.RepositoryClassLoader;
import org.jboss.remoting.InvocationRequest;
import org.jboss.remoting.InvokerLocator;
import org.jboss.remoting.ServerInvocationHandler;
import org.jboss.remoting.ServerInvoker;
import org.jboss.remoting.callback.InvokerCallbackHandler;
import org.jboss.remoting.loading.ClassBytes;
import org.jboss.remoting.loading.ClassUtil;
/**
* The invocation handler that receives requests for getting marshallers/unmarshallers and
* loading of these and any related classes to remoting client.
*
* @author <a href="mailto:tom@jboss.org">Tom Elrod</a>
*/
public class MarshallerLoaderHandler implements ServerInvocationHandler, MarshallerLoaderConstants
{
private ServerInvoker invoker = null;
private MBeanServer server = null;
private List repositories;
protected final static Logger log = Logger.getLogger(MarshallerLoaderHandler.class);
public MarshallerLoaderHandler(List repositories)
{
this.repositories = repositories;
}
/**
* set the mbean server that the handler can reference
*
* @param server
*/
public void setMBeanServer(MBeanServer server)
{
this.server = server;
}
/**
* set the invoker that owns this handler
*
* @param invoker
*/
public void setInvoker(ServerInvoker invoker)
{
this.invoker = invoker;
}
/**
* called to handle a specific invocation. Please take care to make sure implementations are thread safe and can,
* and often will, receive concurrent calls on this method.
*
* @param invocation
* @return
* @throws Throwable
*/
public Object invoke(InvocationRequest invocation)
throws Throwable
{
Object ret = null;
Object param = invocation.getParameter();
Map metadMap = invocation.getRequestPayload();
if(metadMap == null)
{
throw new RuntimeException("Can not load class as invocation request metadat map is null.");
}
String dataType = (String) metadMap.get(InvokerLocator.DATATYPE);
log.debug("MarshallerLoaderHandler received invocation with param of " + param + " and data type of " + dataType);
if(GET_MARSHALLER_METHOD.equals(param))
{
ret = MarshalFactory.getMarshaller(dataType, invoker.getSerializationType());
}
else if(GET_UNMARSHALLER_METHOD.equals(param))
{
ret = MarshalFactory.getUnMarshaller(dataType, invoker.getSerializationType());
}
else if(LOAD_CLASS_METHOD.equals(param))
{
String className = (String) metadMap.get(CLASSNAME);
log.debug("MarshallerLoaderHandler: loading class: " + className);
if(className != null)
{
ret = loadClassBytes(className, invoker.getClassLoader());
log.debug("MarshallerLoaderHandler: returning class: " + className + ": " + ret);
}
else
{
log.error("Received invocation " + param + " to load class, but metadata map key " + CLASSNAME +
" contains a null value for the class name to load.");
}
}
else if(LOAD_MARSHALLER_METHOD.equals(param))
{
// load based on data type
Marshaller marshaller = MarshalFactory.getMarshaller(dataType, invoker.getSerializationType());
if(marshaller != null)
{
String className = marshaller.getClass().getName();
ret = loadClassBytes(className, invoker.getClassLoader());
}
else
{
log.warn("Could not find registered marshaller for data type: " + dataType);
}
}
else if(LOAD_UNMARSHALLER_METHOD.equals(param))
{
UnMarshaller unmarshaller = MarshalFactory.getUnMarshaller(dataType, invoker.getSerializationType());
if(unmarshaller != null)
{
String className = unmarshaller.getClass().getName();
ret = loadClassBytes(className, invoker.getClassLoader());
}
else
{
log.warn("Could not find registered unmarshaller for data type: " + dataType);
}
}
else
{
log.warn("Received invocation with unknown parameter request: " + param);
}
return ret;
}
private Object loadClassBytes(String className, ClassLoader classLoader)
{
ClassBytes classBytes = null;
if(className != null)
{
byte[] classDefinition = ClassUtil.getClassBytes(className, classLoader);
if (classDefinition == null && repositories != null)
{
Iterator it = repositories.iterator();
while (it.hasNext())
{
ObjectName name = (ObjectName) it.next();
log.debug("searching repository " + name);
try
{
Object o = server.getAttribute(name, "Instance");
LoaderRepository repository = (LoaderRepository) o;
Class c = repository.loadClass(className);
if (c == null)
{
continue;
}
log.debug("found class in repository " + name);
RepositoryClassLoader cl = (RepositoryClassLoader) c.getClassLoader();
classDefinition = loadByteCode(cl, className);
break;
}
catch (Exception e)
{
log.debug("unable to get class from " + name + ": " + e.getMessage(), e);
}
}
}
if (classDefinition == null)
{
log.debug("unable to load class " + className);
}
classBytes = new ClassBytes(className, classDefinition);
}
return classBytes;
}
/**
* Adds a callback handler that will listen for callbacks from the server invoker handler.
*
* @param callbackHandler
*/
public void addListener(InvokerCallbackHandler callbackHandler)
{
//NO OP as don't won't allow listeners
}
/**
* Removes the callback handler that was listening for callbacks from the server invoker handler.
*
* @param callbackHandler
*/
public void removeListener(InvokerCallbackHandler callbackHandler)
{
//NO OP as don't won't allow listeners
}
/**
* Adapted from org.jboss.mx.loading.RepositoryClassLoader.
*
* @param cl
* @param classname
* @return
* @throws ClassNotFoundException
* @throws IOException
*/
protected byte[] loadByteCode(ClassLoader cl, String classname)
throws ClassNotFoundException, IOException
{
byte[] bytecode = null;
URL classURL = getClassURL(cl, classname);
// Load the class bytecode
InputStream is = null;
try
{
is = classURL.openStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream();
byte[] tmp = new byte[1024];
int read = 0;
while( (read = is.read(tmp)) > 0 )
{
baos.write(tmp, 0, read);
}
bytecode = baos.toByteArray();
}
finally
{
if( is != null )
is.close();
}
return bytecode;
}
/**
* Adapted from org.jboss.mx.loading.RepositoryClassLoader.
*
* @param cl
* @param classname
* @return
* @throws ClassNotFoundException
*/
private URL getClassURL(ClassLoader cl, String classname) throws ClassNotFoundException
{
String classRsrcName = classname.replace('.', '/') + ".class";
URL classURL = cl.getResource(classRsrcName);
if( classURL == null )
{
String msg = "Failed to find: "+classname+" as resource: "+classRsrcName;
throw new ClassNotFoundException(msg);
}
return classURL;
}
}