com.flat502.rox.marshal
Interface RpcCall

All Superinterfaces:

RpcMethod

All Known Implementing Classes:

AbstractRpcCall, CgiRpcMethodCall, XmlRpcMethodCall

public interface RpcCall
extends RpcMethod

An interface representing a generalized RPC method call.

This interface is patterned after XML-RPC and essentially encapsulates a method name and a list of parameters.

Method Summary

java.lang.String	getHttpMethod()
java.lang.String	getHttpURI(java.net.URL baseUrl) Map the destination URL onto a URI for use in an HTTP request.
java.lang.String	getName() Get the method name to invoke (or being invoked).
java.lang.Object[]	getParameters() Get a list of parameters to pass to (or that were passed to) this method call.

Methods inherited from interface com.flat502.rox.marshal.RpcMethod

getContentType, marshal

Method Detail

getName

java.lang.String getName()

Get the method name to invoke (or being invoked).

Returns:

The name of the RPC method this instance represents.

getParameters

java.lang.Object[] getParameters()

Get a list of parameters to pass to (or that were passed to) this method call.

Implementations must not return null. If no parameters exist a zero length array should be returned to simplify logic that depends on this method.

Returns:

An array containing the parameters associated with this RPC method call. Never null.

getHttpMethod

java.lang.String getHttpMethod()

getHttpURI

java.lang.String getHttpURI(java.net.URL baseUrl)

Map the destination URL onto a URI for use in an HTTP request.

This method provides implementations with an opportunity to generate an appropriate URI (possibly tranformed) before the underlying HTTP request is contructed and sent.

Parameters:

baseUrl - The URL the client making the call was directed at.

Returns:

A string value for use as the URI in an HTTP request that will represent this call.