Rob Crittenden
c69d8084c1
This patch contains 2 parts. The first part is a small utility to create and validate the current API. To do this it needs to load ipalib which on a fresh system introduces a few problems, namely that it relies on a python plugin to set the default encoding to utf8. For our purposes we can skip that. It is also important that any optional plugins be loadable so the API can be examined. The second part is a version exchange between the client and server. The version has a major and a minor version. The major verion is updated whenever existing API changes. The minor version is updated when new API is added. A request will be rejected if either the major versions don't match or if the client major version is higher than then server major version (though by implication new API would return a command not found if allowed to proceed). To determine the API version of the server from a client use the ping command. ticket 584
99 lines
3.1 KiB
Python
99 lines
3.1 KiB
Python
# Authors:
|
|
# Adam Young <ayoung@redhat.com>
|
|
# Rob Crittenden <rcritten@redhat.com>
|
|
#
|
|
# Copyright (c) 2010 Red Hat
|
|
# See file 'copying' for use and warranty information
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""
|
|
Plugin to make multiple ipa calls via one remote procedure call
|
|
|
|
To run this code in the lite-server
|
|
|
|
curl -H "Content-Type:application/json" -H "Acept:applicaton/json" -H "Accept-Language:en" --negotiate -u : --cacert /etc/ipa/ca.crt -d @batch_request.json -X POST http://localhost:8888/ipa/json
|
|
|
|
where the contenst of the file batch_request.json follow the below example
|
|
|
|
{"method":"batch","params":[[
|
|
{"method":"group_find","params":[[],{}]},
|
|
{"method":"user_find","params":[[],{"whoami":"true","all":"true"}]},
|
|
{"method":"user_show","params":[["admin"],{"all":true}]}
|
|
],{}],"id":1}
|
|
|
|
The format of the response is nested the same way. At the top you will see
|
|
"error": null,
|
|
"id": 1,
|
|
"result": {
|
|
"count": 3,
|
|
"results": [
|
|
|
|
|
|
And then a nested response for each IPA command method sent in the request
|
|
|
|
"""
|
|
|
|
from ipalib import api, errors
|
|
from ipalib import Command
|
|
from ipalib import Str, List
|
|
from ipalib.output import Output
|
|
from ipalib import output
|
|
from ipalib.text import _
|
|
from ipapython.version import API_VERSION
|
|
|
|
class batch(Command):
|
|
INTERNAL = True
|
|
|
|
takes_args = (
|
|
List('methods?',
|
|
doc=_('Nested Methods to execute'),
|
|
),
|
|
)
|
|
|
|
take_options = (
|
|
Str('version',
|
|
cli_name='version',
|
|
doc=_('Client version. Used to determine if server will accept request.'),
|
|
exclude='webui',
|
|
flags=['no_option', 'no_output'],
|
|
default=API_VERSION,
|
|
autofill=True,
|
|
)
|
|
)
|
|
|
|
has_output = (
|
|
Output('count', int, doc=_('')),
|
|
Output('results', list, doc=_(''))
|
|
)
|
|
|
|
def execute(self, *args, **options):
|
|
results=[]
|
|
for arg in args[0]:
|
|
try:
|
|
a = arg['params'][0]
|
|
kw = arg['params'][1]
|
|
newkw = {}
|
|
for k in kw:
|
|
newkw[str(k)] = kw[k]
|
|
result = api.Command[arg['method']](*a, **newkw)
|
|
result['error']=None
|
|
except Exception, e:
|
|
result = dict()
|
|
result['error'] = unicode(e)
|
|
results.append(result)
|
|
return dict(count=len(results) , results=results)
|
|
|
|
api.register(batch)
|