| org.apache.turbine.services.TurbineBaseService
 org.apache.turbine.services.xmlrpc.TurbineXmlRpcService
| TurbineXmlRpcService | | public class TurbineXmlRpcService extends TurbineBaseService implements XmlRpcService(Code) | | This is a service which will make an xml-rpc call to a remote
server.
Here's an example of how it would be done:
XmlRpcService xs =
(XmlRpcService)TurbineServices.getInstance()
.getService(XmlRpcService.XMLRPC_SERVICE_NAME);
Vector vec = new Vector();
vec.addElement(new Integer(5));
URL url = new URL("http://betty.userland.com/RPC2");
String name = (String)xs.executeRpc(url, "examples.getStateName", vec);
TODO: Handle XmlRpc.setDebug(boolean)
author:
Josh Lucas
author:
Magnús Þór Torfason
author:
Rafal Krzewski
author:
Jason van Zyl
author:
Daniel Rall
author:
Martin Poeschl
author:
Quinton McCombs
version:
$Id: TurbineXmlRpcService.java 534527 2007-05-02 16:10:59Z tv $ |
| Field Summary | |
| protected boolean | isModernVersion
Whether a version of Apache's XML-RPC library greater than 1.1
is available. | | protected int | port
The port to listen on. | | protected XmlRpcServer | server
The encapsulated xmlrpc server. | | protected WebServer | webserver
The standalone xmlrpc server. |
| Method Summary | |
| public void | acceptClient(String address)
Add an IP address to the list of accepted clients. | | public void | denyClient(String address)
Add an IP address to the list of denied clients. | | public Object | executeAuthenticatedRpc(URL url, String username, String password, String methodName, Vector params)
Client's Authenticated interface to XML-RPC.
The return type is Object which you'll need to cast to
whatever you are expecting.
Parameters:
url - A URL.
Parameters:
username - The username to try and authenticate with
Parameters:
password - The password to try and authenticate with
Parameters:
methodName - A String with the method name.
Parameters:
params - A Vector with the parameters. | | public Object | executeRpc(URL url, String methodName, Vector params)
Client's interface to XML-RPC.
The return type is Object which you'll need to cast to
whatever you are expecting.
Parameters:
url - A URL.
Parameters:
methodName - A String with the method name.
Parameters:
params - A Vector with the parameters. | | public void | get(String serverURL, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)
Method to allow a client to get a file from a server. | | public void | get(String serverURL, String username, String password, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)
Method to allow a client to get a file from a server that
requires authentication. | | public byte[] | handleRequest(InputStream is)
Handle an XML-RPC request using the encapsulated server.
You can use this method to handle a request from within
a Turbine screen.
Parameters:
is - the stream to read request data from. | | public byte[] | handleRequest(InputStream is, String user, String password)
Handle an XML-RPC request using the encapsulated server with user
authentication.
You can use this method to handle a request from within
a Turbine screen.
Note that the handlers need to implement AuthenticatedXmlRpcHandler
interface to access the authentication infomration.
Parameters:
is - the stream to read request data from.
Parameters:
user - the user that is making the request.
Parameters:
password - the password given by user. | | public void | init()
This function initializes the XmlRpcService.This is
a zero parameter variant which queries the Turbine Servlet
for its config. | | public void | init(ServletConfig config)
This function initializes the XmlRpcService. | | public void | registerHandler(Object handler)
Register an Object as a default handler for the service. | | public void | registerHandler(String handlerName, Object handler)
Register an Object as a handler for the service. | | public void | registerHandler(String handlerName, String handlerClass)
A helper method that tries to initialize a handler and register it. | | public void | remove(String serverURL, String sourceLocationProperty, String sourceFileName)
| | public void | remove(String serverURL, String username, String password, String sourceLocationProperty, String sourceFileName)
Method to allow a client to remove a file from
a server that requires authentication. | | public void | send(String serverURL, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)
Method to allow a client to send a file to a server. | | public void | send(String serverURL, String username, String password, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)
| | public void | setParanoid(boolean state)
Switch client filtering on/off. | | public void | shutdown()
Shuts down this service, stopping running threads. | | public void | unregisterHandler(String handlerName)
Unregister a handler. |
| isModernVersion | | protected boolean isModernVersion(Code) | | Whether a version of Apache's XML-RPC library greater than 1.1
is available.
|
| port | | protected int port(Code) | | The port to listen on.
|
| server | | protected XmlRpcServer server(Code) | | The encapsulated xmlrpc server.
|
| webserver | | protected WebServer webserver(Code) | | The standalone xmlrpc server.
|
| executeAuthenticatedRpc | | public Object executeAuthenticatedRpc(URL url, String username, String password, String methodName, Vector params) throws TurbineException(Code) | | Client's Authenticated interface to XML-RPC.
The return type is Object which you'll need to cast to
whatever you are expecting.
Parameters:
url - A URL.
Parameters:
username - The username to try and authenticate with
Parameters:
password - The password to try and authenticate with
Parameters:
methodName - A String with the method name.
Parameters:
params - A Vector with the parameters. An Object.
throws:
TurbineException - |
| executeRpc | | public Object executeRpc(URL url, String methodName, Vector params) throws TurbineException(Code) | | Client's interface to XML-RPC.
The return type is Object which you'll need to cast to
whatever you are expecting.
Parameters:
url - A URL.
Parameters:
methodName - A String with the method name.
Parameters:
params - A Vector with the parameters. An Object.
exception:
TurbineException - |
| get | | public void get(String serverURL, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName) throws TurbineException(Code) | | Method to allow a client to get a file from a server.
Parameters:
serverURL -
Parameters:
sourceLocationProperty -
Parameters:
sourceFileName -
Parameters:
destinationLocationProperty -
Parameters:
destinationFileName - |
| get | | public void get(String serverURL, String username, String password, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName) throws TurbineException(Code) | | Method to allow a client to get a file from a server that
requires authentication.
Parameters:
serverURL -
Parameters:
username -
Parameters:
password -
Parameters:
sourceLocationProperty -
Parameters:
sourceFileName -
Parameters:
destinationLocationProperty -
Parameters:
destinationFileName - |
| handleRequest | | public byte[] handleRequest(InputStream is)(Code) | | Handle an XML-RPC request using the encapsulated server.
You can use this method to handle a request from within
a Turbine screen.
Parameters:
is - the stream to read request data from. the response body that needs to be sent to the client. |
| handleRequest | | public byte[] handleRequest(InputStream is, String user, String password)(Code) | | Handle an XML-RPC request using the encapsulated server with user
authentication.
You can use this method to handle a request from within
a Turbine screen.
Note that the handlers need to implement AuthenticatedXmlRpcHandler
interface to access the authentication infomration.
Parameters:
is - the stream to read request data from.
Parameters:
user - the user that is making the request.
Parameters:
password - the password given by user. the response body that needs to be sent to the client. |
| registerHandler | | public void registerHandler(Object handler)(Code) | | Register an Object as a default handler for the service.
Parameters:
handler - The handler to use. |
| registerHandler | | public void registerHandler(String handlerName, Object handler)(Code) | | Register an Object as a handler for the service.
Parameters:
handlerName - The name the handler is registered under.
Parameters:
handler - The handler to use. |
| registerHandler | | public void registerHandler(String handlerName, String handlerClass) throws TurbineException(Code) | | A helper method that tries to initialize a handler and register it.
The purpose is to check for all the exceptions that may occur in
dynamic class loading and throw an InitializationException on
error.
Parameters:
handlerName - The name the handler is registered under.
Parameters:
handlerClass - The name of the class to use as a handler.
exception:
TurbineException - Couldn't instantiate handler. |
| remove | | public void remove(String serverURL, String sourceLocationProperty, String sourceFileName) throws TurbineException(Code) | | Method to allow a client to remove a file from
the server
Parameters:
serverURL -
Parameters:
sourceLocationProperty -
Parameters:
sourceFileName - |
| remove | | public void remove(String serverURL, String username, String password, String sourceLocationProperty, String sourceFileName) throws TurbineException(Code) | | Method to allow a client to remove a file from
a server that requires authentication.
Parameters:
serverURL -
Parameters:
username -
Parameters:
password -
Parameters:
sourceLocationProperty -
Parameters:
sourceFileName - |
| send | | public void send(String serverURL, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName) throws TurbineException(Code) | | Method to allow a client to send a file to a server.
Parameters:
serverURL -
Parameters:
sourceLocationProperty -
Parameters:
sourceFileName -
Parameters:
destinationLocationProperty -
Parameters:
destinationFileName - |
| send | | public void send(String serverURL, String username, String password, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName) throws TurbineException(Code) | | Method to allow a client to send a file to a server that
requires authentication
Parameters:
serverURL -
Parameters:
username -
Parameters:
password -
Parameters:
sourceLocationProperty -
Parameters:
sourceFileName -
Parameters:
destinationLocationProperty -
Parameters:
destinationFileName - |
| shutdown | | public void shutdown()(Code) | | Shuts down this service, stopping running threads.
|
| unregisterHandler | | public void unregisterHandler(String handlerName)(Code) | | Unregister a handler.
Parameters:
handlerName - The name of the handler to unregister. |
|
|