final case class LedgerApiServerConfig(address: String = "127.0.0.1", internalPort: Option[Port] = None, tls: Option[TlsServerConfig] = None, authServices: Seq[AuthServiceConfig] = Seq.empty, adminToken: Option[String] = None, jwtTimestampLeeway: Option[JwtTimestampLeeway] = None, keepAliveServer: Option[LedgerApiKeepAliveServerConfig] = Some( LedgerApiKeepAliveServerConfig() ), maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize, rateLimit: Option[RateLimitingConfig] = Some(DefaultRateLimit), postgresDataSource: PostgresDataSourceConfig = PostgresDataSourceConfig(), databaseConnectionTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultDatabaseConnectionTimeout, indexService: IndexServiceConfig = LedgerIndexServiceConfig(), commandService: CommandServiceConfig = CommandServiceConfig(), userManagementService: UserManagementServiceConfig = UserManagementServiceConfig(), partyManagementService: PartyManagementServiceConfig = PartyManagementServiceConfig(), managementServiceTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultManagementServiceTimeout, enableCommandInspection: Boolean = true, identityProviderManagement: IdentityProviderManagementConfig = LedgerApiServerConfig.DefaultIdentityProviderManagementConfig, interactiveSubmissionService: InteractiveSubmissionServiceConfig = InteractiveSubmissionServiceConfig.Default, topologyAwarePackageSelection: TopologyAwarePackageSelectionConfig = TopologyAwarePackageSelectionConfig.Default) extends ServerConfig with Product with Serializable

Canton configuration case class to pass-through configuration options to the ledger api server

address

ledger api server host name.

internalPort

ledger api server port.

tls

tls configuration setting from ledger api server.

authServices

type of authentication services used by ledger-api server. If empty, we use a wildcard. Otherwise, the first service response that does not say "unauthenticated" will be used.

adminToken

token that should grant admin access when presented by a client on the ledger api

jwtTimestampLeeway

leeway parameters for JWTs

keepAliveServer

keep-alive configuration for ledger api requests

maxInboundMessageSize

maximum inbound message size on the ledger api

rateLimit

limit the ledger api server request rates based on system metrics

postgresDataSource

config for ledger api server when using postgres

databaseConnectionTimeout

database connection timeout

indexService

configurations pertaining to the ledger api server's internal "index service"

commandService

configurations pertaining to the ledger api server's "command service"

userManagementService

configurations pertaining to the ledger api server's "user management service"

partyManagementService

configurations pertaining to the ledger api server's "party management service"

managementServiceTimeout

ledger api server management service maximum duration. Duration has to be finite as the ledger api server uses java.time.duration that does not support infinite scala durations.

enableCommandInspection

enable command inspection service over the ledger api

identityProviderManagement

configurations pertaining to the ledger api server's "identity provider management service"

