final case class LedgerApiServerConfig(address: String = "127.0.0.1", internalPort: Option[Port] = None, indexService: IndexServiceConfig = LedgerIndexServiceConfig(), tls: Option[TlsServerConfig] = None, configurationLoadTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultConfigurationLoadTimeout, commandService: CommandServiceConfig = CommandServiceConfig(), userManagementService: UserManagementServiceConfig = UserManagementServiceConfig(), managementServiceTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultManagementServiceTimeout, postgresDataSource: PostgresDataSourceConfig = PostgresDataSourceConfig(), authServices: Seq[AuthServiceConfig] = Seq.empty, keepAliveServer: Option[KeepAliveServerConfig] = Some(KeepAliveServerConfig()), maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize, databaseConnectionTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultDatabaseConnectionTimeout, apiStreamShutdownTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultApiStreamShutdownTimeout, additionalMigrationPaths: Seq[String] = Seq.empty, rateLimit: Option[RateLimitingConfig] = Some(DefaultRateLimit), enableExplicitDisclosure: Boolean = true, adminToken: Option[String] = None, identityProviderManagement: IdentityProviderManagementConfig = LedgerApiServerConfig.DefaultIdentityProviderManagementConfig, unsafeEnableEventsByContractKeyCache: EnableEventsByContractKeyCache = EnableEventsByContractKeyCache.Disabled) 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.

tls

tls configuration setting from ledger api server.

configurationLoadTimeout

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

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.

postgresDataSource

config for ledger api server when using postgres

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.

keepAliveServer

keep-alive configuration for ledger api requests

maxInboundMessageSize

maximum inbound message size on the ledger api

databaseConnectionTimeout

database connection timeout

additionalMigrationPaths

optional extra paths for the database migrations

rateLimit

limit the ledger api server request rates based on system metrics

enableExplicitDisclosure

enable usage of explicitly disclosed contracts in command submission and transaction validation.

Linear Supertypes
CommunityServerConfig, ServerConfig, Serializable, Product, Equals, AnyRef, Any
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, indexService: IndexServiceConfig = LedgerIndexServiceConfig(), tls: Option[TlsServerConfig] = None, configurationLoadTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultConfigurationLoadTimeout, commandService: CommandServiceConfig = CommandServiceConfig(), userManagementService: UserManagementServiceConfig = UserManagementServiceConfig(), managementServiceTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultManagementServiceTimeout, postgresDataSource: PostgresDataSourceConfig = PostgresDataSourceConfig(), authServices: Seq[AuthServiceConfig] = Seq.empty, keepAliveServer: Option[KeepAliveServerConfig] = Some(KeepAliveServerConfig()), maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize, databaseConnectionTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultDatabaseConnectionTimeout, apiStreamShutdownTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultApiStreamShutdownTimeout, additionalMigrationPaths: Seq[String] = Seq.empty, rateLimit: Option[RateLimitingConfig] = Some(DefaultRateLimit), enableExplicitDisclosure: Boolean = true, adminToken: Option[String] = None, identityProviderManagement: IdentityProviderManagementConfig = LedgerApiServerConfig.DefaultIdentityProviderManagementConfig, unsafeEnableEventsByContractKeyCache: EnableEventsByContractKeyCache = EnableEventsByContractKeyCache.Disabled)

    address

    ledger api server host name.

    internalPort

    ledger api server port.

    tls

    tls configuration setting from ledger api server.

    configurationLoadTimeout

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

    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.

    postgresDataSource

    config for ledger api server when using postgres

    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.

    keepAliveServer

    keep-alive configuration for ledger api requests

    maxInboundMessageSize

    maximum inbound message size on the ledger api

    databaseConnectionTimeout

    database connection timeout

    additionalMigrationPaths

    optional extra paths for the database migrations

    rateLimit

    limit the ledger api server request rates based on system metrics

    enableExplicitDisclosure

    enable usage of explicitly disclosed contracts in command submission and transaction validation.

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 additionalMigrationPaths: Seq[String]
  5. 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
  6. val adminToken: Option[String]
  7. val apiStreamShutdownTimeout: NonNegativeFiniteDuration
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val authServices: Seq[AuthServiceConfig]
  10. lazy val clientConfig: ClientConfig
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  12. val commandService: CommandServiceConfig
  13. val configurationLoadTimeout: NonNegativeFiniteDuration
  14. val databaseConnectionTimeout: NonNegativeFiniteDuration
  15. val enableExplicitDisclosure: Boolean
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. val identityProviderManagement: IdentityProviderManagementConfig
  19. val indexService: IndexServiceConfig
  20. def instantiateServerInterceptors(tracingConfig: TracingConfig, apiLoggingConfig: ApiLoggingConfig, metricsPrefix: MetricName, metrics: MetricsFactory, loggerFactory: NamedLoggerFactory, grpcMetrics: GrpcServerMetrics): CantonServerInterceptors

    Use the configuration to instantiate the interceptors for this server

    Use the configuration to instantiate the interceptors for this server

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

    server keep alive settings

    server keep alive settings

    Definition Classes
    LedgerApiServerConfig → ServerConfig
  24. val managementServiceTimeout: NonNegativeFiniteDuration
  25. 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
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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[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
    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. def toSequencerConnectionConfig: Grpc
    Definition Classes
    ServerConfig
  38. val unsafeEnableEventsByContractKeyCache: EnableEventsByContractKeyCache
  39. val userManagementService: UserManagementServiceConfig
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. 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
    Deprecated

Inherited from CommunityServerConfig

Inherited from ServerConfig

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped