Packages

c

nl.knaw.dans.lib.dataverse

BuiltinUserApi

class BuiltinUserApi extends HttpSupport with DebugEnhancedLogging

Functions to manage builtin user accounts. Note that the https://guides.dataverse.org/en/5.2/installation/config.html#builtinusers-key must be set and configured in DataverseInstanceConfig for this to work.

Linear Supertypes
HttpSupport, DebugEnhancedLogging, LazyLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BuiltinUserApi
  2. HttpSupport
  3. DebugEnhancedLogging
  4. LazyLogging
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val apiPrefix: String
    Attributes
    protected
    Definition Classes
    BuiltinUserApi → HttpSupport
  5. val apiToken: Option[String]
    Attributes
    protected
    Definition Classes
    BuiltinUserApi → HttpSupport
  6. val apiVersion: Option[String]
    Attributes
    protected
    Definition Classes
    BuiltinUserApi → HttpSupport
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val baseUrl: URI
    Attributes
    protected
    Definition Classes
    BuiltinUserApi → HttpSupport
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. val connectionTimeout: Int
    Attributes
    protected
    Definition Classes
    BuiltinUserApi → HttpSupport
  11. def create(user: BuiltinUser, password: String, builtInUsersKey: String): Try[DataverseResponse[Any]]

    user

    the user account info

    password

    the password to set for the new user

    builtInUsersKey

    the key that allows you to create built-in users via the API

    See also

    https://guides.dataverse.org/en/5.2/api/native-api.html#create-a-builtin-user

  12. def debug(msg: String)(implicit enclosing: Name): Unit
    Definition Classes
    DebugEnhancedLogging
  13. def deletePath[D](subPath: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def get[D](subPath: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getUnwrapped(subPath: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty): Try[HttpResponse[Array[Byte]]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. lazy val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
    Annotations
    @transient()
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def postFile[D](subPath: String, optFile: Option[File], optJsonMetadata: Option[String] = Option.empty, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Posts a multi-part message with an optional file and optional JSON metadata part.

    Posts a multi-part message with an optional file and optional JSON metadata part. Probably at least one is required, but since this is an internal function, this is not validated.

    D

    the payload type for the DataverseResponse

    subPath

    subpath to post to

    optFile

    the optional file

    optJsonMetadata

    the optional metadata

    headers

    extra headers

    params

    extra query parameters

    returns

    a DataverseResponse

    Attributes
    protected
    Definition Classes
    HttpSupport
  27. def postJson[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty, isJsonLd: Boolean = false)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  28. def postText[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  29. def put[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  30. def putJson[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty, isJsonLd: Boolean = false)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  31. val readTimeout: Int
    Attributes
    protected
    Definition Classes
    BuiltinUserApi → HttpSupport
  32. val sendApiTokenViaBasicAuth: Boolean
    Attributes
    protected
    Definition Classes
    BuiltinUserApi → HttpSupport
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. def trace[V](value: Text[V])(implicit enclosing: Name): Unit
    Definition Classes
    DebugEnhancedLogging
  36. val unblockKey: Option[String]
    Attributes
    protected
    Definition Classes
    BuiltinUserApi → HttpSupport
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from HttpSupport

Inherited from DebugEnhancedLogging

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped