case class LedgerApiServerConfig(address: String = "127.0.0.1", internalPort: Option[Port] = None, maxEventCacheWeight: Long = 0L, maxContractCacheWeight: Long = 0L, maxDeduplicationDuration: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofDays(7L), tls: Option[TlsServerConfig] = None, configurationLoadTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultConfigurationLoadTimeout, eventsPageSize: Int = LedgerApiServerConfig.DefaultEventsPageSize, eventsProcessingParallelism: Int = LedgerApiServerConfig.DefaultEventsProcessingParallelism, activeContractsService: ActiveContractsServiceConfig = ActiveContractsServiceConfig(), commandService: CommandServiceConfig = CommandServiceConfig(), userManagementService: UserManagementServiceConfig = UserManagementServiceConfig(), managementServiceTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultManagementServiceTimeout, synchronousCommitMode: String = LedgerApiServerConfig.DefaultSynchronousCommitMode, authServices: Seq[AuthServiceConfig] = Seq.empty, keepAliveServer: Option[KeepAliveServerConfig] = Some(KeepAliveServerConfig()), maxContractStateCacheSize: Long = LedgerApiServerConfig.DefaultMaxContractStateCacheSize, maxContractKeyStateCacheSize: Long = LedgerApiServerConfig.DefaultMaxContractKeyStateCacheSize, maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize, databaseConnectionTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultDatabaseConnectionTimeout, maxTransactionsInMemoryFanOutBufferSize: Long = LedgerApiServerConfig.DefaultMaxTransactionsInMemoryFanOutBufferSize, enableInMemoryFanOutForLedgerApi: Boolean = false, additionalMigrationPaths: Seq[String] = Seq.empty) extends CommunityServerConfig 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.

maxEventCacheWeight

ledger api server event cache maximum weight (caffeine cache size)

maxContractCacheWeight

ledger api server contract cache maximum weight (caffeine cache size)

maxDeduplicationDuration

Max deduplication duration of the participant's ledger configuration.

tls

tls configuration setting from ledger api server.

configurationLoadTimeout

ledger api server startup delay if no timemodel has been sent by canton via ReadService

eventsPageSize

database / akka page size for batching of ledger api server index ledger events queries.

eventsProcessingParallelism

parallelism for loading and decoding ledger events

activeContractsService

configurations pertaining to the ledger api server's "active contracts service"

commandService

configurations pertaining to the ledger api server's "command 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.

synchronousCommitMode

Postgres-specific indexer synchronous commit mode (defaults to "local")

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.

maxContractStateCacheSize

maximum caffeine cache size of mutable state cache of contracts

maxContractKeyStateCacheSize

maximum caffeine cache size of mutable state cache of contract keys

maxInboundMessageSize

maximum inbound message size

databaseConnectionTimeout

database connection timeout

maxTransactionsInMemoryFanOutBufferSize

maximum number of transactions to hold in the "in-memory fanout" (if enabled)

enableInMemoryFanOutForLedgerApi

enable the "in-memory fanout" performance optimization (default false; not tested for production yet)

additionalMigrationPaths

