org.jboss.remoting.ServerInvocationHandler Maven / Gradle / Ivy
/*
* 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;
import javax.management.MBeanServer;
import org.jboss.remoting.callback.InvokerCallbackHandler;
/**
* ServerInvocationHandler is the server side (remote) end handler which is registered for a given
* ServerInvoker implementation. The ServerInvocationHandler does the actual implementation work
* of invoking the method on the target object in the remote VM. The ServerInvoker will then
* handle marshalling and returning the results via the appropriate transport back to the client invoker.
*
* @author Jeff Haynie
* @author Tom Elrod
* @version $Revision: 1977 $
*/
public interface ServerInvocationHandler
{
/**
* set the mbean server that the handler can reference
*
* @param server
*/
public void setMBeanServer(MBeanServer server);
/**
* set the invoker that owns this handler
*
* @param invoker
*/
public void setInvoker(ServerInvoker 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;
/**
* Adds a callback handler that will listen for callbacks from
* the server invoker handler.
*
* @param callbackHandler
*/
public void addListener(InvokerCallbackHandler callbackHandler);
/**
* Removes the callback handler that was listening for callbacks
* from the server invoker handler.
*
* @param callbackHandler
*/
public void removeListener(InvokerCallbackHandler callbackHandler);
public String toString();
}