|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface an XmlRpcService implements.
Field Summary | |
static java.lang.String |
SERVICE_NAME
TurbineXmlRpcService. |
Method Summary | |
void |
acceptClient(java.lang.String address)
Add an IP address to the list of accepted clients. |
void |
denyClient(java.lang.String address)
Add an IP address to the list of denied clients. |
java.lang.Object |
executeAuthenticatedRpc(java.net.URL url,
java.lang.String username,
java.lang.String password,
java.lang.String methodName,
java.util.Vector params)
Execute a remote procedure call taht requires authentication. |
java.lang.Object |
executeRpc(java.net.URL url,
java.lang.String methodName,
java.util.Vector params)
Execute a remote procedure call. |
void |
get(java.lang.String serverURL,
java.lang.String sourceLocationProperty,
java.lang.String sourceFileName,
java.lang.String destinationLocationProperty,
java.lang.String destinationFileName)
Method to allow a client to send a file to a server. |
void |
get(java.lang.String serverURL,
java.lang.String username,
java.lang.String password,
java.lang.String sourceLocationProperty,
java.lang.String sourceFileName,
java.lang.String destinationLocationProperty,
java.lang.String destinationFileName)
Method to allow a client to send a file to a server that rewuires authentication |
byte[] |
handleRequest(java.io.InputStream is)
Handle an XML-RPC request using the encapsulated server. |
byte[] |
handleRequest(java.io.InputStream is,
java.lang.String user,
java.lang.String password)
Handle an XML-RPC request using the encapsulated server with user authentication. |
void |
registerHandler(java.lang.Object handler)
Register an object as a the default handler for the XmlRpc Server part. |
void |
registerHandler(java.lang.String handlerName,
java.lang.Object handler)
Register an object as a handler for the XmlRpc Server part. |
void |
remove(java.lang.String serverURL,
java.lang.String sourceLocationProperty,
java.lang.String sourceFileName)
Method to allow a client to remove a file from the server |
void |
remove(java.lang.String serverURL,
java.lang.String username,
java.lang.String password,
java.lang.String sourceLocationProperty,
java.lang.String sourceFileName)
Method to allow a client to remove a file from a server that requires authentication |
void |
send(java.lang.String serverURL,
java.lang.String sourceLocationProperty,
java.lang.String sourceFileName,
java.lang.String destinationLocationProperty,
java.lang.String destinationFileName)
Method to allow a client to send a file to a server. |
void |
send(java.lang.String serverURL,
java.lang.String username,
java.lang.String password,
java.lang.String sourceLocationProperty,
java.lang.String sourceFileName,
java.lang.String destinationLocationProperty,
java.lang.String destinationFileName)
Method to allow a client to send a file to a server that requires authentication |
void |
setParanoid(boolean state)
Switch client filtering on/off. |
void |
unregisterHandler(java.lang.String handlerName)
Unregister a handler. |
Methods inherited from interface org.apache.turbine.services.Service |
getConfiguration, getName, getProperties, setName, setServiceBroker |
Methods inherited from interface org.apache.turbine.services.Initable |
getInit, init, init, setInitableBroker, shutdown |
Field Detail |
public static final java.lang.String SERVICE_NAME
Method Detail |
public java.lang.Object executeRpc(java.net.URL url, java.lang.String methodName, java.util.Vector params) throws TurbineException
url
- A URL.methodName
- A String with the method name.params
- A Vector with the parameters.TurbineException
- public java.lang.Object executeAuthenticatedRpc(java.net.URL url, java.lang.String username, java.lang.String password, java.lang.String methodName, java.util.Vector params) throws TurbineException
url
- A URL.username
- The username to authenticate withpassword
- The password to authenticate withmethodName
- A String with the method name.params
- A Vector with the parameters.TurbineException
- public void registerHandler(java.lang.String handlerName, java.lang.Object handler) throws org.apache.xmlrpc.XmlRpcException, java.io.IOException
handlerName
- The name under which we want
to register the servicehandler
- The handler objectorg.apache.xmlrpc.XmlRpcException
- java.io.IOException
- public void registerHandler(java.lang.Object handler) throws org.apache.xmlrpc.XmlRpcException, java.io.IOException
handler
- The handler objectorg.apache.xmlrpc.XmlRpcException
- java.io.IOException
- public void unregisterHandler(java.lang.String handlerName)
handlerName
- The name of the handler to unregister.public byte[] handleRequest(java.io.InputStream is)
is
- the stream to read request data from.public byte[] handleRequest(java.io.InputStream is, java.lang.String user, java.lang.String password)
Note that the handlers need to implement AuthenticatedXmlRpcHandler interface to access the authentication infomration.
is
- the stream to read request data from.user
- the user that is making the request.password
- the password given by user.public void send(java.lang.String serverURL, java.lang.String sourceLocationProperty, java.lang.String sourceFileName, java.lang.String destinationLocationProperty, java.lang.String destinationFileName) throws java.lang.Exception
serverURL
- sourceLocationProperty
- sourceFileName
- destinationLocationProperty
- destinationFileName
- java.lang.Exception
- public void send(java.lang.String serverURL, java.lang.String username, java.lang.String password, java.lang.String sourceLocationProperty, java.lang.String sourceFileName, java.lang.String destinationLocationProperty, java.lang.String destinationFileName) throws java.lang.Exception
serverURL
- username
- password
- sourceLocationProperty
- sourceFileName
- destinationLocationProperty
- destinationFileName
- java.lang.Exception
- public void get(java.lang.String serverURL, java.lang.String sourceLocationProperty, java.lang.String sourceFileName, java.lang.String destinationLocationProperty, java.lang.String destinationFileName) throws java.lang.Exception
serverURL
- sourceLocationProperty
- sourceFileName
- destinationLocationProperty
- destinationFileName
- java.lang.Exception
- public void get(java.lang.String serverURL, java.lang.String username, java.lang.String password, java.lang.String sourceLocationProperty, java.lang.String sourceFileName, java.lang.String destinationLocationProperty, java.lang.String destinationFileName) throws java.lang.Exception
serverURL
- username
- password
- sourceLocationProperty
- sourceFileName
- destinationLocationProperty
- destinationFileName
- java.lang.Exception
- public void remove(java.lang.String serverURL, java.lang.String sourceLocationProperty, java.lang.String sourceFileName) throws java.lang.Exception
serverURL
- sourceLocationProperty
- sourceFileName
- java.lang.Exception
- public void remove(java.lang.String serverURL, java.lang.String username, java.lang.String password, java.lang.String sourceLocationProperty, java.lang.String sourceFileName) throws java.lang.Exception
serverURL
- username
- password
- sourceLocationProperty
- sourceFileName
- java.lang.Exception
- public void setParanoid(boolean state)
state
- acceptClient(java.lang.String)
,
denyClient(java.lang.String)
public void acceptClient(java.lang.String address)
address
- denyClient(java.lang.String)
,
setParanoid(boolean)
public void denyClient(java.lang.String address)
address
- acceptClient(java.lang.String)
,
setParanoid(boolean)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |