com.atlan.pkg.serde.cell.RoleXformer.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of package-toolkit-runtime Show documentation

Atlan custom package runtime toolkit

There is a newer version: 4.2.0

Show newest version

/* SPDX-License-Identifier: Apache-2.0
   Copyright 2023 Atlan Pte. Ltd. */
package com.atlan.pkg.serde.cell

import com.atlan.AtlanClient
import com.atlan.exception.NotFoundException
import com.atlan.model.assets.Asset

/**
 * Static object to transform (really to validate) role references.
 */
object RoleXformer {
    val FIELDS =
        setOf(
            Asset.ADMIN_ROLES.atlanFieldName,
        )

    /**
     * Encodes (serializes) a role into a string form.
     *
     * @param role to be encoded
     * @return the string-encoded form for that role
     */
    fun encode(role: String): String {
        return role
    }

    /**
     * Decodes (deserializes) a string form into a validated role GUID.
     *
     * @param client connectivity to the Atlan tenant
     * @param roleRef the string form to be decoded
     * @param fieldName the name of the field containing the string-encoded value
     * @return the role GUID corresponding to the string
     */
    fun decode(
        client: AtlanClient,
        roleRef: String,
        fieldName: String,
    ): String {
        return when (fieldName) {
            in FIELDS -> {
                try {
                    // Try to look up the user reference by username
                    return client.roleCache.getIdForName(roleRef)
                } catch (e: NotFoundException) {
                    throw NoSuchElementException("Role name $roleRef is not known to Atlan (in $fieldName).", e)
                }
            }
            else -> roleRef
        }
    }
}