freeipa/ipalib/plugins/example.py

# Authors:
#   Jason Gerard DeRose <jderose@redhat.com>
#
# Copyright (C) 2008  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; version 2 only
#
# 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

"""
Some example plugins.
"""


from ipalib import public
from ipalib.api import api


# Hypothetical functional commands (not associated with any object):
class krbtest(public.Command):
    'Test your Kerberos ticket'
api.register(krbtest)

class discover(public.Command):
    'Discover IPA servers on network'
api.register(discover)


# Register some methods for the 'user' object:
class user_add(public.Method):
    'Add new user'
api.register(user_add)

class user_del(public.Method):
    'Delete existing user'
api.register(user_del)

class user_mod(public.Method):
    'Edit existing user'
api.register(user_mod)

class user_find(public.Method):
    'Search for users'
api.register(user_find)


# Register some properties for the 'user' object:
class user_givenname(public.Property):
    'User first name'
    required = True
api.register(user_givenname)

class user_sn(public.Property):
    'User last name'
    required = True
api.register(user_sn)

class user_login(public.Property):
    'User login'
    required = True
    def default(self, **kw):
        givenname = kw.get('givenname', None)
        sn = kw.get('sn', None)
        if givenname is None or sn is None:
            return None
        return ('%s%s' % (givenname[0], sn)).lower()
api.register(user_login)

class user_initials(public.Property):
    'User initials'
    required = True
    def default(self, **kw):
        givenname = kw.get('givenname', None)
        sn = kw.get('sn', None)
        if givenname is None or sn is None:
            return None
        return '%s%s' % (givenname[0], sn[0])
api.register(user_initials)


# Register some methods for the 'group' object:
class group_add(public.Method):
    'Add new group'
api.register(group_add)

class group_del(public.Method):
    'Delete existing group'
api.register(group_del)

class group_mod(public.Method):
    'Edit existing group'
api.register(group_mod)

class group_find(public.Method):
    'Search for groups'
api.register(group_find)


# Register some methods for the 'service' object
class service_add(public.Method):
    'Add new service'
api.register(service_add)

class service_del(public.Method):
    'Delete existing service'
api.register(service_del)

class service_mod(public.Method):
    'Edit existing service'
api.register(service_mod)

class service_find(public.Method):
    'Search for services'
api.register(service_find)


# And to emphasis that the registration order doesn't matter,
# we'll register the objects last:
class group(public.Object):
    'Group object'
api.register(group)

class service(public.Object):
    'Service object'
api.register(service)

class user(public.Object):
    'User object'
api.register(user)