Package org.astrogrid.samp.xmlrpc
Interface SampXmlRpcHandler
-
- All Known Implementing Classes:
ActorHandler
,WebHubXmlRpcHandler
public interface SampXmlRpcHandler
Interface for an object which can process certain XML-RPC requests. Used bySampXmlRpcServer
.- Since:
- 22 Aug 2008
- Author:
- Mark Taylor
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
canHandleCall(java.lang.String method)
Returns true if this handler should be able to process given XML-RPC method.java.lang.Object
handleCall(java.lang.String method, java.util.List params, java.lang.Object reqInfo)
Processes an XML-RPC call.
-
-
-
Method Detail
-
canHandleCall
boolean canHandleCall(java.lang.String method)
Returns true if this handler should be able to process given XML-RPC method.- Parameters:
method
- method name
-
handleCall
java.lang.Object handleCall(java.lang.String method, java.util.List params, java.lang.Object reqInfo) throws java.lang.Exception
Processes an XML-RPC call. This method should only be called ifcanHandleCall(method)
returns true. Theparams
list and the return value must be SAMP-compatible, that is only Strings, Lists and String-keyed Maps are allowed in the data structures. ThereqInfo
parameter may be used to provide additional information about the XML-RPC request, for instance the originating host; this is implementation specific, and may be null.- Parameters:
method
- XML-RPC method nameparams
- XML-RPC parameter list (SAMP-compatible)reqInfo
- optional additional request information; may be null- Returns:
- return value (SAMP-compatible)
- Throws:
java.lang.Exception
-
-