Packages

class MemberAuthenticationServiceImpl extends MemberAuthenticationService with TopologyTransactionProcessingSubscriber

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MemberAuthenticationServiceImpl
  2. TopologyTransactionProcessingSubscriber
  3. MemberAuthenticationService
  4. FlagCloseable
  5. PerformUnlessClosing
  6. HasSynchronizeWithReaders
  7. HasSynchronizeWithClosing
  8. OnShutdownRunner
  9. HasRunOnClosing
  10. HasUnlessClosing
  11. AutoCloseable
  12. NamedLogging
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MemberAuthenticationServiceImpl(synchronizerId: PhysicalSynchronizerId, cryptoApi: SynchronizerCryptoClient, store: MemberAuthenticationStore, clock: Clock, nonceExpirationInterval: Duration, maxTokenExpirationInterval: Duration, useExponentialRandomTokenExpiration: Boolean, invalidateMemberCallback: (Traced[Member]) => Unit, isTopologyInitialized: FutureUnlessShutdown[Unit], timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

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. def addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def close(): Unit

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Definition Classes
    FlagCloseableOnShutdownRunner → AutoCloseable
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  12. def executionOrder: Int

    The order in which the subscriber should be executed among all the subscriptions.

    The order in which the subscriber should be executed among all the subscriptions. Lower values are executed first.

    Definition Classes
    TopologyTransactionProcessingSubscriber
  13. def generateNonce(member: Member)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, AuthenticationError, (Nonce, NonEmpty[Seq[Fingerprint]])]

    synchronizer generates nonce that he expects the participant to use to concatenate with the synchronizer's id and sign to proceed with the authentication (step 2).

    synchronizer generates nonce that he expects the participant to use to concatenate with the synchronizer's id and sign to proceed with the authentication (step 2). We expect to find a key with usage 'SequencerAuthentication' to sign these messages.

    Definition Classes
    MemberAuthenticationService
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. def invalidateAndExpire[T <: Member](isActiveCheck: (T) => FutureUnlessShutdown[Boolean])(memberId: T)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
    Attributes
    protected
    Definition Classes
    MemberAuthenticationService
  17. def invalidateMemberWithToken(token: AuthenticationToken)(implicit traceContext: TraceContext): FutureUnlessShutdown[Either[LogoutTokenDoesNotExist.type, Unit]]
    Definition Classes
    MemberAuthenticationService
  18. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunnerHasUnlessClosing
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def isMediatorActive(mediator: MediatorId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
    Attributes
    protected
    Definition Classes
    MemberAuthenticationService
  21. def isMemberActive(check: (TopologySnapshot) => FutureUnlessShutdown[Boolean])(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
    Attributes
    protected
    Definition Classes
    MemberAuthenticationService
  22. def isParticipantActive(participant: ParticipantId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
    Attributes
    protected
    Definition Classes
    MemberAuthenticationService
  23. def isSequencerActive(sequencer: SequencerId)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
    Attributes
    protected
    Definition Classes
    MemberAuthenticationService
  24. def keepTrackOfReaderCallStack: Boolean

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  25. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. val loggerFactory: NamedLoggerFactory
  27. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  28. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    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
    @IntrinsicCandidate() @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  33. def observed(sequencerTimestamp: SequencedTime, effectiveTimestamp: EffectiveTime, sc: SequencerCounter, transactions: Seq[GenericSignedTopologyTransaction])(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    synchronizer topology client subscriber used to remove member tokens if they get disabled

    synchronizer topology client subscriber used to remove member tokens if they get disabled

    Definition Classes
    MemberAuthenticationServiceImplTopologyTransactionProcessingSubscriber
  34. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  35. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  36. final def onFirstClose(): Unit

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Definition Classes
    PerformUnlessClosingOnShutdownRunner
  37. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  38. def removeReader(handle: ReaderHandle): Unit

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  39. def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]

    Schedules the given task to be run upon closing.

    Schedules the given task to be run upon closing.

    returns

    An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the LifeCycleManager's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle was used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.

    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  40. def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the LifeCycleManager's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

    Definition Classes
    HasRunOnClosing
  41. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

  42. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  43. def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise it is the result of running f.

    Definition Classes
    HasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  44. def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns.

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

    synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
    Definition Classes
    PerformUnlessClosing
  45. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  46. def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has finished or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run.

    Definition Classes
    HasSynchronizeWithClosing
    Annotations
    @SuppressWarnings()
    See also

    HasRunOnClosing.isClosing

  47. def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise the result of running f.

    Definition Classes
    PerformUnlessClosingHasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  48. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  49. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  50. val timeouts: ProcessingTimeout
  51. def toString(): String
    Definition Classes
    AnyRef → Any
  52. final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]

    Runs the computation fa unless isClosing returns true.

    Runs the computation fa unless isClosing returns true.

    This method does not delay the closing while fa is running, unlike the methods in HasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.

    returns

    The result of fa or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true

    Definition Classes
    HasUnlessClosing
    Annotations
    @inline()
  53. def updateHead(sequencedTimestamp: SequencedTime, effectiveTimestamp: EffectiveTime, approximateTimestamp: ApproximateTime, potentialTopologyChange: Boolean)(implicit traceContext: TraceContext): Unit

    Move the highest known (effective / approximate) timestamp ahead in the future.

    Move the highest known (effective / approximate) timestamp ahead in the future.

    May only be called if:

    1. All committed topology transactions with effective time up to effectiveTimestamp have been persisted in the topology store.
    2. All committed topology transactions with sequenced time up to sequencedTimestamp have been persisted in the topology store.
    3. If this method is called with potentialTopologyChange == true, then for every subsequent committed topology transaction either updateHead(potentialTopologyChange == true, ...) or observed must be called again; such calls must occur with ascending effective timestamps.
    4. sequencedTimestamp <= effectiveTimestamp
    5. approximateTimestamp <= effectiveTimestamp
    6. A sequenced event with timestamp at least approximateTimestamp has been received from the sequencer.
    Definition Classes
    TopologyTransactionProcessingSubscriber
  54. def validateSignature(member: Member, signature: Signature, providedNonce: Nonce)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, AuthenticationError, AuthenticationTokenWithExpiry]

    synchronizer checks that the signature given by the member matches and returns a token if it does (step 4)

    synchronizer checks that the signature given by the member matches and returns a token if it does (step 4)

    Definition Classes
    MemberAuthenticationService
  55. def validateToken(intendedSynchronizerId: PhysicalSynchronizerId, member: Member, token: AuthenticationToken): Either[AuthenticationError, StoredAuthenticationToken]

    synchronizer checks if the token given by the participant is the one previously assigned to it for authentication.

    synchronizer checks if the token given by the participant is the one previously assigned to it for authentication. The participant also provides the synchronizer id for which they think they are connecting to. If this id does not match this synchronizer's id, it means the participant was previously connected to a different synchronizer on the same address and now should be informed that this address now hosts a different synchronizer.

    Definition Classes
    MemberAuthenticationService
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped