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. case class Config(serverConfig: LedgerApiServerConfig, indexerConfig: IndexerConfig, indexerLockIds: Option[IndexerLockIds], ledgerId: LedgerId, participantId: LedgerParticipantId, engine: Engine, syncService: CantonSyncService, storageConfig: StorageConfig, cantonParameterConfig: ParticipantNodeParameters, testingTimeService: Option[TimeServiceBackend], adminToken: CantonAdminToken, loggerFactory: NamedLoggerFactory, tracerProvider: TracerProvider, metrics: Metrics) 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

    indexerConfig

    indexer configuration

    indexerLockIds

    Optional lock IDs to be used for indexer HA

    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. case class FailedToConfigureIndexer(errorMessage: String) extends LedgerApiServerErrorWithoutCause with Product with Serializable
  3. case class FailedToConfigureLedgerApiStorage(errorMessage: String) extends LedgerApiServerErrorWithoutCause with Product with Serializable
  4. case class FailedToStartLedgerApiServer(cause: Throwable) extends LedgerApiServerError with Product with Serializable
  5. case class FailedToStopIndexer(errorMessage: String, cause: Throwable) extends LedgerApiServerError with Product with Serializable
  6. case class FailedToStopLedgerApiServer(errorMessage: String, cause: Throwable) extends LedgerApiServerError with Product with Serializable
  7. case class IndexerLockIds(mainLockId: Int, workerLockId: Int) extends Product with Serializable
  8. type IndexerResource = Resource[ResourceContext, Unit]
  9. sealed trait LedgerApiServerError extends Product with Serializable with PrettyPrinting
  10. sealed trait LedgerApiServerErrorWithoutCause extends LedgerApiServerError
  11. type LedgerApiServerResource = Resource[ResourceContext, Unit]
  12. case class LedgerApiServerState(ledgerApiStorage: LedgerApiStorage, ledgerApiServer: LedgerApiServerResource, indexer: StartableStoppableIndexer, logger: TracedLogger, timeouts: ProcessingTimeout)(implicit ec: ExecutionContext) extends FlagCloseableAsync with Product with Serializable
  13. 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. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val maximumToleranceTimeModel: LedgerTimeModel
  12. def migrateSchema(config: MigrateSchemaConfig, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext): Future[Unit]

    Migrates ledger api server database schema to latest flyway version

  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def start(config: Config, startIndexer: Boolean)(implicit ec: ExecutionContextIdlenessExecutorService, actorSystem: ActorSystem): EitherT[Future, LedgerApiServerError, LedgerApiServerState]

    Start a ledger api server asynchronously

    Start a ledger api server asynchronously

    config

    ledger api server configuration

    startIndexer

    whether to start the indexer or merely wait until the index db schema has been created

    returns

    ledger api server state wrapper EitherT-future

  17. def stop(components: LedgerApiServerState)(implicit executionContext: ExecutionContext): EitherT[Future, LedgerApiServerError, Unit]
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. 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 NoTracing

Inherited from AnyRef

Inherited from Any

Ungrouped