Interface IDVDV2ServerConnectionParamsBuilderIam

Mittels des DVDV2ServerConnectionParamsBuilder werden die Verbindungsparameter zum DVDV2-Server festgelegt und eine Instanz des von DVDV2ServerConnectionParams erstellt.

Namespace: Dvdv.Api.Manager

Assembly: Dvdv.dll

Syntax

public interface IDVDV2ServerConnectionParamsBuilderIam

Methods

| Edit this page View Source

Build()

Erstellen der Instanz mit den Verbindungsparametern

Declaration

IDVDV2ServerConnectionParams Build()

Returns

Type	Description
IDVDV2ServerConnectionParams	die erzeugte Instanz mit den Verbindungsparametern

Exceptions

Type	Condition
DVDVConfigurationException	wird geworfen wenn Parameter fehlen

| Edit this page View Source

SetBaseUrl(Uri)

Setzen der Backend-URL. TODO: Failover Doku umziehen!! Da ein Failover umgesetzt ist, können hier mehrere Backend URLs angegeben werden. Es wird zunächst versucht, die erste URL zu erreichen. Ist dies nicht möglich, dann werden die weiterhin angegebenen URLs in der angegebenen Reihenfolge als Backup für den Failover verwendet. In regelmäßigen Abständen werden dann versucht, aif die derzeit nicht erreichbaren URLs zurück zu schwenken.

Declaration

IDVDV2ServerConnectionParamsBuilderIam SetBaseUrl(Uri baseUrl)

Parameters

Type	Name	Description
Uri	baseUrl	die Backend-URL

Returns

Type	Description
IDVDV2ServerConnectionParamsBuilderIam	den Builder

Exceptions

Type	Condition
ArgumentException	wird geworfen, wenn der übermittelte Wert ungültig ist
ArgumentNullException	wird geworfen, wenn der übermittelte Wert null ist

| Edit this page View Source

SetClientCertificate(X509Certificate2)

Setzen des Zertifikates mit dem der Token signiert werden soll. Das Zertifikat muss einen privaten Schlüssel enthalten.

Declaration

IDVDV2ServerConnectionParamsBuilderIam SetClientCertificate(X509Certificate2 clientCertificate)

Parameters

Type	Name	Description
X509Certificate2	clientCertificate	das Zertifikat

Returns

Type	Description
IDVDV2ServerConnectionParamsBuilderIam	den Builder

Exceptions

Type	Condition
ArgumentException	wird geworfen, wenn das übermittelte Zertifikat ungültig ist
ArgumentNullException	wird geworfen, wenn der übermittelte Wert null ist

| Edit this page View Source

SetClientCertificateAfterChange(DateTime, X509Certificate2)

Wie SetClientCertificate, aber mit voraussichtlichem Zertifikatswechseltermin

Declaration

IDVDV2ServerConnectionParamsBuilderIam SetClientCertificateAfterChange(DateTime approxChange, X509Certificate2 clientCertificate)

Parameters

Type	Name	Description
DateTime	approxChange	voraussichtlicher Zertifikatswechseltermin. Legt fest, ab wann das mit dieser Methode angegebene Certificate gegenüber demjenigen aus SetClientCertificate zu bevorzugen ist
X509Certificate2	clientCertificate	das Zertifikat

Returns

Type	Description
IDVDV2ServerConnectionParamsBuilderIam	den Builder

Exceptions

Type	Condition
ArgumentException	wird geworfen, wenn das übermittelte Zertifikat ungültig ist
ArgumentNullException	wird geworfen, wenn der übermittelte Wert null ist

| Edit this page View Source

SetClientId(string)

Setzen der CLientID; Wenn der AuthMode IAM_KEYCLOAK ist, muss ein Wert übermittelt werden, der nicht null oder leer ist

Declaration

IDVDV2ServerConnectionParamsBuilderIam SetClientId(string clientId)

Parameters

Type	Name	Description
string	clientId	die ClientId

Returns

Type	Description
IDVDV2ServerConnectionParamsBuilderIam	den Builder

Exceptions

Type	Condition
ArgumentException	wird geworfen, wenn der übermittelte Wert ungültig ist
ArgumentNullException	wird geworfen, wenn der übermittelte Wert null ist

| Edit this page View Source

SetIamOffset(TimeSpan)

Setzen des Zeitversatzes der Serverzeit des IAM-Keycloak-Authentifizieurgsservers gegenüber der Zeit des lokalen Systems. Bei einer stark auseinanderlaufenden Zeitspanne kann es dazu kommen, dass das am Client erstellte JWT-Token noch nicht gültig ist, wenn es am IAM entgegengenommen werden soll.

