trait PublicServerConfig extends ServerConfig

The public server configuration ServerConfig used by the domain.

TODO(i4056): Client authentication over TLS is currently unsupported, because there is a token based protocol to authenticate clients. This may change in the future.

Linear Supertypes
ServerConfig, Serializable, Product, Equals, AnyRef, Any
Known Subclasses
CommunityPublicServerConfig, EnterprisePublicServerConfig
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PublicServerConfig
  2. ServerConfig
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val address: String

    The address of the interface to be listening on

    The address of the interface to be listening on

    Definition Classes
    ServerConfig
  2. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  3. abstract def instantiateServerInterceptors(tracingConfig: TracingConfig, apiLoggingConfig: ApiLoggingConfig, metricsPrefix: MetricName, metrics: MetricsFactory, loggerFactory: NamedLoggerFactory, grpcMetrics: GrpcServerMetrics): CantonServerInterceptors

    Use the configuration to instantiate the interceptors for this server

    Use the configuration to instantiate the interceptors for this server

    Definition Classes
    ServerConfig
  4. abstract val internalPort: Option[Port]

    Port to be listening on (must be greater than 0).

    Port to be listening on (must be greater than 0). If the port is None, a default port will be assigned on startup.

    NOTE: If you rename this field, adapt the corresponding product hint for config reading. In the configuration the field is still called port for usability reasons.

    Attributes
    protected
    Definition Classes
    ServerConfig
  5. abstract def keepAliveServer: Option[KeepAliveServerConfig]

    server keep alive settings

    server keep alive settings

    Definition Classes
    ServerConfig
  6. abstract def nonceExpirationTime: NonNegativeFiniteDuration

    Expiration time for a nonce that is generated for an authentication challenge.

    Expiration time for a nonce that is generated for an authentication challenge. as an authentication request is expected to be followed up with almost immediately to generate an authentication token the nonce expiry should be short. the nonce is automatically invalided on use.

  7. abstract def overrideMaxRequestSize: Option[NonNegativeInt]

    overrides the default maximum request size in bytes on the sequencer node

  8. abstract def productArity: Int
    Definition Classes
    Product
  9. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  10. abstract def tls: Option[TlsBaseServerConfig]
  11. abstract def tokenExpirationTime: NonNegativeFiniteDuration

    Expiration time for authentication tokens.

    Expiration time for authentication tokens. Tokens are used to authenticate participants. Choose a shorter time for better security and a longer time for better performance.

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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. lazy val clientConfig: ClientConfig
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def connection: String
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def maxInboundMessageSize: NonNegativeInt

    This setting has no effect.

    This setting has no effect. Therfore hardcoding it to 0.

    Definition Classes
    PublicServerConfig → ServerConfig
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. def port: Port

    Returns the configured or the default port that must be assigned after config loading and before config usage.

    Returns the configured or the default port that must be assigned after config loading and before config usage.

    We split between port and internalPort to offer a clean API to users of the config in the form of port, which must always return a configured or default port, and the internal representation that may be None before being assigned a default port.

    Definition Classes
    ServerConfig
  18. def productElementName(n: Int): String
    Definition Classes
    Product
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. def productIterator: Iterator[Any]
    Definition Classes
    Product
  21. def productPrefix: String
    Definition Classes
    Product
  22. def serverCertChainFile: Option[ExistingFile]

    server cert chain file if TLS is defined

    server cert chain file if TLS is defined

    Used for domain internal GRPC sequencer connections

    Definition Classes
    PublicServerConfig → ServerConfig
  23. def sslContext: Option[SslContext]

    If defined, dictates to use TLS when connecting to this node through the given address and port.

    If defined, dictates to use TLS when connecting to this node through the given address and port. Server authentication is always enabled. Subclasses may decide whether to support client authentication.

    Definition Classes
    PublicServerConfig → ServerConfig
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toSequencerConnectionConfig: Grpc
    Definition Classes
    ServerConfig
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. 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 ServerConfig

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped