Java Doc for XmlRpcService.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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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.xmlrpc .XmlRpcService

All known Subclasses:   org.apache.turbine.services.xmlrpc .TurbineXmlRpcService,
XmlRpcService
public interface XmlRpcService extends Service(Code)
The interface an XmlRpcService implements.
author:
   Josh Lucas
author:
   Magnús Þór Torfason
author:
   Rafal Krzewski
author:
   Jason van Zyl
version:
   $Id: XmlRpcService.java 534527 2007-05-02 16:10:59Z tv $

Field Summary
String SERVICE_NAME
     TurbineXmlRpcService.

Method Summary
void acceptClient(String address)
     Add an IP address to the list of accepted clients.
void denyClient(String address)
     Add an IP address to the list of denied clients.
Object executeAuthenticatedRpc(URL url, String username, String password, String methodName, Vector params)
     Execute a remote procedure call taht requires authentication.
Parameters:
  url - A URL.
Parameters:
  username - The username to authenticate with
Parameters:
  password - The password to authenticate with
Parameters:
  methodName - A String with the method name.
Parameters:
  params - A Vector with the parameters.
Object executeRpc(URL url, String methodName, Vector params)
     Execute a remote procedure call.
Parameters:
  url - A URL.
Parameters:
  methodName - A String with the method name.
Parameters:
  params - A Vector with the parameters.
void get(String serverURL, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)
     Method to allow a client to send a file to a server.
void get(String serverURL, String username, String password, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)

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.
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.
void registerHandler(String handlerName, Object handler)
     Register an object as a handler for the XmlRpc Server part.
void registerHandler(Object handler)
     Register an object as a the default handler for the XmlRpc Server part.
void remove(String serverURL, String sourceLocationProperty, String sourceFileName)

void remove(String serverURL, String username, String password, String sourceLocationProperty, String sourceFileName)

void send(String serverURL, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)
     Method to allow a client to send a file to a server.
void send(String serverURL, String username, String password, String sourceLocationProperty, String sourceFileName, String destinationLocationProperty, String destinationFileName)

void setParanoid(boolean state)
     Switch client filtering on/off.
void unregisterHandler(String handlerName)
     Unregister a handler.

Field Detail
SERVICE_NAME
String SERVICE_NAME(Code)
TurbineXmlRpcService.

Method Detail
acceptClient
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 -
See Also:   XmlRpcService.denyClient(java.lang.String)
See Also:   XmlRpcService.setParanoid(boolean)

denyClient
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 -
See Also:   XmlRpcService.acceptClient(java.lang.String)
See Also:   XmlRpcService.setParanoid(boolean)

executeAuthenticatedRpc
Object executeAuthenticatedRpc(URL url, String username, String password, String methodName, Vector params) throws TurbineException(Code)
Execute a remote procedure call taht requires authentication.
Parameters:
  url - A URL.
Parameters:
  username - The username to authenticate with
Parameters:
  password - The password to authenticate with
Parameters:
  methodName - A String with the method name.
Parameters:
  params - A Vector with the parameters. An Object.
exception:
  TurbineException -

executeRpc
Object executeRpc(URL url, String methodName, Vector params) throws TurbineException(Code)
Execute a remote procedure call.
Parameters:
  url - A URL.
Parameters:
  methodName - A String with the method name.
Parameters:
  params - A Vector with the parameters. An Object.
exception:
  TurbineException -

get
void get(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 -
throws:
  TurbineException -

get
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 send a file to a server that requires authentication
Parameters:
  serverURL -
Parameters:
  username -
Parameters:
  password -
Parameters:
  sourceLocationProperty -
Parameters:
  sourceFileName -
Parameters:
  destinationLocationProperty -
Parameters:
  destinationFileName -
throws:
  TurbineException -

handleRequest
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
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
void registerHandler(String handlerName, Object handler)(Code)
Register an object as a handler for the XmlRpc Server part.
Parameters:
  handlerName - The name under which we wantto register the service
Parameters:
  handler - The handler object

registerHandler
void registerHandler(Object handler)(Code)
Register an object as a the default handler for the XmlRpc Server part.
Parameters:
  handler - The handler object

remove
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 -
throws:
  TurbineException -

remove
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 -
throws:
  TurbineException -

send
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 -
throws:
  TurbineException -

send
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 -
throws:
  TurbineException -

setParanoid
void setParanoid(boolean state)(Code)
Switch client filtering on/off.
Parameters:
  state -
See Also:   XmlRpcService.acceptClient(java.lang.String)
See Also:   XmlRpcService.denyClient(java.lang.String)

unregisterHandler
void unregisterHandler(String handlerName)(Code)
Unregister a handler.
Parameters:
  handlerName - The name of the handler to unregister.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.