com.couchbase.client.scala.manager.user.User.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scala-client_2.12 Show documentation
The official Couchbase Scala SDK
There is a newer version: 1.7.5
/*
 * Copyright (c) 2019 Couchbase, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.couchbase.client.scala.manager.user

import java.time.Instant

import com.couchbase.client.core.deps.com.fasterxml.jackson.annotation.JsonProperty
import com.couchbase.client.scala.util.CouchbasePickler
import upickle.default.{macroRW, ReadWriter => RW}

/** Models a Couchbase user.
  *
  * @param username    the user's username
  * @param displayName the user's display name
  * @param groups      any groups that the user belongs to
  * @param _roles       any roles directly assigned to the user (not those inherited through groups)
  */
case class User(
    username: String,
    displayName: String = "",
    groups: Seq[String] = Seq(),
    private val _roles: Seq[Role] = Seq(),
    private[scala] val password: Option[String] = None
) {

  /** Creates a copy of this User with the new username. */
  def username(username: String): User = {
    copy(username = username)
  }

  /** Creates a copy of this User with the new display name. */
  def displayName(displayName: String): User = {
    copy(displayName = displayName)
  }

  /** Creates a copy of this User with the new groups. */
  def groups(groups: String*): User = {
    copy(groups = groups)
  }

  /** Creates a copy of this User with the new roles. */
  def roles(newRoles: Role*): User = {
    copy(_roles = newRoles)
  }

  def roles: Seq[Role] = _roles

  /** Creates a copy of this User with the new password. */
  def password(password: String): User = {
    copy(password = Some(password))
  }
}

/** Associates a [[User]] with any derived properties, such as the effective roles inherited from groups.
  */
case class UserAndMetadata(
    @upickle.implicits.key("domain") domain: AuthDomain,
    @upickle.implicits.key("id") username: String,
    @upickle.implicits.key("name") displayName: String,
    @upickle.implicits.key("roles") private[scala] val _effectiveRoles: Seq[RoleAndOrigins],
    @upickle.implicits.key("password_change_date") _passwordChanged: Option[String] = None,
    @upickle.implicits.key("groups") groups: Seq[String] = Seq(),
    @upickle.implicits.key("external_groups") externalGroups: Seq[String] = Seq()
) {

  /** Returns the roles assigned specifically to the user. Excludes roles that are
    * only inherited from groups.
    */
  def innateRoles: Seq[Role] = {
    _effectiveRoles.filter(_.innate).map(_.role)
  }

  /** Returns all of the user's roles, including roles inherited from groups.
    */
  def effectiveRoles: Seq[RoleAndOrigins] = {
    _effectiveRoles
  }

  def passwordChanged: Option[Instant] = {
    _passwordChanged.map(v => Instant.parse(v))
  }

  def user: User = {
    User(username, displayName, groups, innateRoles)
  }
}

object UserAndMetadata {
  implicit val rw: CouchbasePickler.ReadWriter[UserAndMetadata] = CouchbasePickler.macroRW
}