ClaimNameParts

open class ClaimNameParts(val name: String) : ClaimName

Class representing a name of a claim. A claim's name identifies it amongst others.

In the Comuny context a ClaimNameParts enforces a certain format. A claim name looks like comuny.type.factor[.level[.method[.provider]]]. Only lowercase characters are allowed.

Syntax

It starts with comuny when it's provided by comuny or can be specified with own namespace, then specifies a type and factor. Optional parts are level, method, and provider. The level part starts with a l followed by a digit.

+----------+-----------+----------+---------+----------+
| Part | Regex | Required | Default | Example |
+----------+-----------+----------+---------+----------+
| namespace| [a-z0-9] | n | "comuny"| "comuny" |
| type | (ver|aut) | y | | "ver" |
| factor | [a-z0-9] | y | | "email" |
| level | l[0-9] | n | "l0" | "l2" |
| method | [a-z0-9] | n | "" | "otp" |
| provider | [a-z0-9] | n | "" | "comuny" |
+----------+-----------+----------+---------+----------+

Parameters

type

Type telling if the claim is used for verification or authorization

factor

Identity factor, e.g. email, idcard, or mobile

level

Level indicating the quality of the process used to create the claim

method

Method used in the claim creation process to verify a factor, e.g. OTP

provider

Name of the provider (IdP) of the claim

Constructors

Link copied to clipboard
fun ClaimNameParts(    nameSpace: String = "comuny",     type: String,     factor: String,     level: Int = 0,     method: String,     provider: String)
Link copied to clipboard
fun ClaimNameParts(name: String)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

For equality, all elements of the claim name have to match.

Link copied to clipboard
open override fun hashCode(): Int

Return hash code of the string representation.

Link copied to clipboard
open override fun toString(): String

Properly follows JAVA toString convention and returns all values. For claim name as a string in the Comuny format, use property name

Properties

Link copied to clipboard
val factor: String
Link copied to clipboard
val level: Int
Link copied to clipboard
val method: String
Link copied to clipboard
val name: String

Returns string in the Comuny format At least comuny.<type>.<factor>.l0 is returned.

Link copied to clipboard
val nameSpace: String
Link copied to clipboard
val provider: String
Link copied to clipboard
val type: String

Inheritors

Link copied to clipboard
Link copied to clipboard