LdapRequestInformation (Objekt) (deprecated): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
K (hat „LdapRequestInformation“ nach „LdapRequestInformation (Objekt)“ verschoben)
 
(15 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
  
 
==Beschreibung==
 
==Beschreibung==
Mit einem LdapRequestInformation-Objekt können aubfragen auf einen LDAP-Server abgesetzt werden. Die Ergebnis-Liste wird dazu verwendet daraus Artikel, Resource oder Nutzer zu erzeugen, zu ändern oder zu löschen.
+
'''''Deprecated.''' Dieses Objekt wurde für die Synchronisation von LDAP-Daten mit dem IES verwendet. Die LDAP-Synchronisation wurde neu implementiert und sollte nicht mehr über dieses Objekt erfolgen (siehe [[LDAP]]).''
 +
 
 +
Mit einem LdapRequestInformation-Objekt können Abfragen auf einen LDAP-Server abgesetzt werden. Die Ergebnis-Liste wird dazu verwendet daraus Artikel, Resource oder Nutzer zu erzeugen, zu ändern oder zu löschen.
  
 
==Attribute==
 
==Attribute==
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 16: Zeile 18:
 
|-
 
|-
 
| field
 
| field
| [[Variable]]
+
| [[String]]
 
| Variablenname des Objektes
 
| Variablenname des Objektes
 
| 1
 
| 1
 +
|-
 +
| lastField
 +
| [[String]]
 +
| Variablenname des Objektes ohne Struktur-Date
 +
| 2.13
 
|-
 
|-
 
| root
 
| root
 
| [[Element]]
 
| [[Element]]
 
| Root-Element dieser Information
 
| Root-Element dieser Information
 +
| 1
 +
|-
 +
| parent
 +
| [[ID]]
 +
| ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein
 
| 1
 
| 1
 
|-
 
|-
Zeile 43: Zeile 55:
 
| ldapFilter
 
| ldapFilter
 
| [[String]]
 
| [[String]]
| Filter-Query, mit der die Ldap-Element
+
| Filter-Query, mit der die Ldap-Elemente
 
gesucht werden sollen
 
gesucht werden sollen
 
| 1
 
| 1
 
|-
 
|-
 
| ldapSearchScope
 
| ldapSearchScope
| [system.constants.LDAP_ONE_LEVEL_SEARCH | system.constants.LDAP_SUB_TREE_SEARCH]]
+
| <code>[[Constants|system.constants.LDAP_ONE_LEVEL_SEARCH]]</code>, <code>[[Constants|system.constants.LDAP_SUB_TREE_SEARCH]]</code>
| Gibt an, ob nur das ldapSearchBase-Verzeichnis durchsucht werden soll oder ab diesem Verzeichnis rekursive gesucht werden soll.
+
| Gibt an, ob nur das ldapSearchBase-Verzeichnis durchsucht werden soll oder ob ab diesem Verzeichnis rekursive gesucht werden soll.
 
| 1
 
| 1
 
|-
 
|-
Zeile 64: Zeile 76:
 
| ldapLastName
 
| ldapLastName
 
| [[String]]
 
| [[String]]
| Wenn aus den Ldap-Daten Nutzer erzeugt werden sollen, ist hier der Ldap-Attributname für der Nachname des Nutzer angegeben.
+
| Wenn aus den Ldap-Daten Nutzer erzeugt werden sollen, ist hier der Ldap-Attributname für den Nachname des Nutzer angegeben.
 
| 1
 
| 1
 
|-
 
|-
 
| ldapFirstName
 
| ldapFirstName
 
| [[String]]
 
| [[String]]
| Wenn aus den Ldap-Daten Nutzer erzeugt werden sollen, ist hier der Ldap-Attributname für der Vorname des Nutzer angegeben
+
| Wenn aus den Ldap-Daten Nutzer erzeugt werden sollen, ist hier der Ldap-Attributname für den Vorname des Nutzer angegeben
 
| 1
 
| 1
 
|-
 
|-
Zeile 93: Zeile 105:
 
|-
 
|-
 
| ldapMappingMap
 
| ldapMappingMap
| [[Map]]
+
| [[Map]]&nbsp;<[[String]],[[String]]>
 
| Gibt die (LDAP-Attributnamen) - (Artikel-Feldnamen) Mappings an
 
| Gibt die (LDAP-Attributnamen) - (Artikel-Feldnamen) Mappings an
 
| 1
 
| 1
 
|-
 
|-
 
| ldapMapping
 
| ldapMapping
| [[Map]]
+
| [[String]]
 
| Gibt die (LDAP-Attributnamen) - (Artikel-Feldnamen) Mappings als eine Zeichenkette an. Jede Zeile entspricht einem Mapping. Schlüssel/Werte-Paare werden durch ein = (gleich) getrennt
 
| Gibt die (LDAP-Attributnamen) - (Artikel-Feldnamen) Mappings als eine Zeichenkette an. Jede Zeile entspricht einem Mapping. Schlüssel/Werte-Paare werden durch ein = (gleich) getrennt
 
| 1
 
| 1
 
|-
 
|-
 
| error
 
| error
| [[Collection]]
+
| [[Collection]]&nbsp;<[[String]]>
| Gibt eine Liste alle Fehlermeldungen aus, die bei der Anfrage und bei den Datenabgleich aufgetreten sind
+
| Gibt eine Liste alle Fehlermeldungen aus, die bei der Anfrage und bei dem Datenabgleich aufgetreten sind
 
| 1
 
| 1
 
|}
 
|}
 +
 +
==Methoden==
 +
{| class="prettytable sortable"
 +
|- class="hintergrundfarbe1"
 +
! Methode || Rückgabewert || Beschreibung || ab IES Version
 +
|-
 +
| <code>toXip([[Boolean]] emptyFields)</code>
 +
| String
 +
| Erzeugt XML-Daten im XIP-Format für dieses Objekt
 +
| 2.14
 +
|}
 +
 +
;<code>[[String]] toXip([[Boolean]] emptyFields)</code>
 +
:Erzeugt XML-Daten im XIP-Format für dieses Objekt.
 +
:;Parameter
 +
::;<code>Boolean emptyFields</code>
 +
:::Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
 +
:;Rückgabewert
 +
::;String
 +
:::XML-Daten im XIP-Format
 +
  
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
[[Category:Qualität_des_Inhalts_prüfen]]
 
[[Category:Qualität_der_Sprache_prüfen]]
 
 
[[Category:Qualität_des_Codes_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 4. November 2015, 13:13 Uhr

Name

LdapRequestInformation - Abfrage von LDAP-Daten

Beschreibung

Deprecated. Dieses Objekt wurde für die Synchronisation von LDAP-Daten mit dem IES verwendet. Die LDAP-Synchronisation wurde neu implementiert und sollte nicht mehr über dieses Objekt erfolgen (siehe LDAP).

Mit einem LdapRequestInformation-Objekt können Abfragen auf einen LDAP-Server abgesetzt werden. Die Ergebnis-Liste wird dazu verwendet daraus Artikel, Resource oder Nutzer zu erzeugen, zu ändern oder zu löschen.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Objektes 1
field String Variablenname des Objektes 1
lastField String Variablenname des Objektes ohne Struktur-Date 2.13
root Element Root-Element dieser Information 1
parent ID ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein 1
isEmpty Boolean Liefert immer false 1
ldapServer LdapServer Zu verwendender LdapServer 1
ldapSearchBase String Basis-Verzeichnis, ab dem gesucht werden

soll

1
ldapFilter String Filter-Query, mit der die Ldap-Elemente

gesucht werden sollen

1
ldapSearchScope system.constants.LDAP_ONE_LEVEL_SEARCH, system.constants.LDAP_SUB_TREE_SEARCH Gibt an, ob nur das ldapSearchBase-Verzeichnis durchsucht werden soll oder ob ab diesem Verzeichnis rekursive gesucht werden soll. 1
ldapUid String Ldap-Attributname, das die UID des LDAPEintrags enthält 1
ldapLogin String Wenn aus den Ldap-Daten Nutzer erzeugt werden sollen ist hier der Ldap-Attributname für das Login des Nutzer angegeben 1
ldapLastName String Wenn aus den Ldap-Daten Nutzer erzeugt werden sollen, ist hier der Ldap-Attributname für den Nachname des Nutzer angegeben. 1
ldapFirstName String Wenn aus den Ldap-Daten Nutzer erzeugt werden sollen, ist hier der Ldap-Attributname für den Vorname des Nutzer angegeben 1
ldapLocale String Wenn aus den Ldap-Daten Nutzer erzeugt werden sollen, ist hier der Ldap-Attributname für die Sprache des Nutzer angegeben 1
ldapArticleName String Wenn aus den Ldap-Daten ein Artikel oder eine Ressource erzeugt werden soll, ist hier der Ldap-Attributname für den Artikelnamen angegeben 1
ldapArticleFileName String Wenn aus den Ldap-Daten ein Artikel oder eine Ressource erzeugt werden soll, ist hier der Ldap-Attributname für den Artikel-Dateinamen angegeben 1
ldapTargetPool ID Gibt den Pool an, in dem das Element angelegt werden soll 1
ldapMappingMap Map <String,String> Gibt die (LDAP-Attributnamen) - (Artikel-Feldnamen) Mappings an 1
ldapMapping String Gibt die (LDAP-Attributnamen) - (Artikel-Feldnamen) Mappings als eine Zeichenkette an. Jede Zeile entspricht einem Mapping. Schlüssel/Werte-Paare werden durch ein = (gleich) getrennt 1
error Collection <String> Gibt eine Liste alle Fehlermeldungen aus, die bei der Anfrage und bei dem Datenabgleich aufgetreten sind 1

Methoden

Methode Rückgabewert Beschreibung ab IES Version
toXip(Boolean emptyFields) String Erzeugt XML-Daten im XIP-Format für dieses Objekt 2.14
String toXip(Boolean emptyFields)
Erzeugt XML-Daten im XIP-Format für dieses Objekt.
Parameter
Boolean emptyFields
Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
Rückgabewert
String
XML-Daten im XIP-Format