Linear Supertypes
ServerConfig, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LedgerApiServerConfig
  2. ServerConfig
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LedgerApiServerConfig(address: String = "127.0.0.1", internalPort: Option[Port] = None, tls: Option[TlsServerConfig] = None, authServices: Seq[AuthServiceConfig] = Seq.empty, adminToken: Option[String] = None, jwtTimestampLeeway: Option[JwtTimestampLeeway] = None, keepAliveServer: Option[LedgerApiKeepAliveServerConfig] = Some( LedgerApiKeepAliveServerConfig() ), maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize, rateLimit: Option[RateLimitingConfig] = Some(DefaultRateLimit), postgresDataSource: PostgresDataSourceConfig = PostgresDataSourceConfig(), databaseConnectionTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultDatabaseConnectionTimeout, indexService: IndexServiceConfig = LedgerIndexServiceConfig(), commandService: CommandServiceConfig = CommandServiceConfig(), userManagementService: UserManagementServiceConfig = UserManagementServiceConfig(), partyManagementService: PartyManagementServiceConfig = PartyManagementServiceConfig(), managementServiceTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultManagementServiceTimeout, enableCommandInspection: Boolean = true, identityProviderManagement: IdentityProviderManagementConfig = LedgerApiServerConfig.DefaultIdentityProviderManagementConfig, interactiveSubmissionService: InteractiveSubmissionServiceConfig = InteractiveSubmissionServiceConfig.Default, topologyAwarePackageSelection: TopologyAwarePackageSelectionConfig = TopologyAwarePackageSelectionConfig.Default)

    address

    ledger api server host name.

    internalPort

    ledger api server port.

    tls

    tls configuration setting from ledger api server.

    authServices

    type of authentication services used by ledger-api server. If empty, we use a wildcard. Otherwise, the first service response that does not say "unauthenticated" will be used.

    adminToken

    token that should grant admin access when presented by a client on the ledger api

    jwtTimestampLeeway

    leeway parameters for JWTs

    keepAliveServer

    keep-alive configuration for ledger api requests

    maxInboundMessageSize

    maximum inbound message size on the ledger api

    rateLimit

    limit the ledger api server request rates based on system metrics

    postgresDataSource

    config for ledger api server when using postgres

    databaseConnectionTimeout

    database connection timeout

    indexService

    configurations pertaining to the ledger api server's internal "index service"

    commandService

    configurations pertaining to the ledger api server's "command service"

    userManagementService

    configurations pertaining to the ledger api server's "user management service"

    partyManagementService

    configurations pertaining to the ledger api server's "party management service"

    managementServiceTimeout

    ledger api server management service maximum duration. Duration has to be finite as the ledger api server uses java.time.duration that does not support infinite scala durations.

    enableCommandInspection

    enable command inspection service over the ledger api

    identityProviderManagement

    configurations pertaining to the ledger api server's "identity provider management service"

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 address: String

    The address of the interface to be listening on

    The address of the interface to be listening on

    Definition Classes
    LedgerApiServerConfig → ServerConfig
  5. val adminToken: Option[String]

    If defined, the admin-token based authoriztion will be supported when accessing this node through the given address and port.

    If defined, the admin-token based authoriztion will be supported when accessing this node through the given address and port.

    Definition Classes
    LedgerApiServerConfig → ServerConfig
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val authServices: Seq[AuthServiceConfig]

    If any defined, enforces token based authorization when accessing this node through the given address and port.

    If any defined, enforces token based authorization when accessing this node through the given address and port.

    Definition Classes
    LedgerApiServerConfig → ServerConfig
  8. lazy val clientConfig: FullClientConfig
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  10. val commandService: CommandServiceConfig
  11. val databaseConnectionTimeout: NonNegativeFiniteDuration
  12. val enableCommandInspection: Boolean
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. val identityProviderManagement: IdentityProviderManagementConfig
  16. val indexService: IndexServiceConfig
  17. def instantiateServerInterceptors(tracingConfig: TracingConfig, apiLoggingConfig: ApiLoggingConfig, loggerFactory: NamedLoggerFactory, grpcMetrics: GrpcServerMetrics, authServices: Seq[AuthServiceConfig], adminToken: Option[CantonAdminToken], jwtTimestampLeeway: Option[JwtTimestampLeeway], telemetry: Telemetry): CantonServerInterceptors

    Use the configuration to instantiate the interceptors for this server

    Use the configuration to instantiate the interceptors for this server

    Definition Classes
    ServerConfig
  18. val interactiveSubmissionService: InteractiveSubmissionServiceConfig
  19. 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 port for usability reasons.

    Definition Classes
    LedgerApiServerConfig → ServerConfig
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. 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
    LedgerApiServerConfig → ServerConfig
  22. val keepAliveServer: Option[LedgerApiKeepAliveServerConfig]

    server keep alive settings

    server keep alive settings

    Definition Classes
    LedgerApiServerConfig → ServerConfig
  23. val managementServiceTimeout: NonNegativeFiniteDuration
  24. 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
    LedgerApiServerConfig → ServerConfig
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  28. val partyManagementService: PartyManagementServiceConfig
  29. 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 port and internalPort to offer a clean API to users of the config in the form of port, 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
  30. val postgresDataSource: PostgresDataSourceConfig
  31. def productElementNames: Iterator[String]
    Definition Classes
    Product
  32. val rateLimit: Option[RateLimitingConfig]
  33. 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
    LedgerApiServerConfig → ServerConfig
  34. def sslContext: Option[SslContext]

    If defined, dictates to use TLS when connecting to this node through the given address and port.

    If defined, dictates to use TLS when connecting to this node through the given address and port. Server authentication is always enabled. Subclasses may decide whether to support client authentication.

    Definition Classes
    LedgerApiServerConfig → ServerConfig
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. val tls: Option[TlsServerConfig]
  37. val topologyAwarePackageSelection: TopologyAwarePackageSelectionConfig
  38. val userManagementService: UserManagementServiceConfig
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from ServerConfig

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped