package api

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. case class CantonAdminToken extends NoCopy with Product with Serializable
  2. class CantonAdminTokenAuthService extends AuthService

    AuthService interceptor used for internal canton services

    AuthService interceptor used for internal canton services

    Internal Canton services such as the PingService or the DarService require access to the Ledger-Api server. However, if the Ledger-Api server is configured with JWT, they will fail. But we can't expect that Canton obtains an oauth token from a third party service during startup.

    Therefore, we create on each startup a master token which is only ever shared internally.

  3. class CantonExternalClockBackend extends TimeServiceBackend with NamedLogging with NoTracing

    Time service backend for testing only to enable the ledger api server to work with the Canton sim-clock or remote clock

  4. class CantonTimeServiceBackend extends TimeServiceBackend with NamedLogging with NoTracing

    Optional time services backend for demos and testing only to enable an "advanceable clock" based on the environment's sim-clocks.

    Optional time services backend for demos and testing only to enable an "advanceable clock" based on the environment's sim-clocks. Canton only supports advancing time, not going backwards in time.

  5. class LedgerApiDependentCantonServices extends AutoCloseable

    Holds all Canton services that use the Ledger Api and hence depend on the ledger api server to be up.

    Holds all Canton services that use the Ledger Api and hence depend on the ledger api server to be up. Used to close and restart those services when then ledger api server needs to be taken down temporarily, e.g. for ledger pruning.

  6. sealed trait LedgerApiJdbcUrl extends AnyRef
  7. class LedgerApiStorage extends AnyRef

    Configuration and actions for the ledger-api persistence, Actions are synchronous as they use the underlying jdbc driver directly and there is no simple version of async calls available.

    Configuration and actions for the ledger-api persistence, Actions are synchronous as they use the underlying jdbc driver directly and there is no simple version of async calls available. Given these are only used for one off rare actions this is currently sufficient. Just be aware these operations will block.

  8. class StartableStoppableIndexer extends FlagCloseableAsync with NamedLogging

    The StartableStoppableIndexer enables a canton participant node to start and stop the ledger api server's indexers independently from the ledger api grpc server depending on whether the participant node is a High Availability active or passive replica.

Value Members

  1. object CantonAdminToken extends Serializable
  2. object CantonLedgerApiServerWrapper extends NoTracing

    Wrapper of Ledger Api Server to manage start, stop, and erasing of state.

  3. object JwtTokenUtilities

    some helpers in other to use with ad-hoc JWT authentication

  4. object LedgerApiJdbcUrl

    Canton's storage is configured using Slick's configuration.

    Canton's storage is configured using Slick's configuration. This offers an expansive set of options allowing you to configure a connection pool, data source, or JDBC driver. The ledger-api configuration however only takes a JDBC url. LedgerApiJdbcUrl generator attempts to scrape together enough from Slick's configuration to generate a jdbc url for the targeted database (currently either H2 or Postgres). It also adds a schema specification to point the ledger-api server at a distinct schema from canton allowing it to be managed separately. Although it is expected a JDBC url will be generated for almost all circumstances, if this process fails or an advanced configuration is required the config.DbConfig.ledgerApiJdbcUrl configuration can be explicitly set and this will be used instead. This manually configured url **must** specify using the schema of ledger_api.

  5. object LedgerApiStorage

Ungrouped