o

com.digitalasset.canton.participant.ledger.api

CantonLedgerApiServerWrapper

object CantonLedgerApiServerWrapper extends NoTracing

Wrapper of ledger API server to manage start, stop, and erasing of state.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CantonLedgerApiServerWrapper
  2. NoTracing
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Config(serverConfig: LedgerApiServerConfig, jsonApiConfig: Option[JsonApiConfig], indexerConfig: IndexerConfig, indexerHaConfig: HaConfig, ledgerId: LedgerId, participantId: LedgerParticipantId, engine: Engine, syncService: CantonSyncService, storageConfig: StorageConfig, cantonParameterConfig: ParticipantNodeParameters, testingTimeService: Option[TimeServiceBackend], adminToken: CantonAdminToken, loggerFactory: NamedLoggerFactory, tracerProvider: TracerProvider, metrics: Metrics, jsonApiMetrics: HttpApiMetrics, meteringReportKey: MeteringReportKey) extends NamedLogging with Product with Serializable

    Config for ledger API server and indexer

    Config for ledger API server and indexer

    serverConfig

    ledger API server configuration

    jsonApiConfig

    JSON API configuration

    indexerConfig

    indexer configuration

    ledgerId

    unique ledger id used by the ledger API server

    participantId

    unique participant id used e.g. for a unique ledger API server index db name

    engine

    daml engine shared with Canton for performance reasons

    syncService

    canton sync service implementing both read and write services

    storageConfig

    canton storage config so that indexer can share the participant db

    cantonParameterConfig

    configurations meant to be overridden primarily in tests (applying to all participants)

    testingTimeService

    an optional service during testing for advancing time, participant-specific

    adminToken

    canton admin token for ledger api auth

    loggerFactory

    canton logger factory

    tracerProvider

    tracer provider for open telemetry grpc injection

    metrics

    upstream metrics module

  2. final case class FailedToConfigureLedgerApiStorage(errorMessage: String) extends LedgerApiServerErrorWithoutCause with Product with Serializable
  3. final case class FailedToStartLedgerApiServer(cause: Throwable) extends LedgerApiServerError with Product with Serializable
  4. final case class FailedToStopLedgerApiServer(errorMessage: String, cause: Throwable) extends LedgerApiServerError with Product with Serializable
  5. final case class IndexerLockIds(mainLockId: Int, workerLockId: Int) extends Product with Serializable
  6. sealed trait LedgerApiServerError extends Product with Serializable with PrettyPrinting
  7. sealed trait LedgerApiServerErrorWithoutCause extends LedgerApiServerError
  8. final case class LedgerApiServerState(ledgerApiStorage: LedgerApiStorage, startableStoppableLedgerApi: StartableStoppableLedgerApiServer, logger: TracedLogger, timeouts: ProcessingTimeout) extends FlagCloseable with Product with Serializable
  9. final case class MigrateSchemaConfig(dbConfig: DbConfig, additionalMigrationPaths: Seq[String]) extends Product with Serializable

    Config for indexer migrate schema entry point

    Config for indexer migrate schema entry point

    dbConfig

    canton DB storage config so that indexer can share the participant db

    additionalMigrationPaths

    optional paths for extra migration files

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def initialize(config: Config, startLedgerApiServer: Boolean, futureSupervisor: FutureSupervisor, multiDomainEnabled: Boolean)(implicit ec: ExecutionContextIdlenessExecutorService, actorSystem: ActorSystem): EitherT[FutureUnlessShutdown, LedgerApiServerError, LedgerApiServerState]

    Initialize a ledger API server asynchronously

    Initialize a ledger API server asynchronously

    config

    ledger API server configuration

    startLedgerApiServer

    whether to start the ledger API server or not (i.e. when participant node is initialized in passive mode)

    returns

    ledger API server state wrapper EitherT-future

  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val maximumToleranceTimeModel: LedgerTimeModel
  13. def migrateSchema(config: MigrateSchemaConfig, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext): Future[Unit]

    Migrates ledger API server database schema to latest flyway version

  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. 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 NoTracing

Inherited from AnyRef

Inherited from Any

Ungrouped