ipaserver.plugins.baseldap.LDAPObject¶
- class ipaserver.plugins.baseldap.LDAPObject(api)[source]¶
Bases:
ipalib.frontend.Object
Object representing a LDAP entry.
Public Data Attributes:
Inherited from
Object
Public Methods:
get_dn
(*keys, **kwargs)Construct an LDAP DN.
get_dn_if_exists
(*keys, **kwargs)has_objectclass
(classes, objectclass)convert_attribute_members
(entry_attrs, ...)get_indirect_members
(entry_attrs, attrs_list)get_memberindirect
(group_entry)Get indirect members
get_memberofindirect
(entry)get_password_attributes
(ldap, dn, entry_attrs)Search on the entry to determine if it has a password or keytab set.
handle_not_found
(*keys)Handle NotFound exception
handle_duplicate_entry
(*keys)__json__
()Inherited from
Object
params_minus
(*names)Yield all Param whose name is not in
names
.get_dn
(*keys, **kwargs)Construct an LDAP DN.
This method gets called by HasParam._create_param_namespace().
__json__
()Inherited from
Plugin
__init__
(api)finalize
()Finalize plugin initialization.
Finalize plugin initialization if it has not yet been finalized.
__repr__
()Return 'module_name.class_name()' representation.
Inherited from
ReadOnly
__lock__
()Put this instance into a read-only state.
Return True if instance is locked, otherwise False.
__setattr__
(name, value)If unlocked, set attribute named
name
tovalue
.__delattr__
(name)If unlocked, delete attribute named
name
.Private Data Attributes:
Inherited from
ReadOnly
_ReadOnly__locked
Private Methods:
Inherited from
Object
Do custom finalization.
_Object__get_attrs
(name)Inherited from
HasParam
_get_param_iterable
(name[, verb])Return an iterable of params defined by the attribute named
name
._filter_param_by_context
(name[, env])Filter params on attribute named
name
by environmentenv
._create_param_namespace
(name[, env])Inherited from
Plugin
_Plugin__name_getter
()_Plugin__full_name_getter
()_Plugin__bases_getter
()_Plugin__doc_getter
()_Plugin__summary_getter
()Do custom finalization.
- property Backend¶
- property Command¶
- NO_CLI = False¶
- __annotations__ = {}¶
- __delattr__(name)¶
If unlocked, delete attribute named
name
.If this instance is locked, an AttributeError will be raised.
- Parameters
name – Name of attribute to delete.
- __dict__ = mappingproxy({'__module__': 'ipaserver.plugins.baseldap', '__doc__': '\n Object representing a LDAP entry.\n ', 'backend_name': 'ldap2', 'parent_object': '', 'container_dn': '', 'object_name': Gettext('entry', domain='ipa', localedir=None), 'object_name_plural': Gettext('entries', domain='ipa', localedir=None), 'object_class': [], 'object_class_config': None, 'possible_objectclasses': [], 'limit_object_classes': [], 'disallow_object_classes': [], 'permission_filter_objectclasses': None, 'search_attributes': [], 'search_attributes_config': None, 'default_attributes': [], 'search_display_attributes': [], 'hidden_attributes': ['objectclass', 'aci'], 'rdn_attribute': '', 'uuid_attribute': '', 'attribute_members': {}, 'allow_rename': False, 'password_attributes': [], 'bindable': False, 'relationships': {'member': ('Member', '', 'no_'), 'memberof': ('Member Of', 'in_', 'not_in_'), 'memberindirect': ('Indirect Member', None, 'no_indirect_'), 'memberofindirect': ('Indirect Member Of', None, 'not_in_indirect_'), 'membermanager': ('Group membership managed by', 'membermanager_', 'not_membermanager_')}, 'label': Gettext('Entry', domain='ipa', localedir=None), 'label_singular': Gettext('Entry', domain='ipa', localedir=None), 'managed_permissions': {}, 'container_not_found_msg': Gettext('container entry (%(container)s) not found', domain='ipa', localedir=None), 'parent_not_found_msg': Gettext('%(parent)s: %(oname)s not found', domain='ipa', localedir=None), 'object_not_found_msg': Gettext('%(pkey)s: %(oname)s not found', domain='ipa', localedir=None), 'already_exists_msg': Gettext('%(oname)s with name "%(pkey)s" already exists', domain='ipa', localedir=None), 'get_dn': <function LDAPObject.get_dn>, 'get_dn_if_exists': <function LDAPObject.get_dn_if_exists>, 'get_primary_key_from_dn': <function LDAPObject.get_primary_key_from_dn>, 'get_ancestor_primary_keys': <function LDAPObject.get_ancestor_primary_keys>, 'has_objectclass': <function LDAPObject.has_objectclass>, 'convert_attribute_members': <function LDAPObject.convert_attribute_members>, 'get_indirect_members': <function LDAPObject.get_indirect_members>, 'get_memberindirect': <function LDAPObject.get_memberindirect>, 'get_memberofindirect': <function LDAPObject.get_memberofindirect>, 'get_password_attributes': <function LDAPObject.get_password_attributes>, 'handle_not_found': <function LDAPObject.handle_not_found>, 'handle_duplicate_entry': <function LDAPObject.handle_duplicate_entry>, 'json_friendly_attributes': ('parent_object', 'container_dn', 'object_name', 'object_name_plural', 'object_class', 'object_class_config', 'default_attributes', 'label', 'label_singular', 'hidden_attributes', 'uuid_attribute', 'attribute_members', 'name', 'takes_params', 'rdn_attribute', 'bindable', 'relationships'), '__json__': <function LDAPObject.__json__>, '__annotations__': {}})¶
- __init__(api)¶
- __islocked__()¶
Return True if instance is locked, otherwise False.
- __lock__()¶
Put this instance into a read-only state.
After the instance has been locked, attempting to set or delete an attribute will raise an AttributeError.
- __module__ = 'ipaserver.plugins.baseldap'¶
- __repr__()¶
Return ‘module_name.class_name()’ representation.
This representation could be used to instantiate this Plugin instance given the appropriate environment.
- __setattr__(name, value)¶
If unlocked, set attribute named
name
tovalue
.If this instance is locked, an AttributeError will be raised.
- Parameters
name – Name of attribute to set.
value – Value to assign to attribute.
- __weakref__¶
list of weak references to the object (if defined)
- _create_param_namespace(name, env=None)¶
- _filter_param_by_context(name, env=None)¶
Filter params on attribute named
name
by environmentenv
.For example:
>>> from ipalib.config import Env >>> class Example(HasParam): ... ... takes_args = ( ... Str('foo_only', include=['foo']), ... Str('not_bar', exclude=['bar']), ... 'both', ... ) ... ... def get_args(self): ... return self._get_param_iterable('args') ... ... >>> eg = Example() >>> foo = Env(context='foo') >>> bar = Env(context='bar') >>> another = Env(context='another') >>> (foo.context, bar.context, another.context) (u'foo', u'bar', u'another') >>> list(eg._filter_param_by_context('args', foo)) [Str('foo_only', include=['foo']), Str('not_bar', exclude=['bar']), Str('both')] >>> list(eg._filter_param_by_context('args', bar)) [Str('both')] >>> list(eg._filter_param_by_context('args', another)) [Str('not_bar', exclude=['bar']), Str('both')]
- _get_param_iterable(name, verb='takes')¶
Return an iterable of params defined by the attribute named
name
.A sequence of params can be defined one of three ways: as a
tuple
; as a callable that returns an iterable; or as a param spec (a Param orstr
instance). This method returns a uniform iterable regardless of how the param sequence was defined.For example, when defined with a tuple:
>>> class ByTuple(HasParam): ... takes_args = (Param('foo'), Param('bar')) ... >>> by_tuple = ByTuple() >>> list(by_tuple._get_param_iterable('args')) [Param('foo'), Param('bar')]
Or you can define your param sequence with a callable when you need to reference attributes on your plugin instance (for validation rules, etc.). For example:
>>> class ByCallable(HasParam): ... def takes_args(self): ... yield Param('foo', self.validate_foo) ... yield Param('bar', self.validate_bar) ... ... def validate_foo(self, _, value, **kw): ... if value != 'Foo': ... return _("must be 'Foo'") ... ... def validate_bar(self, _, value, **kw): ... if value != 'Bar': ... return _("must be 'Bar'") ... >>> by_callable = ByCallable() >>> list(by_callable._get_param_iterable('args')) [Param('foo', validate_foo), Param('bar', validate_bar)]
Lastly, as a convenience for when a param sequence contains a single param, your defining attribute may a param spec (either a Param or an
str
instance). For example:>>> class BySpec(HasParam): ... takes_args = Param('foo') ... takes_options = 'bar?' ... >>> by_spec = BySpec() >>> list(by_spec._get_param_iterable('args')) [Param('foo')] >>> list(by_spec._get_param_iterable('options')) ['bar?']
For information on how an
str
param spec is interpreted, see the create_param() and parse_param_spec() functions in the ipalib.parameters module.Also see HasParam._filter_param_by_context().
- _on_finalize()¶
Do custom finalization.
This method is called from finalize(). Subclasses can override this method in order to add custom finalization.
- allow_rename = False¶
- already_exists_msg = Gettext('%(oname)s with name "%(pkey)s" already exists', domain='ipa', localedir=None)¶
- property api¶
Return API instance passed to __init__().
- attribute_members = {}¶
- backend = None¶
- backend_name = 'ldap2'¶
- bases = (<class 'ipalib.frontend.Object'>,)¶
- bindable = False¶
- container_dn = ''¶
- container_not_found_msg = Gettext('container entry (%(container)s) not found', domain='ipa', localedir=None)¶
- property context¶
- default_attributes = []¶
- disallow_object_classes = []¶
- doc = '\n Object representing a LDAP entry.\n '¶
- ensure_finalized()¶
Finalize plugin initialization if it has not yet been finalized.
- property env¶
- finalize()¶
Finalize plugin initialization.
This method calls _on_finalize() and locks the plugin object.
Subclasses should not override this method. Custom finalization is done in _on_finalize().
- class finalize_attr(name, value=None)¶
Bases:
object
Create a stub object for plugin attribute that isn’t set until the finalization of the plugin initialization.
When the stub object is accessed, it calls ensure_finalized() to make sure the plugin initialization is finalized. The stub object is expected to be replaced with the actual attribute value during the finalization (preferably in _on_finalize()), otherwise an AttributeError is raised.
This is used to implement on-demand finalization of plugin initialization.
- __annotations__ = {}¶
- __get__(obj, cls)¶
- __init__(name, value=None)¶
- __module__ = 'ipalib.plugable'¶
- __slots__ = ('name', 'value')¶
- name¶
- value¶
- full_name = 'LDAPObject/1'¶
- get_params()¶
This method gets called by HasParam._create_param_namespace().
- get_password_attributes(ldap, dn, entry_attrs)[source]¶
Search on the entry to determine if it has a password or keytab set.
A tuple is used to determine which attribute is set in entry_attrs. The value is set to True/False whether a given password type is set.
- json_friendly_attributes = ('parent_object', 'container_dn', 'object_name', 'object_name_plural', 'object_class', 'object_class_config', 'default_attributes', 'label', 'label_singular', 'hidden_attributes', 'uuid_attribute', 'attribute_members', 'name', 'takes_params', 'rdn_attribute', 'bindable', 'relationships')¶
- label = Gettext('Entry', domain='ipa', localedir=None)¶
- label_singular = Gettext('Entry', domain='ipa', localedir=None)¶
- limit_object_classes = []¶
- managed_permissions = {}¶
- methods = None¶
- name = 'LDAPObject'¶
- object_class = []¶
- object_class_config = None¶
- object_name = Gettext('entry', domain='ipa', localedir=None)¶
- object_name_plural = Gettext('entries', domain='ipa', localedir=None)¶
- object_not_found_msg = Gettext('%(pkey)s: %(oname)s not found', domain='ipa', localedir=None)¶
- params = None¶
- params_minus(*names)¶
Yield all Param whose name is not in
names
.
- params_minus_pk = None¶
- parent_not_found_msg = Gettext('%(parent)s: %(oname)s not found', domain='ipa', localedir=None)¶
- parent_object = ''¶
- password_attributes = []¶
- permission_filter_objectclasses = None¶
- possible_objectclasses = []¶
- primary_key = None¶
- rdn_attribute = ''¶
- relationships = {'member': ('Member', '', 'no_'), 'memberindirect': ('Indirect Member', None, 'no_indirect_'), 'membermanager': ('Group membership managed by', 'membermanager_', 'not_membermanager_'), 'memberof': ('Member Of', 'in_', 'not_in_'), 'memberofindirect': ('Indirect Member Of', None, 'not_in_indirect_')}¶
- search_attributes = []¶
- search_attributes_config = None¶
- search_display_attributes = []¶
- summary = 'Object representing a LDAP entry.'¶
- takes_params = ()¶
- uuid_attribute = ''¶
- version = '1'¶