Declaration

IDVDV2ServerConnectionParamsBuilderIam SetIamOffset(TimeSpan iamOffset)

Parameters

Type	Name	Description
TimeSpan	iamOffset	der Zeitversatz in Sekunden

Returns

Type	Description
IDVDV2ServerConnectionParamsBuilderIam	den Builder

Exceptions

Type	Condition
ArgumentException	wird geworfen, wenn der übermittelte Wert ungültig ist
ArgumentNullException	wird geworfen, wenn der übermittelte Wert null ist

| Edit this page View Source

SetIamUrl(Uri)

Setzen der URL des IAM-Keycloak-Authentifizieurgsservers. Im Falle der Nutzung des DVDV-Servers ohne Authentifizierung oder mit lokaler Authentifizierung kann die Angabe unterbleiben

Declaration

IDVDV2ServerConnectionParamsBuilderIam SetIamUrl(Uri iamBaseUrl)

Parameters

Type	Name	Description
Uri	iamBaseUrl	die IAM-URL

Returns

Type	Description
IDVDV2ServerConnectionParamsBuilderIam	den Builder

Exceptions

Type	Condition
ArgumentException	wird geworfen, wenn der übermittelte Wert ungültig ist
ArgumentNullException	wird geworfen, wenn der übermittelte Wert null ist

| Edit this page View Source

SetProxy(IWebProxy)

Optionales Setzen eines Web-Proxies

Declaration

IDVDV2ServerConnectionParamsBuilderIam SetProxy(IWebProxy webProxy)

Parameters

Type	Name	Description
IWebProxy	webProxy	den Proxy

Returns

Type	Description
IDVDV2ServerConnectionParamsBuilderIam	den Builder

| Edit this page View Source

SetRemoteCertificateValidationCallback(RemoteCertificateValidationCallback)

Setzt eine Methode ein, die bei einer Zertifikatprüfung des SSL-Serverzertifikates bei einem Schnittstellenzugriff aufgerufen wird und ermöglicht die Einflussnahme auf das Prüfergebnis.

Diese Methode ist vom Typ RemoteCertificateValidationCallback und bietet die folgenden Parameter: "sender" Ermitteln des Senders des HTTP-Requests / "certificate" Ermitteln des SSL-Serverzertifikates des angefragten HTTP-Endpunktes / "chain" Ermitteln der Zertifikatkette des SSL-Serverzertifikates des angefragten HTTP-Endpunktes / "sslPolicyErrors" Ermitteln der Prüffehler bei der standardmäßigen Prüfung des SSL-Serverzertifikates, bei (sslPolicyErrors == SslPolicyErrors.None) würde ohne die Registrierung einer Callback-Methode "true" zurückgegeben. / Der Rückgabewert ist das Ergebnis der Zertifikatprüfung. Das Ergebnis der Callback-Methode überschreibt dabei das Ergebnis der Standardprüfung. Damit ist es z.B. möglich selbstsignierte Zertifikate zu akzeptieren, ohne sie in den Zertifikat-Store des Computers zu übernehmen.

Declaration

IDVDV2ServerConnectionParamsBuilderIam SetRemoteCertificateValidationCallback(RemoteCertificateValidationCallback remoteCertificateValidationCallback)

Parameters

Type	Name	Description
RemoteCertificateValidationCallback	remoteCertificateValidationCallback	die Methode zur Zertifikatprüfung

Returns

Type	Description
IDVDV2ServerConnectionParamsBuilderIam

| Edit this page View Source

SetRequestTimeout(TimeSpan)

Setzen des Timeouts bei der Durchführung der DVDV-Anfrage

Declaration

IDVDV2ServerConnectionParamsBuilderIam SetRequestTimeout(TimeSpan requestTimeout)

Parameters

Type	Name	Description
TimeSpan	requestTimeout	den zu verwendenen Timeout

Returns

Type	Description
IDVDV2ServerConnectionParamsBuilderIam	den Builder

| Edit this page View Source

SetTokenTimeout(TimeSpan)

Setzen des Timeouts für den JWT-Access-Token, der zur Abholung eines Zugriffstoken beim IAM-Keycloak oder am DVDV-Kernsystem verwendet wird.

Declaration

IDVDV2ServerConnectionParamsBuilderIam SetTokenTimeout(TimeSpan tokenTimeout)

Parameters

Type	Name	Description
TimeSpan	tokenTimeout	den zu verwendendenen Timeout für den Accesstoken des IAMs

Returns

Type	Description
IDVDV2ServerConnectionParamsBuilderIam	den Builder