final case class AdminServerConfig(address: String = defaultAddress, internalPort: Option[Port] = None, tls: Option[TlsServerConfig] = None, jwtTimestampLeeway: Option[JwtTimestampLeeway] = None, keepAliveServer: Option[BasicKeepAliveServerConfig] = Some( BasicKeepAliveServerConfig() ), maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize, authServices: Seq[AuthServiceConfig] = Seq.empty, adminTokenConfig: AdminTokenConfig = AdminTokenConfig(), maxTokenLifetime: NonNegativeDuration = NonNegativeDuration(Duration.Inf), jwksCacheConfig: JwksCacheConfig = JwksCacheConfig()) extends ServerConfig with UniformCantonConfigValidation with Product with Serializable
A variant of ServerConfig that by default listens to connections only on the loopback interface.
- Alphabetic
- By Inheritance
- AdminServerConfig
- UniformCantonConfigValidation
- CustomCantonConfigValidation
- CantonConfigValidation
- ServerConfig
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AdminServerConfig(address: String = defaultAddress, internalPort: Option[Port] = None, tls: Option[TlsServerConfig] = None, jwtTimestampLeeway: Option[JwtTimestampLeeway] = None, keepAliveServer: Option[BasicKeepAliveServerConfig] = Some( BasicKeepAliveServerConfig() ), maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize, authServices: Seq[AuthServiceConfig] = Seq.empty, adminTokenConfig: AdminTokenConfig = AdminTokenConfig(), maxTokenLifetime: NonNegativeDuration = NonNegativeDuration(Duration.Inf), jwksCacheConfig: JwksCacheConfig = JwksCacheConfig())
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 address: String
The address of the interface to be listening on
The address of the interface to be listening on
- Definition Classes
- AdminServerConfig → ServerConfig
- val adminTokenConfig: AdminTokenConfig
The configuration of the admin-token based authorization that will be supported when accessing this node through the given
addressandport.The configuration of the admin-token based authorization that will be supported when accessing this node through the given
addressandport.- Definition Classes
- AdminServerConfig → ServerConfig
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val authServices: Seq[AuthServiceConfig]
If any defined, enforces token based authorization when accessing this node through the given
addressandport.If any defined, enforces token based authorization when accessing this node through the given
addressandport.- Definition Classes
- AdminServerConfig → ServerConfig
- def clientConfig: FullClientConfig
- 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def instantiateServerInterceptors(tracingConfig: TracingConfig, apiLoggingConfig: ApiLoggingConfig, loggerFactory: NamedLoggerFactory, grpcMetrics: GrpcServerMetrics, authServices: Seq[AuthServiceConfig], adminTokenDispenser: Option[CantonAdminTokenDispenser], jwtTimestampLeeway: Option[JwtTimestampLeeway], adminTokenConfig: AdminTokenConfig, jwksCacheConfig: JwksCacheConfig, telemetry: Telemetry, additionalInterceptors: Seq[ServerInterceptor] = Seq.empty): CantonServerInterceptors
Use the configuration to instantiate the interceptors for this server
Use the configuration to instantiate the interceptors for this server
- Definition Classes
- ServerConfig
- val internalPort: Option[Port]
Port to be listening on (must be greater than 0).
Port to be listening on (must be greater than 0). If the port is None, a default port will be assigned on startup.
NOTE: If you rename this field, adapt the corresponding product hint for config reading. In the configuration the field is still called
portfor usability reasons.- Definition Classes
- AdminServerConfig → ServerConfig
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val jwksCacheConfig: JwksCacheConfig
settings for the jwks cache
settings for the jwks cache
- Definition Classes
- AdminServerConfig → ServerConfig
- val jwtTimestampLeeway: Option[JwtTimestampLeeway]
Leeway parameters for the jwt processing algorithms used in the authorization services
Leeway parameters for the jwt processing algorithms used in the authorization services
- Definition Classes
- AdminServerConfig → ServerConfig
- val keepAliveServer: Option[BasicKeepAliveServerConfig]
server keep alive settings
server keep alive settings
- Definition Classes
- AdminServerConfig → ServerConfig
- val maxInboundMessageSize: NonNegativeInt
maximum inbound message size in bytes on the ledger api and the admin api
maximum inbound message size in bytes on the ledger api and the admin api
- Definition Classes
- AdminServerConfig → ServerConfig
- val maxTokenLifetime: NonNegativeDuration
maximum expiration time accepted for tokens
maximum expiration time accepted for tokens
- Definition Classes
- AdminServerConfig → ServerConfig
- 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 port: Port
Returns the configured or the default port that must be assigned after config loading and before config usage.
Returns the configured or the default port that must be assigned after config loading and before config usage.
We split between
portandinternalPortto offer a clean API to users of the config in the form ofport, which must always return a configured or default port, and the internal representation that may be None before being assigned a default port.- Definition Classes
- ServerConfig
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serverCertChainFile: Option[PemFileOrString]
server cert chain file if TLS is defined
server cert chain file if TLS is defined
Used for synchronizer internal GRPC sequencer connections
- Definition Classes
- AdminServerConfig → ServerConfig
- def sslContext: Option[SslContext]
If defined, dictates to use TLS when connecting to this node through the given
addressandport.If defined, dictates to use TLS when connecting to this node through the given
addressandport. Server authentication is always enabled. Subclasses may decide whether to support client authentication.- Definition Classes
- AdminServerConfig → ServerConfig
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val tls: Option[TlsServerConfig]
- final def validate[T >: AdminServerConfig.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])