Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
XmlRpcWorker |
|
| 1.0;1 |
1 | /* |
|
2 | * Copyright 1999,2005 The Apache Software Foundation. |
|
3 | * |
|
4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
|
5 | * you may not use this file except in compliance with the License. |
|
6 | * You may obtain a copy of the License at |
|
7 | * |
|
8 | * http://www.apache.org/licenses/LICENSE-2.0 |
|
9 | * |
|
10 | * Unless required by applicable law or agreed to in writing, software |
|
11 | * distributed under the License is distributed on an "AS IS" BASIS, |
|
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
13 | * See the License for the specific language governing permissions and |
|
14 | * limitations under the License. |
|
15 | */ |
|
16 | package org.apache.xmlrpc.common; |
|
17 | ||
18 | import org.apache.xmlrpc.XmlRpcException; |
|
19 | import org.apache.xmlrpc.XmlRpcRequest; |
|
20 | ||
21 | ||
22 | /** An object, which executes requests on the controllers |
|
23 | * behalf. These objects are mainly used for controlling the |
|
24 | * clients or servers load, which is defined in terms of the |
|
25 | * number of currently active workers. |
|
26 | */ |
|
27 | public interface XmlRpcWorker { |
|
28 | /** Returns the workers controller. |
|
29 | * @return The controller, an instance of |
|
30 | * {@link org.apache.xmlrpc.client.XmlRpcClient}, or |
|
31 | * {@link org.apache.xmlrpc.server.XmlRpcServer}. |
|
32 | */ |
|
33 | XmlRpcController getController(); |
|
34 | ||
35 | /** Performs a synchronous request. The client worker extends |
|
36 | * this interface with the ability to perform asynchronous |
|
37 | * requests. |
|
38 | * @param pController The workers controller. |
|
39 | * @param pRequest The request being performed. |
|
40 | * @param pConfig The request configuration. |
|
41 | * @return The requests result. |
|
42 | * @throws XmlRpcException Performing the request failed. |
|
43 | */ |
|
44 | Object execute(XmlRpcRequest pRequest) throws XmlRpcException; |
|
45 | } |