From d84d93c93f84a6b015230c3ed43443ed1a7a2b62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sondre=20Eikanger=20Kval=C3=B8?= Date: Mon, 27 Dec 2021 09:48:04 +0100 Subject: [PATCH] =?UTF-8?q?La=20p=C3=A5=20litt=20mer=20javadocs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../fiks/maskinporten/AccessTokenRequest.kt | 27 ++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/maskinporten-client/src/main/kotlin/no/ks/fiks/maskinporten/AccessTokenRequest.kt b/maskinporten-client/src/main/kotlin/no/ks/fiks/maskinporten/AccessTokenRequest.kt index 939609a..0008e8f 100644 --- a/maskinporten-client/src/main/kotlin/no/ks/fiks/maskinporten/AccessTokenRequest.kt +++ b/maskinporten-client/src/main/kotlin/no/ks/fiks/maskinporten/AccessTokenRequest.kt @@ -14,16 +14,22 @@ data class AccessTokenRequest( val consumerOrg: String? = null, /** - * Ønsket audience for access token. Optional. + * Ønsket audience for access token. Valgfritt. */ val audience: String?) { companion object { + /** + * Oppretter en builder som skal gjøre det lettere å bygge AccessTokenRequest fra Java + */ @JvmStatic fun builder() = AccessTokenRequestBuilder() } } +/** + * Builder som gjør det lettere for klienter implementert i Java å bygge en AccessTokenRequest + */ class AccessTokenRequestBuilder { private var scopes: Set = emptySet() @@ -32,28 +38,43 @@ class AccessTokenRequestBuilder { private var audience: String? = null + /** + * Legger til et scope som skal brukes i forespørsel mot Maskinporten. Minst et scope må oppgies + */ fun scope(scope: String): AccessTokenRequestBuilder { this.scopes += scope return this } - fun scopes(scopes: Set): AccessTokenRequestBuilder { + /** + * Legger til et set med scopes som skal brukes i forespørsel mot Maskinporten. Minst et scope må oppgies + */ + fun scopes(scopes: java.util.Set): AccessTokenRequestBuilder { this.scopes = scopes.toSet() return this } + /** + * Legger til verdi som skal brukes i "aud" feltet i forespørsel mot Maskinporten. Valgfritt + */ fun audience(audience: String): AccessTokenRequestBuilder { this.audience = audience return this } + /** + * Brukes til forespørsler der man ønsker å få generert et token på vegne av en annen organisasjon. + */ fun consumerOrg(consumerOrg: String): AccessTokenRequestBuilder { this.consumerOrg = consumerOrg return this } + /** + * Bygger forespørselsobjekt + */ fun build(): AccessTokenRequest = AccessTokenRequest( - scopes = this.scopes.toSet(), + scopes = scopes.toSet(), audience = this.audience, consumerOrg = this.consumerOrg )