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.
- Alphabetic
- By Inheritance
- BuiltinUserApi
- HttpSupport
- DebugEnhancedLogging
- LazyLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
apiPrefix: String
- Attributes
- protected
- Definition Classes
- BuiltinUserApi → HttpSupport
-
val
apiToken: Option[String]
- Attributes
- protected
- Definition Classes
- BuiltinUserApi → HttpSupport
-
val
apiVersion: Option[String]
- Attributes
- protected
- Definition Classes
- BuiltinUserApi → HttpSupport
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
baseUrl: URI
- Attributes
- protected
- Definition Classes
- BuiltinUserApi → HttpSupport
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
val
connectionTimeout: Int
- Attributes
- protected
- Definition Classes
- BuiltinUserApi → HttpSupport
-
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
-
def
debug(msg: String)(implicit enclosing: Name): Unit
- Definition Classes
- DebugEnhancedLogging
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
lazy val
logger: Logger
- Attributes
- protected
- Definition Classes
- LazyLogging
- Annotations
- @transient()
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
-
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
-
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
-
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
-
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
-
val
readTimeout: Int
- Attributes
- protected
- Definition Classes
- BuiltinUserApi → HttpSupport
-
val
sendApiTokenViaBasicAuth: Boolean
- Attributes
- protected
- Definition Classes
- BuiltinUserApi → HttpSupport
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
trace[V](value: Text[V])(implicit enclosing: Name): Unit
- Definition Classes
- DebugEnhancedLogging
-
val
unblockKey: Option[String]
- Attributes
- protected
- Definition Classes
- BuiltinUserApi → HttpSupport
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()