|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XmlRpcService
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)
Deprecated. This is not scope of the Service itself but of an application which uses the service. |
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)
Deprecated. This is not scope of the Service itself but of an application which uses the service. |
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)
Deprecated. This is not scope of the Service itself but of an application which uses the service. |
void |
remove(java.lang.String serverURL,
java.lang.String username,
java.lang.String password,
java.lang.String sourceLocationProperty,
java.lang.String sourceFileName)
Deprecated. This is not scope of the Service itself but of an application which uses the service. |
void |
send(java.lang.String serverURL,
java.lang.String sourceLocationProperty,
java.lang.String sourceFileName,
java.lang.String destinationLocationProperty,
java.lang.String destinationFileName)
Deprecated. This is not scope of the Service itself but of an application which uses the service. |
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)
Deprecated. This is not scope of the Service itself but of an application which uses the service. |
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 |
---|
static final java.lang.String SERVICE_NAME
Method Detail |
---|
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
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
void registerHandler(java.lang.String handlerName, java.lang.Object handler)
handlerName
- The name under which we want
to register the servicehandler
- The handler objectvoid registerHandler(java.lang.Object handler)
handler
- The handler objectvoid unregisterHandler(java.lang.String handlerName)
handlerName
- The name of the handler to unregister.byte[] handleRequest(java.io.InputStream is)
is
- the stream to read request data from.
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.
void send(java.lang.String serverURL, java.lang.String sourceLocationProperty, java.lang.String sourceFileName, java.lang.String destinationLocationProperty, java.lang.String destinationFileName) throws TurbineException
serverURL
- sourceLocationProperty
- sourceFileName
- destinationLocationProperty
- destinationFileName
-
TurbineException
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 TurbineException
serverURL
- username
- password
- sourceLocationProperty
- sourceFileName
- destinationLocationProperty
- destinationFileName
-
TurbineException
void get(java.lang.String serverURL, java.lang.String sourceLocationProperty, java.lang.String sourceFileName, java.lang.String destinationLocationProperty, java.lang.String destinationFileName) throws TurbineException
serverURL
- sourceLocationProperty
- sourceFileName
- destinationLocationProperty
- destinationFileName
-
TurbineException
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 TurbineException
serverURL
- username
- password
- sourceLocationProperty
- sourceFileName
- destinationLocationProperty
- destinationFileName
-
TurbineException
void remove(java.lang.String serverURL, java.lang.String sourceLocationProperty, java.lang.String sourceFileName) throws TurbineException
serverURL
- sourceLocationProperty
- sourceFileName
-
TurbineException
void remove(java.lang.String serverURL, java.lang.String username, java.lang.String password, java.lang.String sourceLocationProperty, java.lang.String sourceFileName) throws TurbineException
serverURL
- username
- password
- sourceLocationProperty
- sourceFileName
-
TurbineException
void setParanoid(boolean state)
state
- acceptClient(java.lang.String)
,
denyClient(java.lang.String)
void acceptClient(java.lang.String address)
address
- denyClient(java.lang.String)
,
setParanoid(boolean)
void denyClient(java.lang.String address)
address
- acceptClient(java.lang.String)
,
setParanoid(boolean)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |