Package de.gematik.ti.epa.vzd.gem.api

Class GemDirectoryEntryAdministrationApi

java.lang.Object

de.gematik.ti.epa.vzd.client.api.DirectoryEntryAdministrationApi

de.gematik.ti.epa.vzd.gem.api.GemDirectoryEntryAdministrationApi

public class GemDirectoryEntryAdministrationApi
extends DirectoryEntryAdministrationApi

Overrides all functions of DirectoryEntryAdministration api that build calls for the different commands to add the OAuth2 Token to the header

Constructor Summary

Constructors

Constructor	Description
GemDirectoryEntryAdministrationApi(GemApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	addDirectoryEntryCall(CreateDirectoryEntry createDirectoryEntry, ApiCallback _callback)	Build call for addDirectoryEntry
okhttp3.Call	deleteDirectoryEntryCall(java.lang.String uid, ApiCallback _callback)	Build call for deleteDirectoryEntry
okhttp3.Call	modifyDirectoryEntryCall(java.lang.String uid, BaseDirectoryEntry baseDirectoryEntry, ApiCallback _callback)	Build call for modifyDirectoryEntry
okhttp3.Call	readDirectoryEntryCall(java.lang.String uid, java.lang.String givenName, java.lang.String sn, java.lang.String cn, java.lang.String displayName, java.lang.String streetAddress, java.lang.String postalCode, java.lang.String countryCode, java.lang.String localityName, java.lang.String stateOrProvinceName, java.lang.String title, java.lang.String organization, java.lang.String otherName, java.lang.String telematikID, java.lang.String telematikIDSubStr, java.lang.String specialization, java.lang.String domainID, java.lang.String holder, java.lang.String personalEntry, java.lang.String dataFromAuthority, java.lang.String professionOID, java.lang.String entryType, java.lang.Boolean baseEntryOnly, ApiCallback _callback)	Build call for readDirectoryEntry

Methods inherited from class de.gematik.ti.epa.vzd.client.api.DirectoryEntryAdministrationApi

addDirectoryEntry, addDirectoryEntryAsync, addDirectoryEntryWithHttpInfo, deleteDirectoryEntry, deleteDirectoryEntryAsync, deleteDirectoryEntryWithHttpInfo, getApiClient, modifyDirectoryEntry, modifyDirectoryEntryAsync, modifyDirectoryEntryWithHttpInfo, readDirectoryEntry, readDirectoryEntryAsync, readDirectoryEntryWithHttpInfo, setApiClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GemDirectoryEntryAdministrationApi

public GemDirectoryEntryAdministrationApi(GemApiClient apiClient)

Method Detail

addDirectoryEntryCall

public okhttp3.Call addDirectoryEntryCall(CreateDirectoryEntry createDirectoryEntry,
                                          ApiCallback _callback)
                                   throws ApiException

Description copied from class: DirectoryEntryAdministrationApi

Build call for addDirectoryEntry

Overrides:

addDirectoryEntryCall in class DirectoryEntryAdministrationApi

Parameters:

createDirectoryEntry - Datensatz für den neuen Eintrag. Die Attribute müssen wie folgt belegt sein dn.* Leer/nicht vorhanden (wird vom Verzeichnisdienst belegt) givenName Nicht vorhanden (wird vom Verzeichnisdienst belegt) sn Nicht vorhanden (wird vom Verzeichnisdienst belegt) cn Nicht vorhanden (wird vom Verzeichnisdienst belegt) displayName Kann optional belegt werden. streetAddress Kann optional belegt werden. postalCode Kann optional belegt werden. countryCode Kann optional belegt werden. Falls nicht belegt, ergänzt der VZD den Code für Deutschland (Defaultwert). localityName Kann optional belegt werden. stateOrProvinceName Kann optional belegt werden. title Kann optional belegt werden. organization Kann optional belegt werden. otherName Kann optional belegt werden. telematikID Kann optional belegt werden. Das ist die telematikID in den Basisdaten (baseDirectoryEntry). Wird diese telematikID und userCertificate bzw. die telematikID in userCertificate angegeben, dann müssen diese telematikIDs übereinstimmen. Bei unterschiedlichen telematikID wird die Operation mit Fehlercode 422 abgelehnt. specialization Kann optional belegt werden. domainID Kann optional belegt werden. holder Kann optional belegt werden (falls nicht belegt, dann vom VZD aus dem ID_Token entnommen). maxKOMLEadr Kann optional belegt werden. personalEntry Nicht vorhanden (wird vom Verzeichnisdienst belegt) dataFromAuthority Nicht vorhanden (wird vom Verzeichnisdienst belegt) userCertificates Kann optional belegt werden. dn.uid Leer/nicht vorhanden (wird vom Verzeichnisdienst belegt) dn.dc Leer/nicht vorhanden (wird vom Verzeichnisdienst belegt) dn.ou Leer/nicht vorhanden (wird vom Verzeichnisdienst belegt) dn.cn Leer/nicht vorhanden (wird vom Verzeichnisdienst belegt) telematikID Kann optional belegt werden. Wird telematikID und userCertificate angegeben, dann muss diese telematikID mit der telematikID im userCertificate übereinstimmen. Bei unterschiedlichen telematikID wird die Operation mit Fehlercode 422 abgelehnt. entryType Nicht vorhanden (wird vom Verzeichnisdienst belegt) professionOID Nicht vorhanden (wird vom Verzeichnisdienst belegt) usage Kann optional belegt werden. userCertificate Kann optional belegt werden (Format DER, Base64 kodiert) description Kann optional belegt werden. Entsprechend gemSpec_VZD wird ein Teil der Attribute durch den Verzeichnisdienst automatisch mit Werten aus dem Zertifikat gefüllt. Wenn in dieser Operation Attribute - für die dies erlaubt ist - mit einem Wert belegt werden, wird dieser Wert im Verzeichniseintrag gespeichert (auch wenn der Wert durch den Verzeichnisdienst aus dem Zertifikat entnommen werden kann). (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteDirectoryEntryCall

public okhttp3.Call deleteDirectoryEntryCall(java.lang.String uid,
                                             ApiCallback _callback)
                                      throws ApiException

Description copied from class: DirectoryEntryAdministrationApi

Build call for deleteDirectoryEntry

Overrides:

deleteDirectoryEntryCall in class DirectoryEntryAdministrationApi

Parameters:

uid - ID von dem zu löschenden Verzeichniseintrag Gelöscht werden der Basis Verzeichniseintrag sowie alle dazugehörenden Zertifikate und Fachdaten. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

modifyDirectoryEntryCall

public okhttp3.Call modifyDirectoryEntryCall(java.lang.String uid,
                                             BaseDirectoryEntry baseDirectoryEntry,
                                             ApiCallback _callback)
                                      throws ApiException

Description copied from class: DirectoryEntryAdministrationApi

Build call for modifyDirectoryEntry

Overrides:

modifyDirectoryEntryCall in class DirectoryEntryAdministrationApi

Parameters:

uid - ID von dem Verzeichniseintrag (required)

baseDirectoryEntry - Datensatz für die Aktualisierung des Eintrags Die Attribute müssen wie folgt belegt sein dn.* Nicht vorhanden (Adressierung erfolgt über uid in Path). givenName Nicht vorhanden. sn Nicht vorhanden. cn Nicht vorhanden. displayName Kann optional belegt werden. streetAddress Kann optional belegt werden. postalCode Kann optional belegt werden. countryCode Kann optional belegt werden. localityName Kann optional belegt werden. stateOrProvinceName Kann optional belegt werden. title Kann optional belegt werden. organization Kann optional belegt werden. otherName Nicht vorhanden. telematikID Kann optional belegt werden. Das ist die telematikID in den Basisdaten (baseDirectoryEntry). Sind Zertifikateseinträge (userCertificate) vorhanden, dann müssen die telematikIDs übereinstimmen. Bei unterschiedlichen telematikID wird die Operation mit Fehlercode 422 abgelehnt. specialization Kann optional belegt werden. domainID Kann optional belegt werden. holder Kann optional belegt werden. maxKOMLEadr Kann optional belegt werden. personalEntry Nicht vorhanden. dataFromAuthority Nicht vorhanden (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

readDirectoryEntryCall

public okhttp3.Call readDirectoryEntryCall(java.lang.String uid,
                                           java.lang.String givenName,
                                           java.lang.String sn,
                                           java.lang.String cn,
                                           java.lang.String displayName,
                                           java.lang.String streetAddress,
                                           java.lang.String postalCode,
                                           java.lang.String countryCode,
                                           java.lang.String localityName,
                                           java.lang.String stateOrProvinceName,
                                           java.lang.String title,
                                           java.lang.String organization,
                                           java.lang.String otherName,
                                           java.lang.String telematikID,
                                           java.lang.String telematikIDSubStr,
                                           java.lang.String specialization,
                                           java.lang.String domainID,
                                           java.lang.String holder,
                                           java.lang.String personalEntry,
                                           java.lang.String dataFromAuthority,
                                           java.lang.String professionOID,
                                           java.lang.String entryType,
                                           java.lang.Boolean baseEntryOnly,
                                           ApiCallback _callback)
                                    throws ApiException

Description copied from class: DirectoryEntryAdministrationApi

Build call for readDirectoryEntry

Overrides:

readDirectoryEntryCall in class DirectoryEntryAdministrationApi

Parameters:

uid - ID von dem Verzeichniseintrag (distinguishedName.uid) (optional)

givenName - Erlaubt die Suche mit Hilfe des Attributs givenName. (optional)

sn - Erlaubt die Suche mit Hilfe des Attributs sn. (optional)

cn - Erlaubt die Suche mit Hilfe des Attributs cn. (optional)

displayName - Erlaubt die Suche mit Hilfe des Attributs displayName. (optional)

streetAddress - Erlaubt die Suche mit Hilfe des Attributs streetAddress. (optional)

postalCode - Erlaubt die Suche mit Hilfe des Attributs postalCode. (optional)

countryCode - Erlaubt die Suche mit Hilfe des Attributs countryCode. (optional)

localityName - Erlaubt die Suche mit Hilfe des Attributs localityName. (optional)

stateOrProvinceName - Erlaubt die Suche mit Hilfe des Attributs stateOrProvinceName. (optional)

title - Erlaubt die Suche mit Hilfe des Attributs title. (optional)

organization - Erlaubt die Suche mit Hilfe des Attributs organization. (optional)

otherName - Erlaubt die Suche mit Hilfe des Attributs otherName. (optional)

telematikID - Erlaubt die Suche mit Hilfe des Attributs telematikID (die telematikID in den Basisdaten). (optional)

telematikIDSubStr - Erlaubt die Suche nach einem Substring am Anfang der telematikID (die telematikID in den Basisdaten). Entspricht der LDAP Filters Substring Assertion vom Typ \"subInitial Component\". (optional)

specialization - Erlaubt die Suche mit Hilfe des Attributs specialization. Der Verzeichniseintrag wird selektiert, wenn die angegebene domainID im Attribut domainID (array) des Verzeichniseintrags enthalten ist. (optional)

domainID - Erlaubt die Suche mit Hilfe des Attributs domainID. Der Verzeichniseintrag wird selektiert, wenn die angegebene domainID im Attribut domainID (array) des Verzeichniseintrags enthalten ist. (optional)

holder - Erlaubt die Suche mit Hilfe des Attributs holder. Der Verzeichniseintrag wird selektiert, wenn der angegebene holder im Attribut holder (array) des Verzeichniseintrags enthalten ist. Wenn der Parameter mit dem eigenen Wert des Clients belegt wird, werden alle gefundenen Einträge zurückgegeben (maximal 100 Einträge). Zur Suche nach Einträge ohne holder ist der Parameter mit dem einem leeren String \"\" zu belegen. Auch in diesem Fall werden alle gefundenen Einträge zurückgegeben (maximal 100 Einträge). (optional)

personalEntry - Erlaubt die Suche mit Hilfe des Attributs personalEntry. (optional)

dataFromAuthority - Erlaubt die Suche mit Hilfe des Attributs dataFromAuthority. (optional)

professionOID - Erlaubt die Suche mit Hilfe des Attributs professionOID. Selektiert der Verzeichniseintrag, wenn der angegebene Wert in den professionOID's (array) des Basiseintrags vorhanden ist. (optional)

entryType - Erlaubt die Suche mit Hilfe des Attributs entryType. Selektiert der Verzeichniseintrag, wenn der angegebene Wert in den entryType's (array) des Basiseintrags vorhanden ist. (optional)

baseEntryOnly - Mit baseEntryOnly = \"true\" wird nur der Basiseintrag (baseDirectoryEntry) im Response zurückgegeben. Falls nicht angegeben oder mit \"false\" belegt, wird der gesamte Verzeichniseintrag mit Zertifikaten und Fachdaten im Response zurückgegeben. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object