t

com.digitalasset.canton.topology.client

TopologySnapshotLoader

trait TopologySnapshotLoader extends TopologySnapshot with PartyTopologySnapshotLoader with BaseTopologySnapshotClient with ParticipantTopologySnapshotLoader with KeyTopologySnapshotClientLoader with VettedPackagesSnapshotLoader with DomainGovernanceSnapshotLoader with NamedLogging

Loading interface with a more optimal method to read data from a store

The topology information is stored in a particular way. In order to optimise loading and caching of the data, we use such loader interfaces, such that we can optimise caching and loading of the data while still providing a good and convenient access to the topology information.

Linear Supertypes
NamedLogging, DomainGovernanceSnapshotLoader, VettedPackagesSnapshotLoader, KeyTopologySnapshotClientLoader, ParticipantTopologySnapshotLoader, PartyTopologySnapshotLoader, PartyTopologySnapshotBaseClient, TopologySnapshot, DomainGovernanceSnapshotClient, MediatorDomainStateClient, VettedPackagesSnapshotClient, CertificateSnapshotClient, KeyTopologySnapshotClient, ParticipantTopologySnapshotClient, BaseTopologySnapshotClient, PartyTopologySnapshotClient, AnyRef, Any
Known Subclasses
CachingTopologySnapshot, StoreBasedTopologySnapshot
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopologySnapshotLoader
  2. NamedLogging
  3. DomainGovernanceSnapshotLoader
  4. VettedPackagesSnapshotLoader
  5. KeyTopologySnapshotClientLoader
  6. ParticipantTopologySnapshotLoader
  7. PartyTopologySnapshotLoader
  8. PartyTopologySnapshotBaseClient
  9. TopologySnapshot
  10. DomainGovernanceSnapshotClient
  11. MediatorDomainStateClient
  12. VettedPackagesSnapshotClient
  13. CertificateSnapshotClient
  14. KeyTopologySnapshotClient
  15. ParticipantTopologySnapshotClient
  16. BaseTopologySnapshotClient
  17. PartyTopologySnapshotClient
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def allKeys(owner: KeyOwner): Future[KeyCollection]

    abstract loading function used to obtain the full key collection for a key owner

    abstract loading function used to obtain the full key collection for a key owner

    Definition Classes
    KeyTopologySnapshotClientLoader
  2. implicit abstract def executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    BaseTopologySnapshotClient
  3. abstract def findDynamicDomainParameters(implicit traceContext: TraceContext): Future[Option[DynamicDomainParameters]]
    Definition Classes
    DomainGovernanceSnapshotLoader
  4. abstract def findParticipantCertificate(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[Option[X509Cert]]
    Definition Classes
    CertificateSnapshotClient
  5. abstract def findParticipantState(participantId: ParticipantId): Future[Option[ParticipantAttributes]]
    Definition Classes
    ParticipantTopologySnapshotLoader
  6. abstract def inspectKeys(filterOwner: String, filterOwnerType: Option[KeyOwnerCode], limit: Int): Future[Map[KeyOwner, KeyCollection]]

    Returns a list of all known parties on this domain

    Returns a list of all known parties on this domain

    Definition Classes
    KeyTopologySnapshotClient
  7. abstract def inspectKnownParties(filterParty: String, filterParticipant: String, limit: Int): Future[Set[PartyId]]

    Returns a list of all known parties on this domain

    Returns a list of all known parties on this domain

    Definition Classes
    PartyTopologySnapshotClient
  8. abstract def listDynamicDomainParametersChanges()(implicit traceContext: TraceContext): Future[Seq[WithValidity]]

    List all the dynamic domain parameters (past and current)

    List all the dynamic domain parameters (past and current)

    Definition Classes
    DomainGovernanceSnapshotClient
  9. abstract def loadParticipantStates(participants: Seq[ParticipantId]): Future[Map[ParticipantId, ParticipantAttributes]]

    abstract loading function used to load the participant state for the given set of participant-ids

    abstract loading function used to load the participant state for the given set of participant-ids

    Definition Classes
    ParticipantTopologySnapshotLoader
  10. abstract def loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    NamedLogging
  11. abstract def mediators(): Future[Seq[MediatorId]]

    returns the list of currently known mediators

    returns the list of currently known mediators

    Definition Classes
    MediatorDomainStateClient
  12. abstract def participants(): Future[Seq[(ParticipantId, ParticipantPermission)]]
    Definition Classes
    ParticipantTopologySnapshotClient
    Annotations
    @Deprecated
  13. abstract def timestamp: CantonTimestamp

    The official timestamp corresponding to this snapshot

    The official timestamp corresponding to this snapshot

    Definition Classes
    BaseTopologySnapshotClient

Concrete 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 activeParticipantsOf(party: LfPartyId): Future[Map[ParticipantId, ParticipantAttributes]]

    Returns the set of active participants the given party is represented by as of the snapshot timestamp

    Returns the set of active participants the given party is represented by as of the snapshot timestamp

    Should never return a PartyParticipantRelationship where ParticipantPermission is DISABLED.

    Definition Classes
    PartyTopologySnapshotLoader → PartyTopologySnapshotClient
  5. def activeParticipantsOfAll(parties: List[LfPartyId]): EitherT[Future, Set[LfPartyId], Set[ParticipantId]]
    Definition Classes
    PartyTopologySnapshotBaseClient
  6. final def activeParticipantsOfParties(parties: Seq[LfPartyId]): Future[Map[LfPartyId, Set[ParticipantId]]]

    Load the set of active participants for the given parties

    Load the set of active participants for the given parties

    Definition Classes
    PartyTopologySnapshotLoader → PartyTopologySnapshotClient
  7. def allHaveActiveParticipants(parties: Set[LfPartyId], check: (ParticipantPermission) => Boolean = _.isActive): EitherT[Future, Set[LfPartyId], Unit]
    Definition Classes
    PartyTopologySnapshotBaseClient
  8. def allHostedOn(partyIds: Set[LfPartyId], participantId: ParticipantId, permissionCheck: (ParticipantAttributes) => Boolean = _.permission.isActive): Future[Boolean]
    Definition Classes
    PartyTopologySnapshotBaseClient
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def canConfirm(participant: ParticipantId, party: LfPartyId, requiredTrustLevel: TrustLevel = TrustLevel.Ordinary): Future[Boolean]
    Definition Classes
    PartyTopologySnapshotBaseClient
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  12. def encryptionKey(owner: KeyOwner): Future[Option[EncryptionPublicKey]]

    returns newest encryption public key

    returns newest encryption public key

    Definition Classes
    KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
  13. def encryptionKeys(owner: KeyOwner): Future[Seq[EncryptionPublicKey]]

    returns all signing keys

    returns all signing keys

    Definition Classes
    KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def findDynamicDomainParametersOrDefault(warnOnUsingDefault: Boolean)(implicit traceContext: TraceContext): Future[DynamicDomainParameters]
    Definition Classes
    DomainGovernanceSnapshotLoader → DomainGovernanceSnapshotClient
  17. def findUnvettedPackagesOrDependencies(participantId: ParticipantId, packages: Set[PackageId]): EitherT[Future, PackageId, Set[PackageId]]

    Returns the set of packages that are not vetted by the given participant

    Returns the set of packages that are not vetted by the given participant

    participantId

    the participant for which we want to check the package vettings

    packages

    the set of packages that should be vetted

    returns

    Right the set of unvetted packages (which is empty if all packages are vetted) Left if a package is missing locally such that we can not verify the vetting state of the package dependencies

    Definition Classes
    VettedPackagesSnapshotLoader → VettedPackagesSnapshotClient
  18. def findUnvettedPackagesOrDependenciesUsingLoader(participantId: ParticipantId, packages: Set[PackageId], loader: (ParticipantId, PackageId) => EitherT[Future, PackageId, Set[PackageId]]): EitherT[Future, PackageId, Set[PackageId]]
    Attributes
    protected
    Definition Classes
    VettedPackagesSnapshotLoader
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hasParticipantCertificate(participantId: ParticipantId)(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    CertificateSnapshotClient
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def hostedOn(partyId: LfPartyId, participantId: ParticipantId): Future[Option[ParticipantAttributes]]
    Definition Classes
    PartyTopologySnapshotBaseClient
  23. def isHostedByAtLeastOneParticipantF(party: LfPartyId, check: (ParticipantAttributes) => Boolean): Future[Boolean]
    Definition Classes
    PartyTopologySnapshotBaseClient
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def isMediatorActive(mediatorId: MediatorId): Future[Boolean]
    Definition Classes
    MediatorDomainStateClient
  26. def isParticipantActive(participantId: ParticipantId): Future[Boolean]

    Checks whether the provided participant exists and is active

    Checks whether the provided participant exists and is active

    Definition Classes
    ParticipantTopologySnapshotLoader → ParticipantTopologySnapshotClient
  27. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def participantState(participantId: ParticipantId): Future[ParticipantAttributes]
    Definition Classes
    ParticipantTopologySnapshotLoader
  34. def referenceTime: CantonTimestamp

    Internally used reference time (representing when the last change happened that affected this snapshot)

    Internally used reference time (representing when the last change happened that affected this snapshot)

    Definition Classes
    BaseTopologySnapshotClient
  35. def signingKey(owner: KeyOwner): Future[Option[SigningPublicKey]]

    returns newest signing public key

    returns newest signing public key

    Definition Classes
    KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
  36. def signingKeys(owner: KeyOwner): Future[Seq[SigningPublicKey]]

    returns all signing keys

    returns all signing keys

    Definition Classes
    KeyTopologySnapshotClientLoader → KeyTopologySnapshotClient
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. 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 NamedLogging

Inherited from DomainGovernanceSnapshotLoader

Inherited from VettedPackagesSnapshotLoader

Inherited from KeyTopologySnapshotClientLoader

Inherited from ParticipantTopologySnapshotLoader

Inherited from PartyTopologySnapshotLoader

Inherited from PartyTopologySnapshotBaseClient

Inherited from TopologySnapshot

Inherited from DomainGovernanceSnapshotClient

Inherited from MediatorDomainStateClient

Inherited from VettedPackagesSnapshotClient

Inherited from CertificateSnapshotClient

Inherited from KeyTopologySnapshotClient

Inherited from ParticipantTopologySnapshotClient

Inherited from BaseTopologySnapshotClient

Inherited from PartyTopologySnapshotClient

Inherited from AnyRef

Inherited from Any

Ungrouped