web2ldap.app.plugins.aedir.AEZonePrefixCommonName Class Reference

Inheritance diagram for web2ldap.app.plugins.aedir.AEZonePrefixCommonName:

Collaboration diagram for web2ldap.app.plugins.aedir.AEZonePrefixCommonName:

Public Member Functions
bytes	sanitize (self, bytes attr_value)
List[bytes]	transmute (self, List[bytes] attr_values)
str	form_value (self)
Public Member Functions inherited from web2ldap.app.schema.syntaxes.DirectoryString
str	display (self, vidx, links)
Public Member Functions inherited from web2ldap.app.schema.syntaxes.LDAPSyntax
def	__init__ (self, app, Optional[str] dn, SubSchema schema, Optional[str] attrType, Optional[bytes] attr_value, entry=None)
def	dn (self)
def	av_u (self)
bytes	sanitize (self, bytes attr_value)
List[bytes]	transmute (self, List[bytes] attr_values)
def	validate (self, bytes attr_value)
str	value_button (self, command, row, mode, link_text=None)
str	form_value (self)
def	input_fields (self)
web_forms.Field	input_field (self)
str	display (self, vidx, links)
Public Member Functions inherited from web2ldap.app.plugins.aedir.AEObjectMixIn
def	ae_status (self)

Static Public Attributes
	str
	pattern = re.compile(r'^[a-z0-9]+-[a-z0-9-]+$')
dictionary	special_names
Static Public Attributes inherited from web2ldap.app.plugins.aedir.AECommonName
	str
int	max_values = 1
tuple	sani_funcs
Static Public Attributes inherited from web2ldap.app.schema.syntaxes.DirectoryString
	str
string	html_tmpl = '{av}'
Static Public Attributes inherited from web2ldap.app.schema.syntaxes.LDAPSyntax
	str
	int
	bool

Private Member Functions
bool	_validate (self, bytes attr_value)

Detailed Description

Base class for handling 'cn' in entries which must have zone name as prefix

Definition at line 2105 of file aedir.py.

Member Function Documentation

_validate()

bool web2ldap.app.plugins.aedir.AEZonePrefixCommonName._validate (   self, bytes  attr_value  )

private

check the syntax of attr_value

Implementors can overload this method to apply arbitrary syntax checks.

Reimplemented from web2ldap.app.schema.syntaxes.DirectoryString.

Definition at line 2124 of file aedir.py.

References web2ldap.app.entry.DisplayEntry._app, web2ldap.app.read.VCardEntry._app, web2ldap.app.schema.syntaxes.LDAPSyntax._app, web2ldap.app.schema.viewer.DisplaySchemaElement._app, web2ldap.app.search.PrintableHTMLWriter._app, and web2ldap.app.plugins.aedir.AEObjectMixIn._get_zone_name().

Referenced by web2ldap.app.schema.syntaxes.Image.sanitize(), and web2ldap.app.schema.syntaxes.LDAPSyntax.validate().

form_value()

str web2ldap.app.plugins.aedir.AEZonePrefixCommonName.form_value

(

self

)

Transform LDAP string representations to HTML form input field
values. Returns Unicode string to be encoded with the browser's
accepted charset.

This is the inverse of LDAPSyntax.sanitize().

Reimplemented from web2ldap.app.schema.syntaxes.LDAPSyntax.

Definition at line 2137 of file aedir.py.

References web2ldap.app.plugins.openldap.ReqMod._av, web2ldap.app.schema.syntaxes.LDAPSyntax._av, web2ldap.app.schema.syntaxes.LDAPSyntax._av_u, web2ldap.app.plugins.aedir.AEObjectMixIn._get_zone_name(), web2ldap.app.plugins.activedirectory.Interval.av_u, web2ldap.app.schema.syntaxes.LDAPSyntax.av_u(), and web2ldap.app.plugins.aedir.AEZonePrefixCommonName.special_names.

Referenced by web2ldap.app.schema.syntaxes.DNSDomain.display(), web2ldap.app.plugins.activedirectory.LogonHours.input_field(), web2ldap.app.plugins.aedir.AEHomeDirectory.input_field(), web2ldap.app.plugins.aedir.AEUIDNumber.input_field(), web2ldap.app.plugins.aedir.AEUserUid.input_field(), web2ldap.app.plugins.aedir.AEMemberUid.input_field(), web2ldap.app.plugins.aedir.AEDerefAttribute.input_field(), web2ldap.app.plugins.aedir.AEUniqueIdentifier.input_field(), web2ldap.app.plugins.aedir.AERFC822MailMember.input_field(), web2ldap.app.plugins.aedir.AESudoHost.input_field(), web2ldap.app.schema.syntaxes.LDAPSyntax.input_field(), web2ldap.app.schema.syntaxes.Integer.input_field(), web2ldap.app.schema.syntaxes.OctetString.input_field(), web2ldap.app.schema.syntaxes.MultilineText.input_field(), web2ldap.app.schema.syntaxes.SelectList.input_field(), web2ldap.app.schema.syntaxes.BitArrayInteger.input_field(), and web2ldap.app.schema.syntaxes.ComposedAttribute.input_field().

sanitize()

bytes web2ldap.app.plugins.aedir.AEZonePrefixCommonName.sanitize	(		self,
		bytes	attr_value
	)

Transforms the HTML form input field values into LDAP string
representations and returns raw binary string.

This is the inverse of LDAPSyntax.form_value().

When using this method one MUST NOT assume that the whole entry is
present.

Reimplemented from web2ldap.app.schema.syntaxes.LDAPSyntax.

Definition at line 2117 of file aedir.py.

transmute()

List[bytes] web2ldap.app.plugins.aedir.AEZonePrefixCommonName.transmute	(		self,
		List[bytes]	attr_values
	)

This method can be implemented to transmute attribute values and has
to handle LDAP string representations (raw binary strings).

This method has access to the whole entry after processing all input.

Implementors should be prepared that this method could be called
more than once. If there's nothing to change then simply return the
same value list.

Exceptions KeyError or IndexError are caught by the calling code to
re-iterate invoking this method.

Reimplemented from web2ldap.app.schema.syntaxes.LDAPSyntax.

Definition at line 2120 of file aedir.py.

Member Data Documentation

pattern

web2ldap.app.plugins.aedir.AEZonePrefixCommonName.pattern = re.compile(r'^[a-z0-9]+-[a-z0-9-]+$')

static

Definition at line 2111 of file aedir.py.

Referenced by web2ldap.app.schema.syntaxes.LDAPSyntax.validate().

special_names

dictionary web2ldap.app.plugins.aedir.AEZonePrefixCommonName.special_names

static

Initial value:

=  {
        'zone-admins',
        'zone-auditors',
    }

Definition at line 2112 of file aedir.py.

Referenced by web2ldap.app.plugins.aedir.AEZonePrefixCommonName.form_value().

str

web2ldap.app.plugins.aedir.AEZonePrefixCommonName.str

static

Definition at line 2109 of file aedir.py.

---

The documentation for this class was generated from the following file:

• web2ldap/app/plugins/aedir.py