Java Doc for TurbineXmlRpcService.java in  » Web-Framework » TURBINE » org » apache » turbine » services » xmlrpc » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Framework » TURBINE » org.apache.turbine.services.xmlrpc 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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  booleanisModernVersion
     Whether a version of Apache's XML-RPC library greater than 1.1 is available.
protected  intport
     The port to listen on.
protected  XmlRpcServerserver
     The encapsulated xmlrpc server.
protected  WebServerwebserver
     The standalone xmlrpc server.


Method Summary
public  voidacceptClient(String address)
     Add an IP address to the list of accepted clients.
public  voiddenyClient(String address)
     Add an IP address to the list of denied clients.
public  ObjectexecuteAuthenticatedRpc(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  ObjectexecuteRpc(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  voidget(String serverURL, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)
     Method to allow a client to get a file from a server.
public  voidget(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  voidinit()
     This function initializes the XmlRpcService.This is a zero parameter variant which queries the Turbine Servlet for its config.
public  voidinit(ServletConfig config)
     This function initializes the XmlRpcService.
public  voidregisterHandler(Object handler)
     Register an Object as a default handler for the service.
public  voidregisterHandler(String handlerName, Object handler)
     Register an Object as a handler for the service.
public  voidregisterHandler(String handlerName, String handlerClass)
     A helper method that tries to initialize a handler and register it.
public  voidremove(String serverURL, String sourceLocationProperty, String sourceFileName)
    
public  voidremove(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  voidsend(String serverURL, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)
     Method to allow a client to send a file to a server.
public  voidsend(String serverURL, String username, String password, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)
    
public  voidsetParanoid(boolean state)
     Switch client filtering on/off.
public  voidshutdown()
     Shuts down this service, stopping running threads.
public  voidunregisterHandler(String handlerName)
     Unregister a handler.

Field Detail
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.





Method Detail
acceptClient
public void acceptClient(String address)(Code)
Add an IP address to the list of accepted clients. The parameter can contain '*' as wildcard character, e.g. "192.168.*.*". You must call setParanoid(true) in order for this to have any effect.
Parameters:
  address - The address to add to the list.
See Also:   TurbineXmlRpcService.denyClient(java.lang.String)
See Also:   TurbineXmlRpcService.setParanoid(boolean)



denyClient
public void denyClient(String address)(Code)
Add an IP address to the list of denied clients. The parameter can contain '*' as wildcard character, e.g. "192.168.*.*". You must call setParanoid(true) in order for this to have any effect.
Parameters:
  address - The address to add to the list.
See Also:   TurbineXmlRpcService.acceptClient(java.lang.String)
See Also:   TurbineXmlRpcService.setParanoid(boolean)



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.




init
public void init() throws InitializationException(Code)
This function initializes the XmlRpcService.This is a zero parameter variant which queries the Turbine Servlet for its config.
throws:
  InitializationException - Something went wrong in the initstage



init
public void init(ServletConfig config) throws InitializationException(Code)
This function initializes the XmlRpcService.



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 -



setParanoid
public void setParanoid(boolean state)(Code)
Switch client filtering on/off.
Parameters:
  state - Whether to filter clients.
See Also:   TurbineXmlRpcService.acceptClient(java.lang.String)
See Also:   TurbineXmlRpcService.denyClient(java.lang.String)



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.



Methods inherited from org.apache.turbine.services.TurbineBaseService
public void init(Object data) throws InitializationException(Code)(Java Doc)
public void init(ServletConfig config) throws InitializationException(Code)(Java Doc)
public void init(RunData data) throws InitializationException(Code)(Java Doc)
public void init() throws InitializationException(Code)(Java Doc)
public void shutdown()(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.