final case class AdminTokenConfig(fixedAdminToken: Option[String] = None, adminTokenDuration: PositiveFiniteDuration = AdminTokenConfig.DefaultAdminTokenDuration, actAsAnyPartyClaim: Boolean = true, adminClaim: Boolean = true) extends UniformCantonConfigValidation with Product with Serializable
Configuration for admin-token based authorization.
The given token will be valid forever but it will not be used internally. Other admin-tokens will be generated and rotated periodically. The fixed token is only used for testing purposes and should not be used in production.
The admin-token based authorization will create tokens and rotate them periodically. Each admin-token is valid for the defined token duration. The half of this value is used as the rotation interval, after which a new admin-token is generated (if needed).
- Alphabetic
- By Inheritance
- AdminTokenConfig
- Serializable
- Product
- Equals
- UniformCantonConfigValidation
- CustomCantonConfigValidation
- CantonConfigValidation
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AdminTokenConfig(fixedAdminToken: Option[String] = None, adminTokenDuration: PositiveFiniteDuration = AdminTokenConfig.DefaultAdminTokenDuration, actAsAnyPartyClaim: Boolean = true, adminClaim: Boolean = true)
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 actAsAnyPartyClaim: Boolean
- val adminClaim: Boolean
- val adminTokenDuration: PositiveFiniteDuration
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]
Returns all validation errors that are specific to this Canton configuration class.
Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.
Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.
- Attributes
- protected
- Definition Classes
- UniformCantonConfigValidation → CustomCantonConfigValidation
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val fixedAdminToken: Option[String]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def merge(other: AdminTokenConfig): AdminTokenConfig
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def validate[T >: AdminTokenConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
- Definition Classes
- CantonConfigValidation
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])