Optional extra paths for the database migrations

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LedgerApiServerConfig
  2. CommunityServerConfig
  3. ServerConfig
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. 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, maxEventCacheWeight: Long = 0L, maxContractCacheWeight: Long = 0L, maxDeduplicationDuration: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofDays(7L), tls: Option[TlsServerConfig] = None, configurationLoadTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultConfigurationLoadTimeout, eventsPageSize: Int = LedgerApiServerConfig.DefaultEventsPageSize, eventsProcessingParallelism: Int = LedgerApiServerConfig.DefaultEventsProcessingParallelism, activeContractsService: ActiveContractsServiceConfig = ActiveContractsServiceConfig(), commandService: CommandServiceConfig = CommandServiceConfig(), userManagementService: UserManagementServiceConfig = UserManagementServiceConfig(), managementServiceTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultManagementServiceTimeout, synchronousCommitMode: String = LedgerApiServerConfig.DefaultSynchronousCommitMode, authServices: Seq[AuthServiceConfig] = Seq.empty, keepAliveServer: Option[KeepAliveServerConfig] = Some(KeepAliveServerConfig()), maxContractStateCacheSize: Long = LedgerApiServerConfig.DefaultMaxContractStateCacheSize, maxContractKeyStateCacheSize: Long = LedgerApiServerConfig.DefaultMaxContractKeyStateCacheSize, maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize, databaseConnectionTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultDatabaseConnectionTimeout, maxTransactionsInMemoryFanOutBufferSize: Long = LedgerApiServerConfig.DefaultMaxTransactionsInMemoryFanOutBufferSize, enableInMemoryFanOutForLedgerApi: Boolean = false, additionalMigrationPaths: Seq[String] = Seq.empty)

    address

    ledger api server host name.

    internalPort

    ledger api server port.

    maxEventCacheWeight

    ledger api server event cache maximum weight (caffeine cache size)

    maxContractCacheWeight

    ledger api server contract cache maximum weight (caffeine cache size)

    maxDeduplicationDuration

    Max deduplication duration of the participant's ledger configuration.

    tls

    tls configuration setting from ledger api server.

    configurationLoadTimeout

    ledger api server startup delay if no timemodel has been sent by canton via ReadService

    eventsPageSize

    database / akka page size for batching of ledger api server index ledger events queries.

    eventsProcessingParallelism

    parallelism for loading and decoding ledger events

    activeContractsService

    configurations pertaining to the ledger api server's "active contracts service"

    commandService

    configurations pertaining to the ledger api server's "command 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.

    synchronousCommitMode

    Postgres-specific indexer synchronous commit mode (defaults to "local")

    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.

    maxContractStateCacheSize

    maximum caffeine cache size of mutable state cache of contracts

    maxContractKeyStateCacheSize

    maximum caffeine cache size of mutable state cache of contract keys

    maxInboundMessageSize

    maximum inbound message size

    databaseConnectionTimeout

    database connection timeout

    maxTransactionsInMemoryFanOutBufferSize

    maximum number of transactions to hold in the "in-memory fanout" (if enabled)

    enableInMemoryFanOutForLedgerApi

    enable the "in-memory fanout" performance optimization (default false; not tested for production yet)

    additionalMigrationPaths

    Optional extra paths for the database migrations

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 activeContractsService: ActiveContractsServiceConfig
  5. val additionalMigrationPaths: Seq[String]
  6. val address: String

    The address of the interface to be listening on

    The address of the interface to be listening on

    Definition Classes
    LedgerApiServerConfigServerConfig
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val authServices: Seq[AuthServiceConfig]
  9. lazy val clientConfig: ClientConfig
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. val commandService: CommandServiceConfig
  12. val configurationLoadTimeout: NonNegativeFiniteDuration
  13. val databaseConnectionTimeout: NonNegativeFiniteDuration
  14. val enableInMemoryFanOutForLedgerApi: Boolean
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. val eventsPageSize: Int
  17. val eventsProcessingParallelism: Int
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def instantiateServerInterceptors(tracingConfig: TracingConfig, apiLoggingConfig: ApiLoggingConfig, metrics: Factory, loggerFactory: NamedLoggerFactory): CantonCommunityServerInterceptors

    Use the configuration to instantiate the interceptors for this server

    Use the configuration to instantiate the interceptors for this server

    Definition Classes
    CommunityServerConfigServerConfig
  20. 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.

    Definition Classes
    LedgerApiServerConfigServerConfig
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val keepAliveServer: Option[KeepAliveServerConfig]

    server keep alive settings

    server keep alive settings

    Definition Classes
    LedgerApiServerConfigServerConfig
  23. val managementServiceTimeout: NonNegativeFiniteDuration
  24. val maxContractCacheWeight: Long
  25. val maxContractKeyStateCacheSize: Long
  26. val maxContractStateCacheSize: Long
  27. val maxDeduplicationDuration: NonNegativeFiniteDuration
  28. val maxEventCacheWeight: Long
  29. val maxInboundMessageSize: NonNegativeInt

    maximum inbound message size in bytes

    maximum inbound message size in bytes

    Definition Classes
    LedgerApiServerConfigServerConfig
  30. val maxTransactionsInMemoryFanOutBufferSize: Long
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. lazy val 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

    Definition Classes
    ServerConfig
  35. def productElementNames: Iterator[String]
    Definition Classes
    Product
  36. def serverCertChainFile: Option[ExistingFile]

    server cert chain file if TLS is defined

    server cert chain file if TLS is defined

    Used for domain internal GRPC sequencer connections

    Definition Classes
    LedgerApiServerConfigServerConfig
  37. 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
    LedgerApiServerConfigServerConfig
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. val synchronousCommitMode: String
  40. val tls: Option[TlsServerConfig]
  41. def toSequencerConnectionConfig: Grpc
    Definition Classes
    ServerConfig
  42. val userManagementService: UserManagementServiceConfig
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. 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

Inherited from CommunityServerConfig

Inherited from ServerConfig

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped