org.jgroups.blocks

Class MethodCall

java.lang.Object

org.jgroups.blocks.MethodCall

All Implemented Interfaces:

Externalizable, Serializable, Streamable

public class MethodCall
extends Object
implements Externalizable, Streamable

A method call is the JGroups representation of a remote method. It includes the name of the method (case sensitive) and a list of arguments. A method call is serializable and can be passed over the wire.

Author:

Bela Ban

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Object[]	args The arguments of the method.
protected static short	ID Use an ID to map to a method
protected static Log	log
protected MethodLookup	lookup
protected Method	method The Method of the call.
protected static short	METHOD Explicitly ship the method, caller has to determine method himself.
protected short	method_id The ID of a method, maps to a java.lang.reflect.Method
protected String	method_name The name of the method, case sensitive.
protected short	mode Which mode to use.
protected Class[]	types The class types, e.g., new Class[]{String.class, int.class}.
protected static short	TYPES Use class information.

Constructor Summary

Constructors

Constructor and Description
MethodCall() Creates an empty method call, this is always invalid, until setName() has been called.
MethodCall(Method method)
MethodCall(Method method, Object... arguments)
MethodCall(short method_id, Object... args)
MethodCall(String method_name, Object[] args, Class[] types)

Method Summary

Modifier and Type	Method and Description
static Object	convert(String arg, Class<?> type)
static Method	findMethod(Class target_class, String method_name, Object[] args) Called by the ProbeHandler impl.
Object[]	getArgs() returns an ordered list of arguments used for the method invokation
short	getId()
Method	getMethod()
int	getMode()
String	getName() returns the name of the method to be invoked using this method call object
Object	invoke(Object target) Invokes the method with the supplied arguments against the target object.
Object	invoke(Object target, Object[] args)
static boolean	isPrimitiveType(Class<?> type)
MethodCall	lookup(MethodLookup lookup)
protected void	readArgs(DataInput in)
void	readExternal(ObjectInput in)
void	readFrom(DataInput in) Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
protected void	readMethod(DataInput in)
protected void	readTypes(DataInput in)
void	setArgs(Object... args)
void	setId(short method_id)
void	setMethod(Method m)
void	setName(String n) sets the name for this MethodCall and allowing you to reuse the same object for a different method invokation of a different method
String	toString()
String	toStringDetails()
protected void	writeArgs(DataOutput out)
void	writeExternal(ObjectOutput out)
protected void	writeMethod(DataOutput out)
void	writeTo(DataOutput out) Write the entire state of the current object (including superclasses) to outstream.
protected void	writeTypes(DataOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

method_name

protected String method_name

The name of the method, case sensitive.

method_id

protected short method_id

The ID of a method, maps to a java.lang.reflect.Method

args

protected Object[] args

The arguments of the method.

types

protected Class[] types

The class types, e.g., new Class[]{String.class, int.class}.

method

protected Method method

The Method of the call.

log

protected static final Log log

mode

protected short mode

Which mode to use.

lookup

protected MethodLookup lookup

METHOD

protected static final short METHOD

Explicitly ship the method, caller has to determine method himself.

See Also:

Constant Field Values

TYPES

protected static final short TYPES

Use class information.

See Also:

Constant Field Values

ID

protected static final short ID

Use an ID to map to a method

See Also:

Constant Field Values

Constructor Detail

MethodCall

public MethodCall()

Creates an empty method call, this is always invalid, until setName() has been called.

MethodCall

public MethodCall(Method method)

MethodCall

public MethodCall(Method method,
                  Object... arguments)

MethodCall

public MethodCall(short method_id,
                  Object... args)

MethodCall

public MethodCall(String method_name,
                  Object[] args,
                  Class[] types)

Method Detail

lookup

public MethodCall lookup(MethodLookup lookup)

getMode

public int getMode()

getName

public String getName()

returns the name of the method to be invoked using this method call object

Returns:

a case sensitive name, can be null for an invalid method call

setName

public void setName(String n)

sets the name for this MethodCall and allowing you to reuse the same object for a different method invokation of a different method

Parameters:

n - - a case sensitive method name

getId

public short getId()

setId

public void setId(short method_id)

getArgs

public Object[] getArgs()

returns an ordered list of arguments used for the method invokation

Returns:

returns the list of ordered arguments

setArgs

public void setArgs(Object... args)

getMethod

public Method getMethod()

setMethod

public void setMethod(Method m)

findMethod

public static Method findMethod(Class target_class,
                                String method_name,
                                Object[] args)
                         throws Exception

Called by the ProbeHandler impl. All args are strings. Needs to find a method where all parameter types are primitive types, so the strings can be converted

Throws:

Exception

invoke

public Object invoke(Object target)
              throws Exception

Invokes the method with the supplied arguments against the target object. If a method lookup is provided, it will be used. Otherwise, the default method lookup will be used.

Parameters:

target - - the object that you want to invoke the method on

Returns:

an object

Throws:

Exception

invoke

public Object invoke(Object target,
                     Object[] args)
              throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

toStringDetails

public String toStringDetails()

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeTo

public void writeTo(DataOutput out)
             throws Exception

Description copied from interface: Streamable

Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed

Specified by:

writeTo in interface Streamable

Throws:

Exception

readFrom

public void readFrom(DataInput in)
              throws Exception

Description copied from interface: Streamable

Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed

Specified by:

readFrom in interface Streamable

Throws:

Exception

writeArgs

protected void writeArgs(DataOutput out)
                  throws Exception

Throws:

Exception

readArgs

protected void readArgs(DataInput in)
                 throws Exception

Throws:

Exception

writeTypes

protected void writeTypes(DataOutput out)
                   throws Exception

Throws:

Exception

readTypes

protected void readTypes(DataInput in)
                  throws Exception

Throws:

Exception

writeMethod

protected void writeMethod(DataOutput out)
                    throws Exception

Throws:

Exception

readMethod

protected void readMethod(DataInput in)
                   throws Exception

Throws:

Exception

convert

public static Object convert(String arg,
                             Class<?> type)

isPrimitiveType

public static boolean isPrimitiveType(Class<?> type)